README

This library is designed to be integrated into free WordPress plugins, providing essential features such as opt-in forms, settings page management, and promotional content for premium plugins. It is distributed via Packagist and complies with WordPress.org guidelines.

Features

Opt-in Form: Allows users to opt-in to email lists for updates, tips, and exclusive offers.
Settings Page Management: Adds a settings link to the plugin action links and redirects users to the settings page upon activation.
Promotional Content: Displays ads for related premium plugins on the settings page, encouraging users to upgrade.
Compliance: Ensures compliance with WordPress.org guidelines, including explicit consent for data collection and clear privacy policies.

Installation

This library is available via Packagist. To install it in your WordPress plugin, use Composer:

composer require alanef/free_plugin_lib

When you build for plugin release use composer update --no-dev flag ensures that only production-ready code is installed, excluding development assets like tests and CI configurations.

Usage

Initialization

To use the library, initialize it in your plugin's main file:

use Fullworks_Free_Plugin_Lib\Main;

$plugin_file = __FILE__;
$settings_page = 'options-general.php?page=your-plugin-settings';
$plugin_shortname = 'your_plugin_shortname';
$page = 'your-plugin-page';
$plugin_name = 'your-plugin-name';

$plugin_lib = new Main($plugin_file, $settings_page, $plugin_shortname, $page, $plugin_name);

Opt-in Form

The library automatically handles the opt-in form display and submission. Ensure that the settings_page parameter points to the correct settings page URL.

Settings Page

The library adds a settings link to the plugin action links and redirects users to the settings page upon activation. Customize the settings page content as needed.

Promotional Content

The library displays ads for premium plugins on the settings page. Ensure that the Advert class is correctly initialized and that the premium plugin check logic is in place.

Hooks and Filters

Actions

admin_menu: Adds the settings page to the WordPress admin menu.
init: Loads the text domain for localization.
admin_enqueue_scripts: Enqueues necessary scripts and styles for the settings page.
ffpl_ad_display: Displays promotional content for premium plugins.

Filters

plugin_action_links: Adds a settings link to the plugin action links.

Localization

The library supports localization. Translation files should be placed in the languages directory and named according to the text domain (free-plugin-lib).

Example:

languages/free-plugin-lib-en_US.mo
languages/free-plugin-lib-en_US.po

Compliance

The library is designed to comply with WordPress.org guidelines, including:

Explicit Consent: No data is sent to external servers without explicit user consent.
No Automatic Downloads: No software is downloaded or installed without user consent.
Clear Privacy Policy: The opt-in form includes a link to the privacy policy.

Contributing

Contributions are welcome! If you'd like to contribute to the development of this library, follow these steps:

Fork the repository.

Clone your fork locally:

git clone https://github.com/your-username/free_plugin_lib.git

Install development dependencies:
```
composer install
```
Make your changes and run tests:
```
vendor/bin/phpunit
```
Submit a pull request with your changes.

License

This library is licensed under the GPL-2.0-or-later license. See the LICENSE file for more details.

Support

For support, please open an issue on the GitHub repository or contact the maintainer directly.

Changelog

For a detailed list of changes, see the CHANGELOG.

alanef / free_plugin_lib

Maintainers

Details