Make WordPress Core

Changeset 54962


Ignore:
Timestamp:
12/13/2022 12:24:17 PM (18 months ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/query.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 $var and $default parameters to $query_var and $default_value in get_query_var().
  • Renames the $var parameter to $query_var in set_query_var().

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

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

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r54777 r54962  
    17801780     *
    17811781     * @param string $query_var     Query variable key.
    1782      * @param mixed  $default_value Optional. Value to return if the query variable is not set. Default empty string.
     1782     * @param mixed  $default_value Optional. Value to return if the query variable is not set.
     1783     *                              Default empty string.
    17831784     * @return mixed Contents of the query variable.
    17841785     */
  • trunk/src/wp-includes/query.php

    r53549 r54962  
    1616 *
    1717 * @since 1.5.0
    18  * @since 3.9.0 The `$default` argument was introduced.
    19  *
    20  * @global WP_Query $wp_query WordPress Query object.
    21  *
    22  * @param string $var       The variable key to retrieve.
    23  * @param mixed  $default   Optional. Value to return if the query variable is not set. Default empty.
     18 * @since 3.9.0 The `$default_value` argument was introduced.
     19 *
     20 * @global WP_Query $wp_query WordPress Query object.
     21 *
     22 * @param string $query_var     The variable key to retrieve.
     23 * @param mixed  $default_value Optional. Value to return if the query variable is not set.
     24 *                              Default empty string.
    2425 * @return mixed Contents of the query variable.
    2526 */
    26 function get_query_var( $var, $default = '' ) {
    27     global $wp_query;
    28     return $wp_query->get( $var, $default );
     27function get_query_var( $query_var, $default_value = '' ) {
     28    global $wp_query;
     29    return $wp_query->get( $query_var, $default_value );
    2930}
    3031
     
    6869 * @global WP_Query $wp_query WordPress Query object.
    6970 *
    70  * @param string $var  Query variable key.
    71  * @param mixed  $value Query variable value.
    72  */
    73 function set_query_var( $var, $value ) {
    74     global $wp_query;
    75     $wp_query->set( $var, $value );
     71 * @param string $query_var Query variable key.
     72 * @param mixed  $value     Query variable value.
     73 */
     74function set_query_var( $query_var, $value ) {
     75    global $wp_query;
     76    $wp_query->set( $query_var, $value );
    7677}
    7778
Note: See TracChangeset for help on using the changeset viewer.