Changeset 54952

Timestamp:

12/09/2022 12:22:14 AM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/pluggable.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 $die parameter to $stop in check_ajax_referer().
• Renames the $default parameter to $fallback_url in wp_validate_redirect().
• Renames the $default parameter to $default_value in get_avatar().

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].

Props jrf, aristath, poena, justinahinon, SergeyBiryukov.
See #56788.

Location:

trunk

Files:

• src/wp-includes/pluggable.php (modified) (13 diffs)
• tests/phpunit/tests/pluggable/signatures.php (modified) (3 diffs)

trunk/src/wp-includes/pluggable.php

@@ -1290 +1290 @@
      *                                `$_REQUEST` values will be evaluated for '_ajax_nonce', and '_wpnonce'
      *                                (in that order). Default false.
-     * @param bool         $die       Optional. Whether to die early when the nonce cannot be verified.
+     * @param bool         $stop      Optional. Whether to stop early when the nonce cannot be verified.
      *                                Default true.
      * @return int|false 1 if the nonce is valid and generated between 0-12 hours ago,
@@ -1296 +1296 @@
      *                   False if the nonce is invalid.
      */
-    function check_ajax_referer( $action = -1, $query_arg = false, $die = true ) {
+    function check_ajax_referer( $action = -1, $query_arg = false, $stop = true ) {
         if ( -1 == $action ) {
             _doing_it_wrong( __FUNCTION__, __( 'You should specify an action to be verified by using the first parameter.' ), '4.7.0' );
@@ -1324 +1324 @@
         do_action( 'check_ajax_referer', $action, $result );
 
-        if ( $die && false === $result ) {
+        if ( $stop && false === $result ) {
             if ( wp_doing_ajax() ) {
                 wp_die( -1, 403 );
@@ -1520 +1520 @@
          * @param int    $status       The HTTP response status code to use.
          */
-        $location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status ) );
+        $fallback_url = apply_filters( 'wp_safe_redirect_fallback', admin_url(), $status );
+
+        $location = wp_validate_redirect( $location, $fallback_url );
 
         return wp_redirect( $location, $status, $x_redirect_by );
@@ -1534 +1536 @@
      * list.
      *
-     * If the host is not allowed, then the redirect is to $default supplied.
+     * If the host is not allowed, then the redirect is to $fallback_url supplied.
      *
      * @since 2.8.1
      *
-     * @param string $location The redirect to validate.
-     * @param string $default  The value to return if $location is not allowed.
-     * @return string redirect-sanitized URL.
-     */
-    function wp_validate_redirect( $location, $default = '' ) {
+     * @param string $location     The redirect to validate.
+     * @param string $fallback_url The value to return if $location is not allowed.
+     * @return string Redirect-sanitized URL.
+     */
+    function wp_validate_redirect( $location, $fallback_url = '' ) {
         $location = wp_sanitize_redirect( trim( $location, " \t\n\r\0\x08\x0B" ) );
         // Browsers will assume 'http' is your protocol, and will obey a redirect to a URL starting with '//'.
@@ -1558 +1560 @@
         // Give up if malformed URL.
         if ( false === $lp ) {
-            return $default;
+            return $fallback_url;
         }
 
         // Allow only 'http' and 'https' schemes. No 'data:', etc.
         if ( isset( $lp['scheme'] ) && ! ( 'http' === $lp['scheme'] || 'https' === $lp['scheme'] ) ) {
-            return $default;
+            return $fallback_url;
         }
 
@@ -1578 +1580 @@
         // This catches URLs like https:host.com for which parse_url() does not set the host field.
         if ( ! isset( $lp['host'] ) && ( isset( $lp['scheme'] ) || isset( $lp['user'] ) || isset( $lp['pass'] ) || isset( $lp['port'] ) ) ) {
-            return $default;
+            return $fallback_url;
         }
 
@@ -1584 +1586 @@
         foreach ( array( 'user', 'pass', 'host' ) as $component ) {
             if ( isset( $lp[ $component ] ) && strpbrk( $lp[ $component ], ':/?#@' ) ) {
-                return $default;
+                return $fallback_url;
             }
         }
@@ -1601 +1603 @@
 
         if ( isset( $lp['host'] ) && ( ! in_array( $lp['host'], $allowed_hosts, true ) && strtolower( $wpp['host'] ) !== $lp['host'] ) ) {
-            $location = $default;
+            $location = $fallback_url;
         }
 
@@ -2747 +2749 @@
      * @since 4.2.0 Optional `$args` parameter added.
      *
-     * @param mixed  $id_or_email The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
-     *                            user email, WP_User object, WP_Post object, or WP_Comment object.
-     * @param int    $size        Optional. Height and width of the avatar image file in pixels. Default 96.
-     * @param string $default     Optional. URL for the default image or a default type. Accepts '404'
-     *                            (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
-     *                            (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
-     *                            'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
-     *                            or 'gravatar_default' (the Gravatar logo). Default is the value of the
-     *                            'avatar_default' option, with a fallback of 'mystery'.
-     * @param string $alt         Optional. Alternative text to use in img tag. Default empty.
+     * @param mixed  $id_or_email   The Gravatar to retrieve. Accepts a user_id, gravatar md5 hash,
+     *                              user email, WP_User object, WP_Post object, or WP_Comment object.
+     * @param int    $size          Optional. Height and width of the avatar image file in pixels. Default 96.
+     * @param string $default_value Optional. URL for the default image or a default type. Accepts '404'
+     *                              (return a 404 instead of a default image), 'retro' (8bit), 'monsterid'
+     *                              (monster), 'wavatar' (cartoon face), 'indenticon' (the "quilt"),
+     *                              'mystery', 'mm', or 'mysteryman' (The Oyster Man), 'blank' (transparent GIF),
+     *                              or 'gravatar_default' (the Gravatar logo). Default is the value of the
+     *                              'avatar_default' option, with a fallback of 'mystery'.
+     * @param string $alt           Optional. Alternative text to use in img tag. Default empty.
      * @param array  $args {
      *     Optional. Extra arguments to retrieve the avatar.
@@ -2777 +2779 @@
      * @return string|false `<img>` tag for the user's avatar. False on failure.
      */
-    function get_avatar( $id_or_email, $size = 96, $default = '', $alt = '', $args = null ) {
+    function get_avatar( $id_or_email, $size = 96, $default_value = '', $alt = '', $args = null ) {
         $defaults = array(
             // get_avatar_data() args.
@@ -2804 +2806 @@
 
         $args['size']    = (int) $size;
-        $args['default'] = $default;
+        $args['default'] = $default_value;
         $args['alt']     = $alt;
 
@@ -2908 +2910 @@
          * @since 4.2.0 The `$args` parameter was added.
          *
-         * @param string $avatar      HTML for the user's avatar.
-         * @param mixed  $id_or_email The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
-         *                            user email, WP_User object, WP_Post object, or WP_Comment object.
-         * @param int    $size        Square avatar width and height in pixels to retrieve.
-         * @param string $default     URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
-         *                            'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
-         * @param string $alt         Alternative text to use in the avatar image tag.
-         * @param array  $args        Arguments passed to get_avatar_data(), after processing.
+         * @param string $avatar        HTML for the user's avatar.
+         * @param mixed  $id_or_email   The avatar to retrieve. Accepts a user_id, Gravatar MD5 hash,
+         *                              user email, WP_User object, WP_Post object, or WP_Comment object.
+         * @param int    $size          Square avatar width and height in pixels to retrieve.
+         * @param string $default_value URL for the default image or a default type. Accepts '404', 'retro', 'monsterid',
+         *                              'wavatar', 'indenticon', 'mystery', 'mm', 'mysteryman', 'blank', or 'gravatar_default'.
+         * @param string $alt           Alternative text to use in the avatar image tag.
+         * @param array  $args          Arguments passed to get_avatar_data(), after processing.
          */
         return apply_filters( 'get_avatar', $avatar, $id_or_email, $args['size'], $args['default'], $args['alt'], $args );

trunk/tests/phpunit/tests/pluggable/signatures.php

@@ -174 +174 @@
                 'action'    => -1,
                 'query_arg' => false,
-                'die'       => true,
+                'stop'      => true,
             ),
             'wp_redirect'                     => array(
@@ -190 +190 @@
             'wp_validate_redirect'            => array(
                 'location',
-                'default' => '',
+                'fallback_url' => '',
             ),
             'wp_notify_postauthor'            => array(
@@ -232 +232 @@
             'get_avatar'                      => array(
                 'id_or_email',
-                'size'    => 96,
-                'default' => '',
-                'alt'     => '',
-                'args'    => null,
+                'size'          => 96,
+                'default_value' => '',
+                'alt'           => '',
+                'args'          => null,
             ),
             'wp_text_diff'                    => array(