Plugins and themes

Plugins add features to the Host Manager and the hosting panel. Themes change how a face looks. Both are folders you can add with a ZIP, and the same licence system that sets your account limit decides which premium ones may run.

What ships with the panel

Free ones work on every licence. A premium one needs its addon on the licence; the Unlimited & All Plugins package carries all of them. See The licence key.

Manage Plugins

Plugins → Manage Plugins (root) lists every plugin folder found in plugins/, sorted by category (Security, Web & apps, E-mail, Backups & transfers, Domains & DNS, SSL, Billing & resellers, Other). A card shows the name, version, author, a description, a Free or Premium badge and, for a premium plugin, whether your licence covers it: Premium - on your licence or Premium - needs the "csf-firewall" addon on your licence.

• Switch on runs the plugin's installer (it may create tables) and records it as active. A premium plugin without its addon refuses with that note.
• Switch off keeps the data and hides the plugin everywhere.
• Settings opens the plugin's own settings page when it has one.
• Uninstall removes the plugin's records and, for a plugin that did not ship with the panel, its folder.

Until a plugin is on, its menu entries do not exist and it runs no code.

Add a plugin from a ZIP

On the same page use Upload a plugin. The ZIP must hold plugin.php at its top or in one folder. The panel reads the plugin's code from getCode(), creates plugins/<code>/, unpacks the files and tells you Switch it on to use it. A bought premium plugin comes as such a ZIP from license.faruk.bd; after uploading, press Check now on the Licence page if the addon was bought just now.

You can also write your own. A plugin is a folder with a plugin.php that holds a class <Code>Plugin extends AbstractPlugin. It states its code, name, version, tier, required addon and category, and may add:

• managerMenu() and hostingMenu() - entries for the menus (label, page, icon, group, short text, whether root only, which feature list switch hides it);
• boot() - register hooks and API functions (ap_api_manager, ap_api_panelapi) and a job for the cron (ap_cron);
• getConfigFields() - a settings page drawn for you (text, number, password, yes/no, select, colour);
• install() and uninstall() - create and drop its tables (name them ap_pl_<plugin>_...);
• pages in pages/manager/ and pages/hosting/, reached at plugin/<code>/<page>.

A plugin never calls another plugin's functions directly, because that plugin may be off. Use hooks.

Themes

A theme lives in themes/<face>/<code>/ with a theme.json, templates/layout.php, templates/login.php and assets/. The theme.json names the theme, its face (manager, hosting), its tier (free or premium with an addon), and its options (colour, text, yes/no, choice) that the Theme Manager shows as a form.

Shipped themes: Slate (Host Manager), Orbit (hosting panel), Midnight (hosting panel, premium) and mail (Webmail).

Theme Manager

Themes → Theme Manager has two tabs: Host Manager themes and Hosting panel themes. Each theme is a card with its name, version, author, free or premium and what the licence says. Per theme:

• Set as default - the default for the face. Root's own Host Manager theme changes at once. A premium theme without its addon shows Licence needed.
• Options - edit the theme's options; Save Options keeps them, Reset to Defaults clears them.
• Delete - removes a theme that is not the default.
• Upload a Theme - a ZIP with theme.json at its top or in one folder. The panel checks that the face matches.

Themes → Universal Theme Manager sets one hosting panel theme on many accounts at once: pick the theme, tick the accounts (or choose all), and apply.

Change Style

A customer picks a hosting panel theme under Preferences → Change Style. The host can force one per package (field Hosting Panel Theme). A premium theme without its addon falls back to Orbit for everyone.

Branding and the rest of the look

Hosting Panel → Branding and Customization set the brand name and logos; Modify Panel News sets the text on the Home pages; Web Template Editor edits the notices the panel sends. The Slate theme options (accent, sidebar and top bar colours, brand text, show load, grid or list on Home) sit in the Theme Manager.