premmerce/wordpress-sdk

Wordpress SDK for premmerce plugins

Premmerce Wordpress SDK

Premmerce wordpress SDK used in plugins generated by premmerce-dev-tools plugin., _(*1)

FileManager

File manager is responsible for plugin resources(assets, views, paths) management. Class should be initialized with plugin main file full path as parameter., _(*2)

params: * string $mainFile - main plugin file path * string $templatePath - theme directory to override plugin templates located in frontend directory, _(*3)

    $fileManager = new FileManager($mainFile);

    //V2
    $fileManager = new FileManager($mainFile, $templatePath);

includeTemplate

includeTemplate(string $template, array $variables = []), _(*4)

params:
* string $template - relative path to file * array $variables - array of variables used in template file, _(*5)

Includes template located in plugin views folder with passed variables in scope, _(*6)

Each template located in views/forntend directory can be overridden in theme in /plugin_name/ directory, _(*7)

$fileManager->includeTemplate('admin/index.php',['title' => 'My title']);

renderTemplate

renderTemplate(string $template, array $variables = []), _(*8)

params: * string $template - relative path to file * array $variables - array of variables used in template file, _(*9)

Returns rendered template located in plugin views folder with passed variables in scope, _(*10)

Each template located in views/forntend directory can be overridden in theme in /plugin_name/ directory, _(*11)

$rendered = $fileManager->includeTemplate('admin/index.php',['title' => 'My title']);

locateAsset

locateAsset(string $file), _(*12)

Returns asset url located in plugin assets folder, _(*13)

params: * string $template - relative path to file, _(*14)

$url = $fileManager->locateAsset('admin/css/style.css');

wp_enqueue_style('my_style', $fileManager->locateAsset('front/css/style.css'));

AdminNotifier

Class is responsible for displaying messages in admin area. AdminNotifier should be instantiated, before admin_notices action, _(*15)

push

Show message on admin_notices action, _(*16)

push(string $message, string $type = self::SUCCESS, bool $isDismissible = false), _(*17)

params: * string $message - message text * string $type - message type, one of predefined constants: AdminNotifier::SUCCESS|AdminNotifier::ERROR|AdminNotifier::WARNING|AdminNotifier::INFO * bool $isDismissible - can user dismiss message, _(*18)

$notifier->push('Message text', AdminNotifier::SUCCESS, true)

flash

Save flash message to show during next request, _(*19)

flash(string $message, string $type = self::SUCCESS, bool $isDismissible = false), _(*20)

params: * string $message - message text * string $type - message type, one of predefined constants: AdminNotifier::SUCCESS|AdminNotifier::ERROR|AdminNotifier::WARNING|AdminNotifier::INFO * bool $isDismissible - can user dismiss message, _(*21)

$notifier->flash('Message text', AdminNotifier::SUCCESS, true)

PluginInterface

The Interface that should be implemented by plugin main file, _(*22)

Changelog

V2

• Added second parameter to FileManager __construct()
• Added flash method to AdminNotifier