From 35e349ee167f7496ddf33afb7c540f3f5a8cb2c7 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 24 Dec 2022 14:33:14 +0000 Subject: [PATCH] Code Modernization: Rename parameters that use reserved keywords in `wp-includes/user.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 `$global` parameter to `$is_global` in: * `update_user_option()` * `delete_user_option()` 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]. Props jrf, aristath, poena, justinahinon, SergeyBiryukov. See #56788. Built from https://develop.svn.wordpress.org/trunk@55015 git-svn-id: http://core.svn.wordpress.org/trunk@54548 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/user.php | 17 +++++++++-------- wp-includes/version.php | 2 +- 2 files changed, 10 insertions(+), 9 deletions(-) diff --git a/wp-includes/user.php b/wp-includes/user.php index a4ff0bb340..ca4b3d03fd 100644 --- a/wp-includes/user.php +++ b/wp-includes/user.php @@ -691,7 +691,7 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { * Updates user option with global blog capability. * * User options are just like user metadata except that they have support for - * global blog options. If the 'global' parameter is false, which it is by default + * global blog options. If the 'is_global' parameter is false, which it is by default, * it will prepend the WordPress table prefix to the option name. * * Deletes the user option if $newvalue is empty. @@ -703,15 +703,15 @@ function get_user_option( $option, $user = 0, $deprecated = '' ) { * @param int $user_id User ID. * @param string $option_name User option name. * @param mixed $newvalue User option value. - * @param bool $global Optional. Whether option name is global or blog specific. + * @param bool $is_global Optional. Whether option name is global or blog specific. * Default false (blog specific). * @return int|bool User meta ID if the option didn't exist, true on successful update, * false on failure. */ -function update_user_option( $user_id, $option_name, $newvalue, $global = false ) { +function update_user_option( $user_id, $option_name, $newvalue, $is_global = false ) { global $wpdb; - if ( ! $global ) { + if ( ! $is_global ) { $option_name = $wpdb->get_blog_prefix() . $option_name; } @@ -722,7 +722,7 @@ function update_user_option( $user_id, $option_name, $newvalue, $global = false * Deletes user option with global blog capability. * * User options are just like user metadata except that they have support for - * global blog options. If the 'global' parameter is false, which it is by default + * global blog options. If the 'is_global' parameter is false, which it is by default, * it will prepend the WordPress table prefix to the option name. * * @since 3.0.0 @@ -731,16 +731,17 @@ function update_user_option( $user_id, $option_name, $newvalue, $global = false * * @param int $user_id User ID * @param string $option_name User option name. - * @param bool $global Optional. Whether option name is global or blog specific. + * @param bool $is_global Optional. Whether option name is global or blog specific. * Default false (blog specific). * @return bool True on success, false on failure. */ -function delete_user_option( $user_id, $option_name, $global = false ) { +function delete_user_option( $user_id, $option_name, $is_global = false ) { global $wpdb; - if ( ! $global ) { + if ( ! $is_global ) { $option_name = $wpdb->get_blog_prefix() . $option_name; } + return delete_user_meta( $user_id, $option_name ); } diff --git a/wp-includes/version.php b/wp-includes/version.php index e49c632c31..c68d2891f0 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.2-alpha-55014'; +$wp_version = '6.2-alpha-55015'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.