Make WordPress Core


Ignore:
Timestamp:
04/20/2022 02:22:21 PM (23 months ago)
Author:
SergeyBiryukov
Message:

Code Modernization: Rename parameters that use reserved keywords in bundled themes.

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 $class parameter to $css_class in:
    • twentysixteen_excerpt()
    • twentynineteen_post_classes()
  • Renames the $echo parameter to $display in:
    • twentythirteen_entry_date()
    • twentytwenty_generate_css()
    • twentytwenty_site_logo()
    • twentytwenty_site_description()
    • twenty_twenty_one_generate_css()

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

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-content/themes/twentytwenty/inc/template-tags.php

    r51322 r53236  
    2828 * @since Twenty Twenty 1.0
    2929 *
    30  * @param array $args Arguments for displaying the site logo either as an image or text.
    31  * @param bool  $echo Echo or return the HTML.
     30 * @param array $args    Arguments for displaying the site logo either as an image or text.
     31 * @param bool  $display Display or return the HTML.
    3232 * @return string Compiled HTML based on our arguments.
    3333 */
    34 function twentytwenty_site_logo( $args = array(), $echo = true ) {
     34function twentytwenty_site_logo( $args = array(), $display = true ) {
    3535    $logo       = get_custom_logo();
    3636    $site_title = get_bloginfo( 'name' );
     
    8484    $html = apply_filters( 'twentytwenty_site_logo', $html, $args, $classname, $contents );
    8585
    86     if ( ! $echo ) {
     86    if ( ! $display ) {
    8787        return $html;
    8888    }
     
    9797 * @since Twenty Twenty 1.0
    9898 *
    99  * @param bool $echo Echo or return the html.
     99 * @param bool $display Display or return the HTML.
    100100 * @return string The HTML to display.
    101101 */
    102 function twentytwenty_site_description( $echo = true ) {
     102function twentytwenty_site_description( $display = true ) {
    103103    $description = get_bloginfo( 'description' );
    104104
     
    122122    $html = apply_filters( 'twentytwenty_site_description', $html, $description, $wrapper );
    123123
    124     if ( ! $echo ) {
     124    if ( ! $display ) {
    125125        return $html;
    126126    }
Note: See TracChangeset for help on using the changeset viewer.