Changeset 55119

Timestamp:

01/23/2023 04:33:57 PM (21 months ago)

Author:

SergeyBiryukov

Message:

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.

Location:

trunk

Files:

• src/wp-includes/shortcodes.php (modified) (1 diff)
• tests/phpunit/tests/shortcode.php (modified) (4 diffs)

trunk/src/wp-includes/shortcodes.php

@@ -341 +341 @@
      * @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.

trunk/tests/phpunit/tests/shortcode.php

@@ -827 +827 @@
         // Pass arguments.
         $arr = array(
-            'return' => 'p11',
+            'output' => 'p11',
             'key'    => $str,
             'atts'   => array(
@@ -865 +865 @@
     }
 
-    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,
@@ -897 +897 @@
         // Pass arguments.
         $arr = array(
-            'return' => 'foobar',
+            'output' => 'foobar',
             'key'    => $str,
             'atts'   => array(
@@ -927 +927 @@
     }
 
-    public function filter_do_shortcode_tag_replace( $return ) {
-        return str_replace( 'oo', 'ee', $return );
-    }
-
-    public function filter_do_shortcode_tag_generate( $return ) {
+    public function filter_do_shortcode_tag_replace( $output ) {
+        return str_replace( 'oo', 'ee', $output );
+    }
+
+    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,