mirror of
https://github.com/inretio/WordPress-Plugin-Boilerplate
synced 2024-12-23 04:13:53 +02:00
918ee9e5f9
Following the guide of the PHPDoc Block Formatting > @access (for functions: only use if private) Fix #191
131 lines
4.7 KiB
PHP
131 lines
4.7 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Register all actions and filters
|
|
*
|
|
* @package Plugin_Name
|
|
* @subpackage Plugin_Name/includes
|
|
* @author Your Name <email@example.com>
|
|
* @license GPL-2.0+
|
|
* @link http://example.com
|
|
* @copyright 2014 Your Name or Company Name
|
|
* @since 1.0.0
|
|
*/
|
|
|
|
/**
|
|
* Register all actions and filters.
|
|
*
|
|
* Maintain a list of all hooks that are registered throughout
|
|
* the plugin, and register them with the WordPress API. Call the
|
|
* run function to execute the list of actions and filters.
|
|
*
|
|
* @package Plugin_Name
|
|
* @subpackage Plugin_Name/includes
|
|
* @author Your Name <email@example.com>
|
|
*/
|
|
class Plugin_Name_Loader {
|
|
|
|
/**
|
|
* The array of actions registered with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var array $actions The actions registered with WordPress to fire when the plugin loads.
|
|
*/
|
|
protected $actions;
|
|
|
|
/**
|
|
* The array of filters registered with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @access protected
|
|
* @var array $filters The filters registered with WordPress to fire when the plugin loads.
|
|
*/
|
|
protected $filters;
|
|
|
|
/**
|
|
* Initialize the collections used to maintain the actions and filters.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function __construct() {
|
|
|
|
$this->actions = array();
|
|
$this->filters = array();
|
|
|
|
}
|
|
|
|
/**
|
|
* Add a new action to the collection to be registered with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @var string $hook The name of the WordPress action that is being registered.
|
|
* @var object $component A reference to the instance of the object on which the action is defined.
|
|
* @var string $callback The name of the function definition on the $component.
|
|
* @var int Optional $priority The priority at which the function should be fired.
|
|
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
|
|
*/
|
|
public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
|
|
$this->actions = $this->add( $this->actions, $hook, $component, $callback, $priority, $accepted_args );
|
|
}
|
|
|
|
/**
|
|
* Add a new filter to the collection to be registered with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
* @var string $hook The name of the WordPress filter that is being registered.
|
|
* @var object $component A reference to the instance of the object on which the filter is defined.
|
|
* @var string $callback The name of the function definition on the $component.
|
|
* @var int Optional $priority The priority at which the function should be fired.
|
|
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
|
|
*/
|
|
public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
|
|
$this->filters = $this->add( $this->filters, $hook, $component, $callback, $priority, $accepted_args );
|
|
}
|
|
|
|
/**
|
|
* A utility function that is used to register the actions and hooks into a single
|
|
* collection.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
* @var array $hooks The collection of hooks that is being registered (that is, actions or filters).
|
|
* @var string $hook The name of the WordPress filter that is being registered.
|
|
* @var object $component A reference to the instance of the object on which the filter is defined.
|
|
* @var string $callback The name of the function definition on the $component.
|
|
* @var int Optional $priority The priority at which the function should be fired.
|
|
* @var int Optional $accepted_args The number of arguments that should be passed to the $callback.
|
|
* @return type The collection of actions and filters registered with WordPress.
|
|
*/
|
|
private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
|
|
|
|
$hooks[] = array(
|
|
'hook' => $hook,
|
|
'component' => $component,
|
|
'callback' => $callback,
|
|
'priority' => $priority,
|
|
'accepted_args' => $accepted_args
|
|
);
|
|
|
|
return $hooks;
|
|
|
|
}
|
|
|
|
/**
|
|
* Register the filters and actions with WordPress.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
public function run() {
|
|
|
|
foreach ( $this->filters as $hook ) {
|
|
add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
|
|
}
|
|
|
|
foreach ( $this->actions as $hook ) {
|
|
add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
|
|
}
|
|
|
|
}
|
|
|
|
}
|