Make WordPress Core

Changeset 55000


Ignore:
Timestamp:
12/16/2022 10:41:31 AM (20 months ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Rename parameters that use reserved keywords in wp-includes/sitemaps/class-wp-sitemaps.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 $public parameter to $is_public in WP_Sitemaps::add_robots().

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

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

File:
1 edited

Legend:

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

    r54755 r55000  
    251251     * @since 5.5.0
    252252     *
    253      * @param string $output robots.txt output.
    254      * @param bool   $public Whether the site is public.
     253     * @param string $output    robots.txt output.
     254     * @param bool   $is_public Whether the site is public.
    255255     * @return string The robots.txt output.
    256256     */
    257     public function add_robots( $output, $public ) {
    258         if ( $public ) {
     257    public function add_robots( $output, $is_public ) {
     258        if ( $is_public ) {
    259259            $output .= "\nSitemap: " . esc_url( $this->index->get_index_url() ) . "\n";
    260260        }
Note: See TracChangeset for help on using the changeset viewer.