wpdesk/wp-plugin-flow-common

WP Desk Plugin Flow Common

Maintainers

Package info

gitlab.wpdesk.dev/wpdesk/library/wp-plugin-flow-common

Homepage

pkg:composer/wpdesk/wp-plugin-flow-common

Statistics

Installs: 23 528

Dependents: 4

Suggesters: 0

1.3.0 2025-05-21 14:06 UTC

README

pipeline status Integration: coverage report Unit: coverage report

wp-plugin-flow-common

A small library for bootstrapping WordPress plugins built on WP Desk flow. It handles requirements checks, translations initialization, and startup strategy selection.

Requirements

  • PHP >= 7.4
  • WordPress

Installation

composer require wpdesk/wp-plugin-flow-common

Usage

Prepare the basic plugin variables and include one of the bootstrap files:

$plugin_version = '1.0.0';
$plugin_name = 'My Plugin';
$plugin_class_name = MyPlugin::class;
$plugin_text_domain = 'my-plugin';
$plugin_dir = __DIR__;
$plugin_file = __FILE__;
$requirements = [
	'php' => '7.4',
	'wp'  => '6.0',
];
$product_id = 'my-plugin';

require __DIR__ . '/vendor/wpdesk/wp-plugin-flow-common/src/plugin-init-php52.php';

For a free plugin use:

require __DIR__ . '/vendor/wpdesk/wp-plugin-flow-common/src/plugin-init-php52-free.php';

If you need a custom initialization strategy, define $plugin_init_factory before including the bootstrap file.

Tests

composer phpunit-unit-fast
composer phpunit-integration-fast