Skip to content

Commit e780f28

Browse files
SergeyBiryukovSergeyBiryukov
committed
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. git-svn-id: https://develop.svn.wordpress.org/trunk@53236 602fd350-edb4-49c9-b593-d223f7449a82
1 parent c63de78 commit e780f28

6 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎src/wp-content/themes/twentynineteen/inc/template-functions.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ function twentynineteen_body_classes( $classes ) {
3535
/**
3636
* Adds custom class to the array of posts classes.
3737
*/
38-
function twentynineteen_post_classes( $classes, $class, $post_id ) {
38+
function twentynineteen_post_classes( $classes, $css_class, $post_id ) {
3939
$classes[] = 'entry';
4040

4141
return $classes;

‎src/wp-content/themes/twentysixteen/inc/template-tags.php‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -161,16 +161,16 @@ function twentysixteen_post_thumbnail() {
161161
*
162162
* @since Twenty Sixteen 1.0
163163
*
164-
* @param string $class Optional. Class string of the div element. Defaults to 'entry-summary'.
164+
* @param string $css_class Optional. Class string of the div element. Defaults to 'entry-summary'.
165165
*/
166-
function twentysixteen_excerpt( $class = 'entry-summary' ) {
167-
$class = esc_attr( $class );
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;
176176
}

‎src/wp-content/themes/twentythirteen/functions.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -562,10 +562,10 @@ function twentythirteen_entry_meta() {
562562
*
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. */
571571
$format_prefix = _x( '%1$s on %2$s', '1: post format name. 2: date', 'twentythirteen' );
@@ -582,7 +582,7 @@ function twentythirteen_entry_date( $echo = true ) {
582582
esc_html( sprintf( $format_prefix, get_post_format_string( get_post_format() ), get_the_date() ) )
583583
);
584584

585-
if ( $echo ) {
585+
if ( $display ) {
586586
echo $date;
587587
}
588588

‎src/wp-content/themes/twentytwenty/inc/custom-css.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
* @param string $value The CSS value.
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 = '';
2727

@@ -35,7 +35,7 @@ function twentytwenty_generate_css( $selector, $style, $value, $prefix = '', $su
3535

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 ;)
4141

‎src/wp-content/themes/twentytwenty/inc/template-tags.php‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@
2727
*
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 ) {
34+
function twentytwenty_site_logo( $args = array(), $display = true ) {
3535
$logo = get_custom_logo();
3636
$site_title = get_bloginfo( 'name' );
3737
$contents = '';
@@ -83,7 +83,7 @@ function twentytwenty_site_logo( $args = array(), $echo = true ) {
8383
*/
8484
$html = apply_filters( 'twentytwenty_site_logo', $html, $args, $classname, $contents );
8585

86-
if ( ! $echo ) {
86+
if ( ! $display ) {
8787
return $html;
8888
}
8989

@@ -96,10 +96,10 @@ function twentytwenty_site_logo( $args = array(), $echo = true ) {
9696
*
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 ) {
102+
function twentytwenty_site_description( $display = true ) {
103103
$description = get_bloginfo( 'description' );
104104

105105
if ( ! $description ) {
@@ -121,7 +121,7 @@ function twentytwenty_site_description( $echo = true ) {
121121
*/
122122
$html = apply_filters( 'twentytwenty_site_description', $html, $description, $wrapper );
123123

124-
if ( ! $echo ) {
124+
if ( ! $display ) {
125125
return $html;
126126
}
127127

‎src/wp-content/themes/twentytwentyone/inc/custom-css.php‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@
1717
* @param string $value The CSS value.
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 ) {
23+
function 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.
2626
if ( ! $value || ! $selector ) {
@@ -29,7 +29,7 @@ function twenty_twenty_one_generate_css( $selector, $style, $value, $prefix = ''
2929

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.
3535
* It is included inside <style> tags and can only be interpreted as CSS on the browser.

0 commit comments

Comments
 (0)