From c54960342b3f03d5e6d82467cca1a6d445ac2a1c Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Mon, 5 Sep 2022 17:19:09 +0000 Subject: [PATCH] Coding Standards: Use more meaningful variable names for output in the admin. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This renames some variables for clarity, per the [https://developer.wordpress.org/coding-standards/wordpress-coding-standards/php/#naming-conventions Naming Conventions]: > Don’t abbreviate variable names unnecessarily; let the code be unambiguous and self-documenting. * `$out` is renamed to `$output` in various list table methods and admin functions. * `$sep` is renamed to `$separator` in various list table methods and admin functions. This affects: * `WP_Comments_List_Table::handle_row_actions()` * `WP_List_Table::row_actions()` * `WP_Media_List_Table::column_default()` * `WP_MS_Sites_List_Table::site_states()` * `WP_MS_Users_List_Table::column_blogs()` * `WP_Terms_List_Table::column_name()` * `_wp_dashboard_recent_comments_row()` * `image_align_input_fields()` * `image_size_input_fields()` * `wp_doc_link_parse()` * `_post_states()` * `_media_states()` Follow-up to [8653], [8692], [8864], [8910], [8911], [8916], [9103], [9153], [10607], [15491], [17793], [32644], [54070]. Props mukesh27, costdev. See #56448, #55647. Built from https://develop.svn.wordpress.org/trunk@54071 git-svn-id: http://core.svn.wordpress.org/trunk@53630 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- .../includes/class-wp-comments-list-table.php | 16 ++++++++-------- wp-admin/includes/class-wp-list-table.php | 12 ++++++------ wp-admin/includes/class-wp-media-list-table.php | 8 +++++--- .../includes/class-wp-ms-sites-list-table.php | 4 ++-- .../includes/class-wp-ms-users-list-table.php | 4 ++-- wp-admin/includes/class-wp-terms-list-table.php | 12 ++++++------ wp-admin/includes/dashboard.php | 6 +++--- wp-admin/includes/media.php | 14 +++++++------- wp-admin/includes/misc.php | 6 +++--- wp-admin/includes/template.php | 8 ++++---- wp-includes/version.php | 2 +- 11 files changed, 47 insertions(+), 45 deletions(-) diff --git a/wp-admin/includes/class-wp-comments-list-table.php b/wp-admin/includes/class-wp-comments-list-table.php index ae462dd0db..46558cc5ba 100644 --- a/wp-admin/includes/class-wp-comments-list-table.php +++ b/wp-admin/includes/class-wp-comments-list-table.php @@ -677,7 +677,7 @@ class WP_Comments_List_Table extends WP_List_Table { $comment = $item; $the_comment_status = wp_get_comment_status( $comment ); - $out = ''; + $output = ''; $del_nonce = esc_html( '_wpnonce=' . wp_create_nonce( "delete-comment_$comment->comment_ID" ) ); $approve_nonce = esc_html( '_wpnonce=' . wp_create_nonce( "approve-comment_$comment->comment_ID" ) ); @@ -832,7 +832,7 @@ class WP_Comments_List_Table extends WP_List_Table { $always_visible = true; } - $out .= '
'; + $output .= '
'; $i = 0; @@ -842,9 +842,9 @@ class WP_Comments_List_Table extends WP_List_Table { if ( ( ( 'approve' === $action || 'unapprove' === $action ) && 2 === $i ) || 1 === $i ) { - $sep = ''; + $separator = ''; } else { - $sep = ' | '; + $separator = ' | '; } // Reply and quickedit need a hide-if-no-js span when not added with Ajax. @@ -860,14 +860,14 @@ class WP_Comments_List_Table extends WP_List_Table { } } - $out .= "$sep$link"; + $output .= "{$separator}{$link}"; } - $out .= '
'; + $output .= '
'; - $out .= ''; + $output .= ''; - return $out; + return $output; } /** diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php index 8df48e6a0c..599c69d2ad 100644 --- a/wp-admin/includes/class-wp-list-table.php +++ b/wp-admin/includes/class-wp-list-table.php @@ -555,23 +555,23 @@ class WP_List_Table { $always_visible = true; } - $out = '
'; + $output = '
'; $i = 0; foreach ( $actions as $action => $link ) { ++$i; - $sep = ( $i < $action_count ) ? ' | ' : ''; + $separator = ( $i < $action_count ) ? ' | ' : ''; - $out .= "$link$sep"; + $output .= "{$link}{$separator}"; } - $out .= '
'; + $output .= '
'; - $out .= ''; + $output .= ''; - return $out; + return $output; } /** diff --git a/wp-admin/includes/class-wp-media-list-table.php b/wp-admin/includes/class-wp-media-list-table.php index baed19e1b3..a4b1972ccd 100644 --- a/wp-admin/includes/class-wp-media-list-table.php +++ b/wp-admin/includes/class-wp-media-list-table.php @@ -635,19 +635,21 @@ class WP_Media_List_Table extends WP_List_Table { $terms = get_the_terms( $post->ID, $taxonomy ); if ( is_array( $terms ) ) { - $out = array(); + $output = array(); + foreach ( $terms as $t ) { $posts_in_term_qv = array(); $posts_in_term_qv['taxonomy'] = $taxonomy; $posts_in_term_qv['term'] = $t->slug; - $out[] = sprintf( + $output[] = sprintf( '%s', esc_url( add_query_arg( $posts_in_term_qv, 'upload.php' ) ), esc_html( sanitize_term_field( 'name', $t->name, $t->term_id, $taxonomy, 'display' ) ) ); } - echo implode( wp_get_list_item_separator(), $out ); + + echo implode( wp_get_list_item_separator(), $output ); } else { echo '' . get_taxonomy( $taxonomy )->labels->no_terms . ''; } diff --git a/wp-admin/includes/class-wp-ms-sites-list-table.php b/wp-admin/includes/class-wp-ms-sites-list-table.php index 2d014700bb..b7d8b0e955 100644 --- a/wp-admin/includes/class-wp-ms-sites-list-table.php +++ b/wp-admin/includes/class-wp-ms-sites-list-table.php @@ -651,9 +651,9 @@ class WP_MS_Sites_List_Table extends WP_List_Table { foreach ( $site_states as $state ) { ++$i; - $sep = ( $i < $state_count ) ? ', ' : ''; + $separator = ( $i < $state_count ) ? ', ' : ''; - echo "{$state}{$sep}"; + echo "{$state}{$separator}"; } } } diff --git a/wp-admin/includes/class-wp-ms-users-list-table.php b/wp-admin/includes/class-wp-ms-users-list-table.php index f9eb81dc8d..e440281c09 100644 --- a/wp-admin/includes/class-wp-ms-users-list-table.php +++ b/wp-admin/includes/class-wp-ms-users-list-table.php @@ -438,9 +438,9 @@ class WP_MS_Users_List_Table extends WP_List_Table { foreach ( $actions as $action => $link ) { ++$i; - $sep = ( $i < $action_count ) ? ' | ' : ''; + $separator = ( $i < $action_count ) ? ' | ' : ''; - echo "$link$sep"; + echo "{$link}{$separator}"; } echo '
'; diff --git a/wp-admin/includes/class-wp-terms-list-table.php b/wp-admin/includes/class-wp-terms-list-table.php index 567f09a0d3..bae5a11b1f 100644 --- a/wp-admin/includes/class-wp-terms-list-table.php +++ b/wp-admin/includes/class-wp-terms-list-table.php @@ -414,19 +414,19 @@ class WP_Terms_List_Table extends WP_List_Table { ); } - $out = sprintf( + $output = sprintf( '%s
', $name ); - $out .= ''; - return $out; + return $output; } /** diff --git a/wp-admin/includes/dashboard.php b/wp-admin/includes/dashboard.php index 5de407f615..d3dcfceaae 100644 --- a/wp-admin/includes/dashboard.php +++ b/wp-admin/includes/dashboard.php @@ -799,9 +799,9 @@ function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) { if ( ( ( 'approve' === $action || 'unapprove' === $action ) && 2 === $i ) || 1 === $i ) { - $sep = ''; + $separator = ''; } else { - $sep = ' | '; + $separator = ' | '; } // Reply and quickedit need a hide-if-no-js span. @@ -813,7 +813,7 @@ function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) { $action .= ' hidden'; } - $actions_string .= "$sep$link"; + $actions_string .= "{$separator}{$link}"; } } ?> diff --git a/wp-admin/includes/media.php b/wp-admin/includes/media.php index 510fff563d..51f21ddb7d 100644 --- a/wp-admin/includes/media.php +++ b/wp-admin/includes/media.php @@ -1155,16 +1155,16 @@ function image_align_input_fields( $post, $checked = '' ) { $checked = 'none'; } - $out = array(); + $output = array(); foreach ( $alignments as $name => $label ) { - $name = esc_attr( $name ); - $out[] = ""; } - return implode( "\n", $out ); + return implode( "\n", $output ); } /** @@ -1199,7 +1199,7 @@ function image_size_input_fields( $post, $check = '' ) { $check = get_user_setting( 'imgsize', 'medium' ); } - $out = array(); + $output = array(); foreach ( $size_names as $size => $label ) { $downsize = image_downsize( $post->ID, $size ); @@ -1235,13 +1235,13 @@ function image_size_input_fields( $post, $check = '' ) { } $html .= ''; - $out[] = $html; + $output[] = $html; } return array( 'label' => __( 'Size' ), 'input' => 'html', - 'html' => implode( "\n", $out ), + 'html' => implode( "\n", $output ), ); } diff --git a/wp-admin/includes/misc.php b/wp-admin/includes/misc.php index 94f71567b9..94337fee7d 100644 --- a/wp-admin/includes/misc.php +++ b/wp-admin/includes/misc.php @@ -663,17 +663,17 @@ function wp_doc_link_parse( $content ) { $ignore_functions = array_unique( $ignore_functions ); - $out = array(); + $output = array(); foreach ( $functions as $function ) { if ( in_array( $function, $ignore_functions, true ) ) { continue; } - $out[] = $function; + $output[] = $function; } - return $out; + return $output; } /** diff --git a/wp-admin/includes/template.php b/wp-admin/includes/template.php index df886560f2..7fe5dd35fe 100644 --- a/wp-admin/includes/template.php +++ b/wp-admin/includes/template.php @@ -2168,9 +2168,9 @@ function _post_states( $post, $display = true ) { foreach ( $post_states as $state ) { ++$i; - $sep = ( $i < $state_count ) ? ', ' : ''; + $separator = ( $i < $state_count ) ? ', ' : ''; - $post_states_string .= "$state$sep"; + $post_states_string .= "{$state}{$separator}"; } } @@ -2282,9 +2282,9 @@ function _media_states( $post, $display = true ) { foreach ( $media_states as $state ) { ++$i; - $sep = ( $i < $state_count ) ? ', ' : ''; + $separator = ( $i < $state_count ) ? ', ' : ''; - $media_states_string .= "$state$sep"; + $media_states_string .= "{$state}{$separator}"; } } diff --git a/wp-includes/version.php b/wp-includes/version.php index 046c19f0a7..e4952f044b 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.1-alpha-54070'; +$wp_version = '6.1-alpha-54071'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.