Skip to content

Custom repositories

Robert Isoski edited this page Nov 7, 2019 · 1 revision

What are "Custom repositories" (WonderCMS 3.x.x and above)

The "Custom repository" field in the Settings->Themes or Settings->Plugins enables you to install a theme (or plugin) that is not listed in the official WonderCMS repository.

It also enables you to serve your theme or plugin to other users.

You can provide your theme/plugin users with a link to your theme or plugin repository. GitHub or GitLab are supported.

How to create a custom repository

As a plugin or theme maintainer, a few files must be provided for the theme/plugin to be correctly installed for WonderCMS users.

  • Custom theme repository requirements

    Your repository must include the following files:

    • theme.php contains your theme and all WonderCMS theme elements
    • style.css must be inside a /css folder
    • version 3.0.0
    • summary short summary
    • preview.jpg compressed screenshot of your theme
  • Custom plugin repository requirements

    Your plugin repository must include the following files:

    • plugin-name.php contains your plugin code
      • IMPORTANT: plugin-name.php must be the same as the plugin folder name
    • version 3.0.0
    • summary short summary
    • preview.jpg compressed screenshot of your plugin

How to send a theme/plugin update to users

  • Commit new changes to your theme/plugin files on Github.
  • Change the version file (eg: from 3.0.0 to 3.0.1) after you've confirmed everything is working.
  • Users will receive an "Update" notification in their settings panel.
    • This will happen either after 24 hours OR when the user manually clicks the "Check for updates" button.
  • When they click "Update", all the existing theme/plugin files will be overwritten with the latest ones from GitHub repository.

Related information

Clone this wiki locally
You can’t perform that action at this time.