Plugin System Documentation

Everything you need to install, 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, and uninstall 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.

Features

• No core edits: plugins stay in content/plugins.
• Update-safe: plugin system remains intact after core updates.
• 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

1. Upload project and verify content/plugins/_system/prepend.php exists.
2. Set auto_prepend_file to absolute path, for example /home/USER/public_html/content/plugins/_system/prepend.php.
3. Use one supported method: .user.ini, hosting panel PHP INI editor, or .htaccess php_value if host allows.
4. Wait for INI refresh or restart PHP from panel.
5. Verify /plugins-check.php shows auto_prepend_loaded: true.
6. Open /admincp/plugins.

VPS / Dedicated

1. Deploy project to web root, then confirm plugin system path.
2. Configure auto_prepend_file in Apache/PHP-FPM/Nginx+PHP-FPM config.
3. Reload web server and PHP services.
4. Verify /plugins-check.php.
5. Open /admincp/plugins.

How to Use

• Place each plugin folder under content/plugins/{plugin-slug}.
• Go to AdminCP -> Plugins.
• 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.

How to Uninstall

1. Open /admincp/plugins.
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/plugins/{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: 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.