WPProfiler\Core\Hook Class Reference

Inheritance diagram for WPProfiler\Core\Hook:

Public Member Functions
	__construct ($hook_name, Function_ $collector)
	add_filter ($tag, $function_to_add, $priority, $accepted_args)
	remove_filter ($tag, $function_to_remove, $priority)
	has_filter ($tag= '', $function_to_check=false)
	has_filters ()
	remove_all_filters ($priority=false)
	do_action ($args)
	apply_filters ($value, $args)
	do_all_hook (&$args)
	current_priority ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	current ()
	next ()
	key ()
	valid ()
	rewind ()

Public Attributes
	$callbacks = array()

Constructor & Destructor Documentation

WPProfiler\Core\Hook::__construct	(		$hook_name,
		Function_	$collector
	)

Hook constructor.

Parameters

\WP_Hook	$hook
string	$hook_name
\WPProfiler\Core\Profiler	$profiler
\WPProfiler\Core\Collectors\Function_	$collector

Member Function Documentation

WPProfiler\Core\Hook::add_filter	(		$tag,
			$function_to_add,
			$priority,
			$accepted_args
	)

Hooks a function or method to a specific filter action.

Parameters

string	$tag	The name of the filter to hook the $function_to_add callback to.
callable	$function_to_add	The callback to be run when the filter is applied.
int	$priority	The order in which the functions associated with a particular action are executed. Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action.
int	$accepted_args	The number of arguments the function accepts.

WPProfiler\Core\Hook::apply_filters	(		$value,
			$args
	)

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

Parameters

mixed	$value	The value to filter.
array	$args	Additional parameters to pass to the callback functions. This array is expected to include $value at index 0.

Returns

mixed The filtered value after all hooked functions are applied to it.

WPProfiler\Core\Hook::current

(

)

Returns the current element.

array Of callbacks at current priority.

WPProfiler\Core\Hook::current_priority

(

)

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

Returns

int|false If the hook is running, return the current priority level. If it isn't running, return false.

WPProfiler\Core\Hook::do_action

(

$args

)

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

Parameters

array

$args

Parameters to pass to the callback functions.

WPProfiler\Core\Hook::do_all_hook

(

&

$args

)

Processes the functions hooked into the 'all' hook.

Parameters

array

$args

Arguments to pass to the hook callbacks. Passed by reference.

WPProfiler\Core\Hook::has_filter	(		$tag = '',
			$function_to_check = false
	)

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

Parameters

string	$tag	Optional. The name of the filter hook. Default empty.
callable | bool	$function_to_check	Optional. The callback to check for. Default false.

Returns

bool|int The priority of that hook is returned, or false if the function is not attached.

WPProfiler\Core\Hook::has_filters

(

)

Checks if any callbacks have been registered for this hook.

Returns

bool True if callbacks have been registered for the current hook, otherwise false.

WPProfiler\Core\Hook::key

(

)

Returns the key of the current element.

mixed Returns current priority on success, or NULL on failure

WPProfiler\Core\Hook::next

(

)

Moves forward to the next element.

array Of callbacks at next priority.

WPProfiler\Core\Hook::offsetExists

(

$offset

)

Determines whether an offset value exists.

mixed $offset An offset to check for. bool True if the offset exists, false otherwise.

WPProfiler\Core\Hook::offsetGet

(

$offset

)

Retrieves a value at a specified offset.

mixed $offset The offset to retrieve. mixed If set, the value at the specified offset, null otherwise.

WPProfiler\Core\Hook::offsetSet	(		$offset,
			$value
	)

Sets a value at a specified offset.

mixed $offset The offset to assign the value to. mixed $value The value to set.

WPProfiler\Core\Hook::offsetUnset

(

$offset

)

Unsets a specified offset.

mixed $offset The offset to unset.

WPProfiler\Core\Hook::remove_all_filters

(

$priority = false

)

Removes all callbacks from the current filter.

Parameters

int | bool

$priority

Optional. The priority number to remove. Default false.

WPProfiler\Core\Hook::remove_filter	(		$tag,
			$function_to_remove,
			$priority
	)

Unhooks a function or method from a specific filter action.

Parameters

string	$tag	The filter hook to which the function to be removed is hooked.
callable	$function_to_remove	The callback to be removed from running when the filter is applied.
int	$priority	The exact priority used when adding the original filter callback.

Returns

bool Whether the callback existed before it was removed.

WPProfiler\Core\Hook::rewind

(

)

Rewinds the Iterator to the first element.

https://secure.php.net/manual/en/iterator.rewind.php

WPProfiler\Core\Hook::valid

(

)

Checks if current position is valid.

boolean

Member Data Documentation

WPProfiler\Core\Hook::$callbacks = array()

---

The documentation for this class was generated from the following file:

• 0_wordpress_profiler.php