From 306333f9ee073ccaa4508b55bf3d7f15218a05c9 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Tue, 29 Mar 2022 13:19:23 +0000 Subject: [PATCH] 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. git-svn-id: https://develop.svn.wordpress.org/trunk@53014 602fd350-edb4-49c9-b593-d223f7449a82 --- .../includes/class-wp-filesystem-base.php | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/src/wp-admin/includes/class-wp-filesystem-base.php b/src/wp-admin/includes/class-wp-filesystem-base.php index de5ce054cf..221f8b59f5 100644 --- a/src/wp-admin/includes/class-wp-filesystem-base.php +++ b/src/wp-admin/includes/class-wp-filesystem-base.php @@ -129,14 +129,13 @@ class WP_Filesystem_Base { * @see WP_Filesystem_Base::wp_themes_dir() * @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(); } @@ -151,13 +150,13 @@ class WP_Filesystem_Base { * @see WP_Filesystem_Base::wp_themes_dir() * @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(); }