Plugins: Convert `apply_filters()` into a proper variadic function.

This makes its signature more correct by implementing the spread operator, and adjusts the internal logic correspondingly without affecting performance.

Props jrf, SergeyBiryukov, davidbaumwald, mauriac, johnbillion

Fixes #53218

Built from https://develop.svn.wordpress.org/trunk@52952


git-svn-id: http://core.svn.wordpress.org/trunk@52541 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2022-03-18 18:23:04 +00:00
parent 92a1067f1d
commit 6571e44299
2 changed files with 9 additions and 7 deletions

View File

@ -151,6 +151,8 @@ function add_filter( $hook_name, $callback, $priority = 10, $accepted_args = 1 )
* $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 ); * $value = apply_filters( 'example_filter', 'filter me', $arg1, $arg2 );
* *
* @since 0.71 * @since 0.71
* @since 6.0.0 Formalized the existing and already documented `...$args` parameter
* by adding it to the function signature.
* *
* @global WP_Hook[] $wp_filter Stores all of the filters and actions. * @global WP_Hook[] $wp_filter Stores all of the filters and actions.
* @global string[] $wp_current_filter Stores the list of current filters with the current one last. * @global string[] $wp_current_filter Stores the list of current filters with the current one last.
@ -160,15 +162,15 @@ function add_filter( $hook_name, $callback, $priority = 10, $accepted_args = 1 )
* @param mixed ...$args Additional parameters to pass to the callback functions. * @param mixed ...$args Additional parameters to pass to the callback functions.
* @return mixed The filtered value after all hooked functions are applied to it. * @return mixed The filtered value after all hooked functions are applied to it.
*/ */
function apply_filters( $hook_name, $value ) { function apply_filters( $hook_name, $value, ...$args ) {
global $wp_filter, $wp_current_filter; global $wp_filter, $wp_current_filter;
$args = func_get_args();
// Do 'all' actions first. // Do 'all' actions first.
if ( isset( $wp_filter['all'] ) ) { if ( isset( $wp_filter['all'] ) ) {
$wp_current_filter[] = $hook_name; $wp_current_filter[] = $hook_name;
_wp_call_all_hook( $args );
$all_args = func_get_args(); // phpcs:ignore PHPCompatibility.FunctionUse.ArgumentFunctionsReportCurrentValue.NeedsInspection
_wp_call_all_hook( $all_args );
} }
if ( ! isset( $wp_filter[ $hook_name ] ) ) { if ( ! isset( $wp_filter[ $hook_name ] ) ) {
@ -183,8 +185,8 @@ function apply_filters( $hook_name, $value ) {
$wp_current_filter[] = $hook_name; $wp_current_filter[] = $hook_name;
} }
// Don't pass the tag name to WP_Hook. // Pass the value to WP_Hook.
array_shift( $args ); array_unshift( $args, $value );
$filtered = $wp_filter[ $hook_name ]->apply_filters( $value, $args ); $filtered = $wp_filter[ $hook_name ]->apply_filters( $value, $args );

View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.0-alpha-52951'; $wp_version = '6.0-alpha-52952';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.