WPDev.one
Core Class

WP_Hook

class WP_Hook // Constructor: function Object() { [native code] }

Core class used to implement action and filter hook functionality.

Methods 20 methods

Method / Return Description
add_filter()
void

Adds a callback function to a filter hook.

Parameters: $hook_name: mixed, $callback: mixed, $priority: mixed, $accepted_args: mixed
resort_active_iterations()
void

Handles resetting callback priority keys mid-iteration.

Parameters: $new_priority: mixed, $priority_existed: mixed
remove_filter()
bool

Removes a callback function from a filter hook.

Parameters: $hook_name: mixed, $callback: mixed, $priority: mixed
has_filter()
(bool

Checks if a specific callback has been registered for this hook.

Parameters: $hook_name: mixed, $callback: mixed
has_filters()
bool

Checks if any callbacks have been registered for this hook.

remove_all_filters()
void

Removes all callbacks from the current filter.

Parameters: $priority: mixed
apply_filters()
mixed

Calls the callback functions that have been added to a filter hook.

Parameters: $value: mixed, $args: mixed
do_action()
void

Calls the callback functions that have been added to an action hook.

Parameters: $args: mixed
do_all_hook()
void

Processes the functions hooked into the 'all' hook.

Parameters: $args: mixed
current_priority()
(int

Return the current priority level of the currently running iteration of the hook.

build_preinitialized_hooks()
WP_Hook[]

Normalizes filters set up before WordPress has initialized to WP_Hook objects.

Parameters: $filters: mixed
offsetExists()
bool

Determines whether an offset value exists.

Parameters: $offset: mixed
offsetGet()
mixed

Retrieves a value at a specified offset.

Parameters: $offset: mixed
offsetSet()
void

Sets a value at a specified offset.

Parameters: $offset: mixed, $value: mixed
offsetUnset()
void

Unsets a specified offset.

Parameters: $offset: mixed
current()
array

Returns the current element.

next()
array

Moves forward to the next element.

key()
mixed

Returns the key of the current element.

valid()
bool

Checks if current position is valid.

rewind()
void

Rewinds the Iterator to the first element.

Properties

Property / Type Description
$callbacks
mixed
public
No description available.
$priorities
mixed
public
No description available.
$iterations
mixed
public
No description available.
$current_priority
mixed
public
No description available.
$nesting_level
mixed
public
No description available.
$doing_action
mixed
public
No description available.

Class Information

Since Version
4.7.0
Source File
wp-includes/class-wp-hook.php
Advertisement