Make WordPress Core

Changeset 55015


Ignore:
Timestamp:
12/24/2022 02:31:08 PM (16 months ago)
Author:
SergeyBiryukov
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/user.php

    r54953 r55015  
    692692 *
    693693 * User options are just like user metadata except that they have support for
    694  * global blog options. If the 'global' parameter is false, which it is by default
     694 * global blog options. If the 'is_global' parameter is false, which it is by default,
    695695 * it will prepend the WordPress table prefix to the option name.
    696696 *
     
    704704 * @param string $option_name User option name.
    705705 * @param mixed  $newvalue    User option value.
    706  * @param bool   $global      Optional. Whether option name is global or blog specific.
     706 * @param bool   $is_global   Optional. Whether option name is global or blog specific.
    707707 *                            Default false (blog specific).
    708708 * @return int|bool User meta ID if the option didn't exist, true on successful update,
    709709 *                  false on failure.
    710710 */
    711 function update_user_option( $user_id, $option_name, $newvalue, $global = false ) {
     711function update_user_option( $user_id, $option_name, $newvalue, $is_global = false ) {
    712712    global $wpdb;
    713713
    714     if ( ! $global ) {
     714    if ( ! $is_global ) {
    715715        $option_name = $wpdb->get_blog_prefix() . $option_name;
    716716    }
     
    723723 *
    724724 * User options are just like user metadata except that they have support for
    725  * global blog options. If the 'global' parameter is false, which it is by default
     725 * global blog options. If the 'is_global' parameter is false, which it is by default,
    726726 * it will prepend the WordPress table prefix to the option name.
    727727 *
     
    732732 * @param int    $user_id     User ID
    733733 * @param string $option_name User option name.
    734  * @param bool   $global      Optional. Whether option name is global or blog specific.
     734 * @param bool   $is_global   Optional. Whether option name is global or blog specific.
    735735 *                            Default false (blog specific).
    736736 * @return bool True on success, false on failure.
    737737 */
    738 function delete_user_option( $user_id, $option_name, $global = false ) {
     738function delete_user_option( $user_id, $option_name, $is_global = false ) {
    739739    global $wpdb;
    740740
    741     if ( ! $global ) {
     741    if ( ! $is_global ) {
    742742        $option_name = $wpdb->get_blog_prefix() . $option_name;
    743743    }
     744
    744745    return delete_user_meta( $user_id, $option_name );
    745746}
Note: See TracChangeset for help on using the changeset viewer.