Changeset 53014

Timestamp:

03/29/2022 01:19:23 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-wp-filesystem-base.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 $echo parameter to $verbose in WP_Filesystem_Base::find_base_dir() and ::get_base_dir(), and updates the documentation accordingly. This matches the class property of the same name.

Follow-up to [52946], [52996], [52997], [52998], [53003].

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

File:

• trunk/src/wp-admin/includes/class-wp-filesystem-base.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-filesystem-base.php

@@ -130 +130 @@
          * @see WP_Filesystem_Base::wp_lang_dir()
          *
-         * @param string $base The folder to start searching from.
-         * @param bool   $echo True to display debug information.
-         *                     Default false.
+         * @param string $base    Optional. The folder to start searching from. Default '.'.
+         * @param bool   $verbose Optional. True to display debug information. Default false.
          * @return string The location of the remote path.
          */
-        public function find_base_dir( $base = '.', $echo = false ) {
+        public function find_base_dir( $base = '.', $verbose = false ) {
                 _deprecated_function( __FUNCTION__, '2.7.0', 'WP_Filesystem_Base::abspath() or WP_Filesystem_Base::wp_*_dir()' );
-                $this->verbose = $echo;
+                $this->verbose = $verbose;
                 return $this->abspath();
         }
@@ -152 +151 @@
          * @see WP_Filesystem_Base::wp_lang_dir()
          *
-         * @param string $base The folder to start searching from.
-         * @param bool   $echo True to display debug information.
+         * @param string $base    Optional. The folder to start searching from. Default '.'.
+         * @param bool   $verbose Optional. True to display debug information. Default false.
          * @return string The location of the remote path.
          */
-        public function get_base_dir( $base = '.', $echo = false ) {
+        public function get_base_dir( $base = '.', $verbose = false ) {
                 _deprecated_function( __FUNCTION__, '2.7.0', 'WP_Filesystem_Base::abspath() or WP_Filesystem_Base::wp_*_dir()' );
-                $this->verbose = $echo;
+                $this->verbose = $verbose;
                 return $this->abspath();
         }