Changeset 53116

Timestamp:

04/09/2022 08:36:53 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Code Modernization: Rename parameters that use reserved keywords in wp-admin/includes/class-wp-posts-list-table.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 $class parameter to $css_class in WP_Posts_List_Table::get_edit_link().
• Renames the $parent parameter to $parent_page in WP_Posts_List_Table::_page_rows().

Follow-up to [52946], [52996], [52997], [52998], [53003], [53014], [53029], [53039].

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

File:

• trunk/src/wp-admin/includes/class-wp-posts-list-table.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-posts-list-table.php

@@ -252 +252 @@
      * @since 4.4.0
      *
-     * @param string[] $args  Associative array of URL parameters for the link.
-     * @param string   $label Link text.
-     * @param string   $class Optional. Class attribute. Default empty string.
+     * @param string[] $args      Associative array of URL parameters for the link.
+     * @param string   $link_text Link text.
+     * @param string   $css_class Optional. Class attribute. Default empty string.
      * @return string The formatted link string.
      */
-    protected function get_edit_link( $args, $label, $class = '' ) {
+    protected function get_edit_link( $args, $link_text, $css_class = '' ) {
         $url = add_query_arg( $args, 'edit.php' );
 
@@ -263 +263 @@
         $aria_current = '';
 
-        if ( ! empty( $class ) ) {
+        if ( ! empty( $css_class ) ) {
             $class_html = sprintf(
                 ' class="%s"',
-                esc_attr( $class )
+                esc_attr( $css_class )
             );
 
-            if ( 'current' === $class ) {
+            if ( 'current' === $css_class ) {
                 $aria_current = ' aria-current="page"';
             }
@@ -279 +279 @@
             $class_html,
             $aria_current,
-            $label
+            $link_text
         );
     }
@@ -906 +906 @@
      * @param array $children_pages
      * @param int   $count
-     * @param int   $parent
+     * @param int   $parent_page
      * @param int   $level
      * @param int   $pagenum
@@ -912 +912 @@
      * @param array $to_display List of pages to be displayed. Passed by reference.
      */
-    private function _page_rows( &$children_pages, &$count, $parent, $level, $pagenum, $per_page, &$to_display ) {
-        if ( ! isset( $children_pages[ $parent ] ) ) {
+    private function _page_rows( &$children_pages, &$count, $parent_page, $level, $pagenum, $per_page, &$to_display ) {
+        if ( ! isset( $children_pages[ $parent_page ] ) ) {
             return;
         }
@@ -920 +920 @@
         $end   = $start + $per_page;
 
-        foreach ( $children_pages[ $parent ] as $page ) {
+        foreach ( $children_pages[ $parent_page ] as $page ) {
             if ( $count >= $end ) {
                 break;
@@ -965 +965 @@
         }
 
-        unset( $children_pages[ $parent ] ); // Required in order to keep track of orphans.
+        unset( $children_pages[ $parent_page ] ); // Required in order to keep track of orphans.
     }