From 698c003a645f30a233e8929e71f405025b8db04c Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Mon, 23 Jan 2023 16:33:57 +0000 Subject: [PATCH] Code Modernization: Rename parameters that use reserved keywords in `phpunit/tests/shortcode.php`. While using reserved PHP keywords as parameter name labels is allowed, in the context of function calls using named parameters in PHP 8.0+, this will easily lead to confusion. To avoid that, it is recommended not to use reserved keywords as function parameter names. This commit: * Renames the `$return` parameter to `$output` in: * `Tests_Shortcode::filter_pre_do_shortcode_tag_attr()` * `Tests_Shortcode::filter_do_shortcode_tag_replace()` * `Tests_Shortcode::filter_do_shortcode_tag_generate()` * `Tests_Shortcode::filter_do_shortcode_tag_attr()` * Amends the `$return` parameter of the `pre_do_shortcode_tag` filter for consistency. Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039], [53116], [53117], [53137], [53174], [53184], [53185], [53192], [53193], [53198], [53203], [53207], [53215], [53216], [53220], [53230], [53232], [53236], [53239], [53240], [53242], [53243], [53245], [53246], [53257], [53269], [53270], [53271], [53272], [53273], [53274], [53275], [53276], [53277], [53281], [53283], [53284], [53285], [53287], [53364], [53365], [54927], [54929], [54930], [54931], [54932], [54933], [54938], [54943], [54944], [54945], [54946], [54947], [54948], [54950], [54951], [54952], [54956], [54959], [54960], [54961], [54962], [54964], [54965], [54969], [54970], [54971], [54972], [54996], [55000], [55011], [55013], [55014], [55015], [55016], [55017], [55020], [55021], [55023], [55027], [55028], [55034], [55036], [55037], [55038], [55039], [55049], [55050], [55060], [55062], [55064], [55065], [55076], [55077], [55078], [55081], [55090], [55100], [55104], [55112], [55115], [55116], [55117]. Props jrf, aristath, poena, justinahinon, SergeyBiryukov. See #56788. git-svn-id: https://develop.svn.wordpress.org/trunk@55119 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/shortcodes.php | 2 +- tests/phpunit/tests/shortcode.php | 18 +++++++++--------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/wp-includes/shortcodes.php b/src/wp-includes/shortcodes.php index 938e796fa7..e0812225a5 100644 --- a/src/wp-includes/shortcodes.php +++ b/src/wp-includes/shortcodes.php @@ -340,7 +340,7 @@ function do_shortcode_tag( $m ) { * * @since 4.7.0 * - * @param false|string $return Short-circuit return value. Either false or the value to replace the shortcode with. + * @param false|string $output Short-circuit return value. Either false or the value to replace the shortcode with. * @param string $tag Shortcode name. * @param array|string $attr Shortcode attributes array or empty string. * @param array $m Regular expression match array. diff --git a/tests/phpunit/tests/shortcode.php b/tests/phpunit/tests/shortcode.php index 7ee36d7cbc..33549b73e8 100644 --- a/tests/phpunit/tests/shortcode.php +++ b/tests/phpunit/tests/shortcode.php @@ -826,7 +826,7 @@ EOF; // Pass arguments. $arr = array( - 'return' => 'p11', + 'output' => 'p11', 'key' => $str, 'atts' => array( 'a' => 'b', @@ -864,9 +864,9 @@ EOF; return 'p11'; } - public function filter_pre_do_shortcode_tag_attr( $return, $key, $atts, $m ) { + public function filter_pre_do_shortcode_tag_attr( $output, $key, $atts, $m ) { $arr = array( - 'return' => $return, + 'output' => $output, 'key' => $key, 'atts' => $atts, 'm' => $m, @@ -896,7 +896,7 @@ EOF; // Pass arguments. $arr = array( - 'return' => 'foobar', + 'output' => 'foobar', 'key' => $str, 'atts' => array( 'a' => 'b', @@ -926,17 +926,17 @@ EOF; return 'foo'; } - public function filter_do_shortcode_tag_replace( $return ) { - return str_replace( 'oo', 'ee', $return ); + public function filter_do_shortcode_tag_replace( $output ) { + return str_replace( 'oo', 'ee', $output ); } - public function filter_do_shortcode_tag_generate( $return ) { + public function filter_do_shortcode_tag_generate( $output ) { return 'foobar'; } - public function filter_do_shortcode_tag_attr( $return, $key, $atts, $m ) { + public function filter_do_shortcode_tag_attr( $output, $key, $atts, $m ) { $arr = array( - 'return' => $return, + 'output' => $output, 'key' => $key, 'atts' => $atts, 'm' => $m,