Plugins

Plugins

Plugins in Osclass extend the functionality of your classifieds website by adding new features, integrating third-party services, and improving user experience. Administrators can install, activate, deactivate, and delete plugins directly from the Osclass backoffice.

Key information about plugins:

• The number of installed plugins does not directly slow down your Osclass installation. You can run a site with 200 active plugins without noticing any performance issues.
• Plugin assets are loaded only for installed and active plugins.
• Plugins enhance Osclass functionality via hooks and filters.
• Plugins can be created to add new pages, widgets, settings, or even override existing functionalities.

Installing Plugins

Plugins can be installed in two ways:

1. Installing from Market

• Navigate to Market > Plugins in the Osclass backoffice.
• Find the plugin you want to install.
• Click the Install button to download and activate it automatically.

2. Uploading a Plugin Manually

• Download the plugin in ZIP format.
• Go to Plugins > Add Plugin in the backoffice.
• Click Choose File and select the ZIP file.
• Click Upload to install the plugin.

Alternatively, you can manually upload the extracted plugin folder to /oc-content/plugins/ using FTP or a file manager.

Managing Plugins

Once installed, plugins can be managed from Plugins > Manage Plugins.

The following actions are available:

• Activate: Enables the plugin, making its functionality available.
• Deactivate: Disables the plugin without removing it.
• Delete: Completely removes the plugin and its files from the server.

Plugin Configuration

Some plugins provide additional configuration options. These settings can usually be accessed by clicking the Configure button next to the plugin name in the backoffice.

Plugin Folder Permissions

To install and update plugins, the /oc-content/plugins/ folder must be writable. If you encounter errors when installing a plugin, ensure the directory has the correct permissions:

chmod a+w oc-content/plugins/

Plugin Folder Structure

A standard plugin usually contains the following files and folders:

• index.php - Plugin initialization file, including installation and uninstallation routines.
• functions.php - Contains the core functions and logic for the plugin.
• email.php - Manages email-related functions (optional).
• admin/configure.php - The primary configuration page for the plugin. The admin folder may include multiple configuration files.
• user/ - Contains files used by logged-in users, usually related to user-specific features.
• form/ - Contains frontend files, typically displayed to all users.
• css/ - Holds CSS files for styling.
• js/ - Contains JavaScript files.
• img/ - Stores images used by the plugin.
• model/ - Includes the database model and the struct.sql file for database schema modifications.
• languages/ - Holds translation files for multiple languages.
• fonts/ - Often includes Font Awesome or other font-related assets.

Troubleshooting Plugin Issues

If a plugin causes issues, follow these steps:

• Deactivate the plugin: Go to Plugins > Manage Plugins and disable the problematic plugin.
• Reinstall the plugin: Uninstall and then reinstall the plugin. This will reset all plugin-related data (!), but will ensure that the database structure is correctly applied.
• Check for updates: Make sure you are using the latest version of the plugin.
• Verify file permissions: Ensure that the plugin files are readable and writable.
• Check compatibility: Some plugins may not be compatible with your current Osclass version.
• Enable debugging: Activate error logs and database logs to check for possible issues.

Conclusion

Plugins are an essential way to extend Osclass functionality. They enable administrators to enhance their classifieds website with new features, integrations, and improvements. By properly managing and troubleshooting plugins, administrators can ensure smooth and efficient operation of their Osclass installation.