WP_Hook

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Properties · 6

$callbacksarraypublic

Hook callbacks keyed by priority.

$prioritieslist<int>protected

Priorities list.

$iterationsarray<int,private

The priority keys of actively running iterations of a hook.

$current_priorityarray<int,private

The current priority of actively running iterations of a hook.

$nesting_levelintprivate

Number of levels this hook can be recursively called.

$doing_actionboolprivate

Flag for if we're currently doing an action, rather than a filter.

Methods · 20

• add_filter()Adds a callback function to a filter hook.
• resort_active_iterations()Handles resetting callback priority keys mid-iteration.
• remove_filter()Removes a callback function from a filter hook.
• has_filter()Checks if a specific callback has been registered for this hook.
• has_filters()Checks if any callbacks have been registered for this hook.
• remove_all_filters()Removes all callbacks from the current filter.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• do_action()Calls the callback functions that have been added to an action hook.
• do_all_hook()Processes the functions hooked into the 'all' hook.
• current_priority()Return the current priority level of the currently running iteration of the hook.
• build_preinitialized_hooks()Normalizes filters set up before WordPress has initialized to WP_Hook objects.
• offsetExists()Determines whether an offset value exists.
• offsetGet()Retrieves a value at a specified offset.
• offsetSet()Sets a value at a specified offset.
• offsetUnset()Unsets a specified offset.
• current()Returns the current element.
• next()Moves forward to the next element.
• key()Returns the key of the current element.
• valid()Checks if current position is valid.
• rewind()Rewinds the Iterator to the first element.

Source code

View on Trac ↗View on GitHub ↗

26#[AllowDynamicProperties]27final class WP_Hook implements Iterator, ArrayAccess {28 29	/**30	 * Hook callbacks keyed by priority.31	 *32	 * @since 4.7.033	 * @var array34	 * @phpstan-var array<int, array<string, Hook_Callback>>35	 */36	public $callbacks = array();37 38	/**39	 * Priorities list.40	 *41	 * @since 6.4.042	 * @var list<int>43	 */44	protected $priorities = array();45 46	/**47	 * The priority keys of actively running iterations of a hook.48	 *49	 * @since 4.7.050	 * @var array<int, list<int>>51	 */52	private $iterations = array();53 54	/**55	 * The current priority of actively running iterations of a hook.56	 *57	 * @since 4.7.058	 * @var array<int, int>59	 */60	private $current_priority = array();61 62	/**63	 * Number of levels this hook can be recursively called.64	 *65	 * @since 4.7.066	 * @var int67	 */68	private $nesting_level = 0;69 70	/**71	 * Flag for if we're currently doing an action, rather than a filter.72	 *73	 * @since 4.7.074	 * @var bool75	 */76	private $doing_action = false;77 78	/**79	 * Adds a callback function to a filter hook.80	 *81	 * @since 4.7.082	 *83	 * @param string   $hook_name     The name of the filter to add the callback to.84	 * @param callable $callback      The callback to be run when the filter is applied.85	 * @param int      $priority      The order in which the functions associated with a particular filter86	 *                                are executed. Lower numbers correspond with earlier execution,87	 *                                and functions with the same priority are executed in the order88	 *                                in which they were added to the filter.89	 * @param int      $accepted_args The number of arguments the function accepts.90	 */91	public function add_filter( $hook_name, $callback, $priority, $accepted_args ) {92		if ( null === $priority ) {93			$priority = 0;94		}95 96		$idx = _wp_filter_build_unique_id( $hook_name, $callback, $priority );97		if ( null === $idx ) {98			return;99		}100 101		$priority_existed = isset( $this->callbacks[ $priority ] );102 103		$this->callbacks[ $priority ][ $idx ] = array(104			'function'      => $callback,105			'accepted_args' => (int) $accepted_args,

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/class-wp-hook.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.