class-wp-otp-loader.php 4.14 KB
Newer Older
noplanman's avatar
noplanman committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
<?php
/**
 * Register all actions and filters for the plugin
 *
 * @package    Wp_Otp
 * @subpackage Loader
 * @since      0.1.0
 */

namespace Wp_Otp;

/**
 * Register all actions and filters for the plugin.
 *
 * Maintain a list of all hooks that are registered throughout the plugin and register them with the WordPress API.
 *
 * @since 0.1.0
 */
class Wp_Otp_Loader {
	/**
	 * The actions registered with WordPress to fire when the plugin loads.
	 *
	 * @since  0.1.0
	 * @access private
	 * @var    array $actions
	 */
	private $actions;

	/**
	 * The filters registered with WordPress to fire when the plugin loads.
	 *
	 * @since  0.1.0
	 * @access private
	 * @var    array $filters
	 */
	private $filters;

	/**
	 * Initialize the collections used to maintain the actions and filters.
	 *
	 * @since 0.1.0
	 */
	public function __construct() {
		$this->actions = [];
		$this->filters = [];
	}

	/**
	 * Add a new action to the collection to be registered with WordPress.
	 *
	 * @since 0.1.0
	 *
	 * @param string $hook          The name of the WordPress action that is being registered.
	 * @param object $component     A reference to the instance of the object on which the action is defined.
	 * @param string $callback      The name of the function definition on the $component. Default is the $hook name.
	 * @param int    $priority      The priority at which the function should be fired. Default is 10.
	 * @param int    $accepted_args The number of arguments that should be passed to the $callback. Default is 1.
	 */
59
	public function add_action( $hook, $component, $callback = null, $priority = 10, $accepted_args = 1 ): void {
noplanman's avatar
noplanman committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73
		$this->actions = $this->add( $this->actions, $hook, $component, $callback ?: $hook, $priority, $accepted_args );
	}

	/**
	 * Add a new filter to the collection to be registered with WordPress.
	 *
	 * @since 0.1.0
	 *
	 * @param string $hook          The name of the WordPress filter that is being registered.
	 * @param object $component     A reference to the instance of the object on which the filter is defined.
	 * @param string $callback      The name of the function definition on the $component. Default is the $hook name.
	 * @param int    $priority      The priority at which the function should be fired. Default is 10.
	 * @param int    $accepted_args The number of arguments that should be passed to the $callback. Default is 1.
	 */
74
	public function add_filter( $hook, $component, $callback = null, $priority = 10, $accepted_args = 1 ): void {
noplanman's avatar
noplanman committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
		$this->filters = $this->add( $this->filters, $hook, $component, $callback ?: $hook, $priority, $accepted_args );
	}

	/**
	 * A utility function that is used to register the actions and hooks into a single
	 * collection.
	 *
	 * @since  0.1.0
	 * @access private
	 *
	 * @param array  $hooks         The collection of hooks that is being registered (that is, actions or filters).
	 * @param string $hook          The name of the WordPress filter that is being registered.
	 * @param object $component     A reference to the instance of the object on which the filter is defined.
	 * @param string $callback      The name of the function definition on the $component.
	 * @param int    $priority      The priority at which the function should be fired.
	 * @param int    $accepted_args The number of arguments that should be passed to the $callback.
	 *
	 * @return array The collection of actions and filters registered with WordPress.
	 */
94
	private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ): array {
noplanman's avatar
noplanman committed
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
		$hooks[] = [
			'hook'          => $hook,
			'component'     => $component,
			'callback'      => $callback,
			'priority'      => $priority,
			'accepted_args' => $accepted_args,
		];

		return $hooks;
	}

	/**
	 * Register the filters and actions with WordPress.
	 *
	 * @since 0.1.0
	 */
111
	public function run(): void {
noplanman's avatar
noplanman committed
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
		foreach ( $this->filters as $hook ) {
			add_filter(
				$hook['hook'],
				[ $hook['component'], $hook['callback'] ],
				$hook['priority'],
				$hook['accepted_args']
			);
		}

		foreach ( $this->actions as $hook ) {
			add_action(
				$hook['hook'],
				[ $hook['component'], $hook['callback'] ],
				$hook['priority'],
				$hook['accepted_args']
			);
		}
	}
}