Plugin System Documentation

Everything you need to install, activate license, auto-update, use, and uninstall plugins safely.

Introduction

The Helptor plugin system extends your platform without modifying core files. It uses a safe loader and a plugin registry so you can install, enable, disable, uninstall, and update plugins from one place in AdminCP.

This design keeps updates cleaner, reduces risk during upgrades, and gives you a predictable workflow for managing custom functionality.

Current Plugin System Version: v2.0

Features

• No core edits: plugins stay in content/helptor.
• Update-safe: plugin system remains intact after core updates.
• License-protected plugins: activation popup and validation support through your license server.
• Auto update support: check and apply compatible plugin/system updates from AdminCP.
• Admin lifecycle controls: Install, Enable, Disable, and Uninstall from one screen.
• Manifest-based discovery: each plugin is validated using plugin.json.
• Hook-based architecture: plugins can extend behavior without template rewrites.
• Fail-safe runtime: plugin errors are isolated to reduce full-site impact.

How to Install

Live Server Installation

Shared Hosting

For first-time installation:

1. Upload helptor-system.zip in your website root.
2. Extract helptor-system.zip.
3. Edit .user.ini and set the exact auto_prepend_file location.
4. Example path: /home/USERNAME/public_html/content/helptor/_system/prepend.php (absolute path).

If you are using a previous version and want to update:

1. Rename folder /content/plugins to /content/helptor.
2. Edit .user.ini and set the exact auto_prepend_file location.
3. Example path: /home/USERNAME/public_html/content/helptor/_system/prepend.php (absolute path).

VPS / Dedicated

For first-time installation:

1. Upload helptor-system.zip to your project/web root and extract it.
2. Confirm this file exists: /content/helptor/_system/prepend.php.
3. Set auto_prepend_file in server PHP config (Apache/PHP-FPM/Nginx+PHP-FPM) to that exact path.
4. Reload/restart PHP service and web server.
5. Verify /plugins-check.php then open /admincp/helptor.

If you are using a previous version and want to update:

1. Rename folder /content/plugins to /content/helptor.
2. Update auto_prepend_file path to /content/helptor/_system/prepend.php.
3. Reload/restart PHP service and web server.
4. Open /admincp/helptor and verify plugins are loading.

How to Use

• Place each plugin folder under content/helptor/{plugin-slug}.
• Go to AdminCP -> Helptor or open /admincp/helptor.
• Run Install, then Enable for the plugin.
• Open plugin settings from the same plugin card if admin.php is provided.
• Disable a plugin before upgrading its files to avoid version mismatch during requests.

Plugin System License Activation (System Only)

1. Open /admincp/helptor.
2. This section is for Plugin System license activation only (not for individual plugins).
3. Enter your Purchase Code / License Key (and username/email if requested).
4. Click Save License Key and wait for validation.
5. After successful activation, Plugin System features (including system update checks) will be available.

Plugin System Auto Update Features (System Only)

• Plugin System version is shown in the header (example: v2.0).
• Up to date label can be used to trigger an update check.
• When a new version is found, status changes to Update Available.
• Click update/confirm to download and apply the latest Plugin System package.
• If update fails, verify valid license, server write permission, and connectivity to license/update server.

How to Uninstall

1. Open /admincp/helptor.
2. Find the installed plugin card.
3. Click Disable first if it is active.
4. Click Uninstall to remove plugin registration and run its optional uninstall.php cleanup script.
5. If you want complete removal, delete the plugin folder from content/helptor/{plugin-slug} after uninstalling.

FAQs

Q: Plugin Manager page is blank. Why?

A: Usually the auto_prepend_file path is incorrect, or PHP configuration changes were not reloaded.

Q: Plugin is listed but not working. What should I check?

A: Confirm it is both Installed and Enabled, then verify plugin.json is valid and slug naming is correct.

Q: Will core updates remove my plugins?

A: No. Plugins are designed to live outside core files, so updates are safer.

Q: Is this activation for all plugins?

A: No. This documentation section is only for Plugin System activation and update.

Q: Why update/download may fail?

A: Common reasons are invalid license, license limit reached, server permission issues, or blocked outbound requests.

Q: Which setup is best on shared hosting?

A: Prefer .user.ini or your hosting panel PHP INI editor. Use .htaccess php_value only if your host allows it.

Q: Does uninstalling always remove plugin data from database tables?

A: Only if the plugin provides cleanup logic in uninstall.php. Check plugin-specific documentation before uninstalling if you need to keep data.