Make WordPress Core

Changeset 53236


Ignore:
Timestamp:
04/20/2022 02:22:21 PM (2 years 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.

Location:
trunk/src/wp-content/themes
Files:
6 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-content/themes/twentynineteen/inc/template-functions.php

    r51607 r53236  
    3636 * Adds custom class to the array of posts classes.
    3737 */
    38 function twentynineteen_post_classes( $classes, $class, $post_id ) {
     38function twentynineteen_post_classes( $classes, $css_class, $post_id ) {
    3939    $classes[] = 'entry';
    4040
  • trunk/src/wp-content/themes/twentysixteen/inc/template-tags.php

    r47550 r53236  
    162162     * @since Twenty Sixteen 1.0
    163163     *
    164      * @param string $class Optional. Class string of the div element. Defaults to 'entry-summary'.
    165      */
    166     function twentysixteen_excerpt( $class = 'entry-summary' ) {
    167         $class = esc_attr( $class );
     164     * @param string $css_class Optional. Class string of the div element. Defaults to 'entry-summary'.
     165     */
     166    function twentysixteen_excerpt( $css_class = 'entry-summary' ) {
     167        $css_class = esc_attr( $css_class );
    168168
    169169        if ( has_excerpt() || is_search() ) :
    170170            ?>
    171             <div class="<?php echo $class; ?>">
     171            <div class="<?php echo $css_class; ?>">
    172172                <?php the_excerpt(); ?>
    173             </div><!-- .<?php echo $class; ?> -->
     173            </div><!-- .<?php echo $css_class; ?> -->
    174174            <?php
    175175        endif;
  • trunk/src/wp-content/themes/twentythirteen/functions.php

    r52929 r53236  
    563563     * @since Twenty Thirteen 1.0
    564564     *
    565      * @param bool $echo (optional) Whether to echo the date. Default true.
     565     * @param bool $display (optional) Whether to display the date. Default true.
    566566     * @return string The HTML-formatted post date.
    567567     */
    568     function twentythirteen_entry_date( $echo = true ) {
     568    function twentythirteen_entry_date( $display = true ) {
    569569        if ( has_post_format( array( 'chat', 'status' ) ) ) {
    570570            /* translators: 1: Post format name, 2: Date. */
     
    583583        );
    584584
    585         if ( $echo ) {
     585        if ( $display ) {
    586586            echo $date;
    587587        }
  • trunk/src/wp-content/themes/twentytwenty/inc/custom-css.php

    r51322 r53236  
    2020     * @param string $prefix   The CSS prefix.
    2121     * @param string $suffix   The CSS suffix.
    22      * @param bool   $echo     Echo the styles.
     22     * @param bool   $display  Output the styles.
    2323     */
    24     function twentytwenty_generate_css( $selector, $style, $value, $prefix = '', $suffix = '', $echo = true ) {
     24    function twentytwenty_generate_css( $selector, $style, $value, $prefix = '', $suffix = '', $display = true ) {
    2525
    2626        $return = '';
     
    3636        $return = sprintf( '%s { %s: %s; }', $selector, $style, $prefix . $value . $suffix );
    3737
    38         if ( $echo ) {
     38        if ( $display ) {
    3939
    4040            echo $return; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- We need to double check this, but for now, we want to pass PHPCS ;)
  • 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    }
  • trunk/src/wp-content/themes/twentytwentyone/inc/custom-css.php

    r51294 r53236  
    1818 * @param string $prefix   The CSS prefix.
    1919 * @param string $suffix   The CSS suffix.
    20  * @param bool   $echo     Echo the styles.
     20 * @param bool   $display  Output the styles.
    2121 * @return string
    2222 */
    23 function twenty_twenty_one_generate_css( $selector, $style, $value, $prefix = '', $suffix = '', $echo = true ) {
     23function twenty_twenty_one_generate_css( $selector, $style, $value, $prefix = '', $suffix = '', $display = true ) {
    2424
    2525    // Bail early if there is no $selector elements or properties and $value.
     
    3030    $css = sprintf( '%s { %s: %s; }', $selector, $style, $prefix . $value . $suffix );
    3131
    32     if ( $echo ) {
     32    if ( $display ) {
    3333        /*
    3434         * Note to reviewers: $css contains auto-generated CSS.
Note: See TracChangeset for help on using the changeset viewer.