vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-06-28 14:20:15 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Tests: Update the terminology used for action or filter names in MockAction class.

Browse Source 
This replaces the "tag" wording with "hook name" where appropriate, to match the core function signatures.

Includes:
* Introducing a `::get_hook_names()` method instead of `::get_tags()`, keeping the latter as an alias.
* Adding a `hook_name` key to the `::$events` property, keeping `tag` for backward compatibility for now.
* Adding missing `@since` tags for class methods.

Follow-up to [24/tests], [62/tests], [70/tests], [50807], [53804].

See #55652.

git-svn-id: https://develop.svn.wordpress.org/trunk@53805 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2022-07-31 16:25:27 +00:00
parent 0ec5fb339b
commit ebd66f9aed
4 changed files with 153 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

165
tests/phpunit/includes/utils.php
View File

@@ -56,6 +56,8 @@ function strip_ws( $txt ) {
*
* $ma = new MockAction();
* add_action( 'foo', array( &$ma, 'action' ) );
*
* @since UT (3.7.0)
*/
class MockAction {
public $events;
@@ -63,140 +65,221 @@ class MockAction {
/**
* PHP5 constructor.
*
* @since UT (3.7.0)
*/
public function __construct( $debug = 0 ) {
$this->reset();
$this->debug = $debug;
}
/**
* @since UT (3.7.0)
*/
public function reset() {
$this->events = array();
}
/**
* @since UT (3.7.0)
*/
public function current_filter() {
global $wp_actions;
if ( is_callable( 'current_filter' ) ) {
return current_filter();
}
global $wp_actions;
return end( $wp_actions );
}
/**
* @since UT (3.7.0)
*/
public function action( $arg ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$args = func_get_args();
$this->events[] = array(
'action' => __FUNCTION__,
'tag' => $this->current_filter(),
'args' => $args,
'action' => __FUNCTION__,
'hook_name' => $current_filter,
'tag' => $current_filter, // Back compat.
'args' => func_get_args(),
);
return $arg;
}
/**
* @since UT (3.7.0)
*/
public function action2( $arg ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$args = func_get_args();
$this->events[] = array(
'action' => __FUNCTION__,
'tag' => $this->current_filter(),
'args' => $args,
'action' => __FUNCTION__,
'hook_name' => $current_filter,
'tag' => $current_filter, // Back compat.
'args' => func_get_args(),
);
return $arg;
}
/**
* @since UT (3.7.0)
*/
public function filter( $arg ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$args = func_get_args();
$this->events[] = array(
'filter' => __FUNCTION__,
'tag' => $this->current_filter(),
'args' => $args,
'filter' => __FUNCTION__,
'hook_name' => $current_filter,
'tag' => $current_filter, // Back compat.
'args' => func_get_args(),
);
return $arg;
}
/**
* @since UT (3.7.0)
*/
public function filter2( $arg ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$args = func_get_args();
$this->events[] = array(
'filter' => __FUNCTION__,
'tag' => $this->current_filter(),
'args' => $args,
'filter' => __FUNCTION__,
'hook_name' => $current_filter,
'tag' => $current_filter, // Back compat.
'args' => func_get_args(),
);
return $arg;
}
/**
* @since UT (3.7.0)
*/
public function filter_append( $arg ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$args = func_get_args();
$this->events[] = array(
'filter' => __FUNCTION__,
'tag' => $this->current_filter(),
'args' => $args,
'filter' => __FUNCTION__,
'hook_name' => $current_filter,
'tag' => $current_filter, // Back compat.
'args' => func_get_args(),
);
return $arg . '_append';
}
public function filterall( $tag, ...$args ) {
// This one doesn't return the result, so it's safe to use with the new 'all' filter.
/**
* Does not return the result, so it's safe to use with the 'all' filter.
*
* @since UT (3.7.0)
*/
public function filterall( $hook_name, ...$args ) {
$current_filter = $this->current_filter();
if ( $this->debug ) {
dmp( __FUNCTION__, $this->current_filter() );
dmp( __FUNCTION__, $current_filter );
}
$this->events[] = array(
'filter' => __FUNCTION__,
'tag' => $tag,
'args' => $args,
'filter' => __FUNCTION__,
'hook_name' => $hook_name,
'tag' => $hook_name, // Back compat.
'args' => $args,
);
}
// Return a list of all the actions, tags and args.
/**
* Returns a list of all the actions, hook names and args.
*
* @since UT (3.7.0)
*/
public function get_events() {
return $this->events;
}
// Return a count of the number of times the action was called since the last reset.
public function get_call_count( $tag = '' ) {
if ( $tag ) {
/**
* Returns a count of the number of times the action was called since the last reset.
*
* @since UT (3.7.0)
*/
public function get_call_count( $hook_name = '' ) {
if ( $hook_name ) {
$count = 0;
foreach ( $this->events as $e ) {
if ( $e['action'] === $tag ) {
if ( $e['action'] === $hook_name ) {
++$count;
}
}
return $count;
}
return count( $this->events );
}
// Return an array of the tags that triggered calls to this action.
public function get_tags() {
/**
* Returns an array of the hook names that triggered calls to this action.
*
* @since 6.1.0
*/
public function get_hook_names() {
$out = array();
foreach ( $this->events as $e ) {
$out[] = $e['tag'];
$out[] = $e['hook_name'];
}
return $out;
}
// Return an array of args passed in calls to this action.
/**
* Returns an array of the hook names that triggered calls to this action.
*
* @since UT (3.7.0)
* @since 6.1.0 Turned into an alias for ::get_hook_names().
*/
public function get_tags() {
return $this->get_hook_names();
}
/**
* Returns an array of args passed in calls to this action.
*
* @since UT (3.7.0)
*/
public function get_args() {
$out = array();
foreach ( $this->events as $e ) {
$out[] = $e['args'];
}
return $out;
}
}