Changeset 54215

Timestamp:

09/19/2022 09:06:08 PM (23 months ago)

Author:

davidbaumwald

Message:

Administration: Add new get_views_links method to WP_List_Table.

Many WP_List_Table child classes in core use mostly the same code to create their "view" links markup. To DRY-up the code, a new WP_List_Table->get_view_links method is being introduced to consolidate the HTML link generation when provided an array of links.

This change also implements this new method in the relevant WP_List_Table_xxx child classes get_views methods. Finally, unit tests are being added to validate view links markup and test for some "unhappy paths".

Props afercia, costdev, garrett-eclipse, Dharm1025, juhise, peterwilsoncc.
Fixes #42066.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-comments-list-table.php (modified) (3 diffs)
• src/wp-admin/includes/class-wp-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-ms-sites-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-ms-themes-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-ms-users-list-table.php (modified) (3 diffs)
• src/wp-admin/includes/class-wp-plugin-install-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-posts-list-table.php (modified) (5 diffs)
• src/wp-admin/includes/class-wp-privacy-requests-table.php (modified) (4 diffs)
• src/wp-admin/includes/class-wp-theme-install-list-table.php (modified) (1 diff)
• src/wp-admin/includes/class-wp-users-list-table.php (modified) (4 diffs)
• tests/phpunit/tests/admin/wpCommentsListTable.php (modified) (1 diff)
• tests/phpunit/tests/admin/wpListTable.php (modified) (2 diffs)
• tests/phpunit/tests/admin/wpPluginInstallListTable.php (added)
• tests/phpunit/tests/admin/wpPluginsListTable.php (added)
• tests/phpunit/tests/admin/wpPostCommentsListTable.php (added)
• tests/phpunit/tests/admin/wpPostsListTable.php (modified) (1 diff)
• tests/phpunit/tests/admin/wpPrivacyRequestsTable.php (modified) (1 diff)
• tests/phpunit/tests/admin/wpThemeInstallListTable.php (added)
• tests/phpunit/tests/admin/wpUsersListTable.php (added)
• tests/phpunit/tests/multisite/wpMsSitesListTable.php (modified) (1 diff)
• tests/phpunit/tests/multisite/wpMsThemesListTable.php (added)
• tests/phpunit/tests/multisite/wpMsUsersListTable.php (added)

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

@@ -294 +294 @@
 
         foreach ( $stati as $status => $label ) {
-            $current_link_attributes = '';
-
-            if ( $status === $comment_status ) {
-                $current_link_attributes = ' class="current" aria-current="page"';
-            }
-
             if ( 'mine' === $status ) {
                 $current_user_id    = get_current_user_id();
@@ -330 +324 @@
             */
 
-            $status_links[ $status ] = "<a href='$link'$current_link_attributes>" . sprintf(
-                translate_nooped_plural( $label, $num_comments->$status ),
-                sprintf(
-                    '<span class="%s-count">%s</span>',
-                    ( 'moderated' === $status ) ? 'pending' : $status,
-                    number_format_i18n( $num_comments->$status )
-                )
-            ) . '</a>';
+            $status_links[ $status ] = array(
+                'url'     => esc_url( $link ),
+                'label'   => sprintf(
+                    translate_nooped_plural( $label, $num_comments->$status ),
+                    sprintf(
+                        '<span class="%s-count">%s</span>',
+                        ( 'moderated' === $status ) ? 'pending' : $status,
+                        number_format_i18n( $num_comments->$status )
+                    )
+                ),
+                'current' => $status === $comment_status,
+            );
         }
 
@@ -349 +347 @@
          *                              'Pending', 'Approved', 'Spam', and 'Trash'.
          */
-        return apply_filters( 'comment_status_links', $status_links );
+        return apply_filters( 'comment_status_links', $ );
     }
 

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

@@ -1515 +1515 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Sends required variables to JavaScript land.
      *

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

@@ -263 +263 @@
 
         foreach ( $statuses as $status => $label_count ) {
-            $current_link_attributes = $requested_status === $status || ( '' === $requested_status && 'all' === $status )
-                ? ' class="current" aria-current="page"'
-                : '';
             if ( (int) $counts[ $status ] > 0 ) {
                 $label    = sprintf( translate_nooped_plural( $label_count, $counts[ $status ] ), number_format_i18n( $counts[ $status ] ) );
                 $full_url = 'all' === $status ? $url : add_query_arg( 'status', $status, $url );
 
-                $view_links[ $status ] = sprintf(
-                    '<a href="%1$s"%2$s>%3$s</a>',
-                    esc_url( $full_url ),
-                    $current_link_attributes,
-                    $label
+                $view_links[ $status ] = array(
+                    'url'     => esc_url( $full_url ),
+                    'label'   => $label,
+                    'current' => $requested_status === $status || ( '' === $requested_status && 'all' === $status ),
                 );
             }
         }
 
-        return $view_links;
+        return $;
     }
 

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

@@ -445 +445 @@
 
             if ( 'search' !== $type ) {
-                $status_links[ $type ] = sprintf(
-                    "<a href='%s'%s>%s</a>",
-                    esc_url( add_query_arg( 'theme_status', $type, $url ) ),
-                    ( $type === $status ) ? ' class="current" aria-current="page"' : '',
-                    sprintf( $text, number_format_i18n( $count ) )
+                $status_links[ $type ] = array(
+                    'url'     => esc_url( add_query_arg( 'theme_status', $type, $url ) ),
+                    'label'   => sprintf( $text, number_format_i18n( $count ) ),
+                    'current' => $type === $status,
                 );
             }
         }
 
-        return $status_links;
+        return $;
     }
 

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

@@ -138 +138 @@
         $total_admins = count( $super_admins );
 
-        $current_link_attributes = 'super' !== $role ? ' class="current" aria-current="page"' : '';
-        $role_links              = array();
-        $role_links['all']       = sprintf(
-            '<a href="%s"%s>%s</a>',
-            network_admin_url( 'users.php' ),
-            $current_link_attributes,
-            sprintf(
+        $role_links        = array();
+        $role_links['all'] = array(
+            'url'     => network_admin_url( 'users.php' ),
+            'label'   => sprintf(
                 /* translators: Number of users. */
                 _nx(
@@ -153 +150 @@
                 ),
                 number_format_i18n( $total_users )
-            )
-        );
-        $current_link_attributes = 'super' === $role ? ' class="current" aria-current="page"' : '';
-        $role_links['super']     = sprintf(
-            '<a href="%s"%s>%s</a>',
-            network_admin_url( 'users.php?role=super' ),
-            $current_link_attributes,
-            sprintf(
+            ),
+            'current' => 'super' !== $role,
+        );
+
+        $role_links['super'] = array(
+            'url'     => network_admin_url( 'users.php?role=super' ),
+            'label'   => sprintf(
                 /* translators: Number of users. */
                 _n(
@@ -168 +164 @@
                 ),
                 number_format_i18n( $total_admins )
-            )
-        );
-
-        return $role_links;
+            ),
+            'current' => 'super' === $role,
+        );
+
+        return $this->get_views_links( $role_links );
     }
 

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

@@ -311 +311 @@
         $display_tabs = array();
         foreach ( (array) $tabs as $action => $text ) {
-            $current_link_attributes                     = ( $action === $tab ) ? ' class="current" aria-current="page"' : '';
-            $href                                        = self_admin_url( 'plugin-install.php?tab=' . $action );
-            $display_tabs[ 'plugin-install-' . $action ] = "<a href='$href'$current_link_attributes>$text</a>";
+            $display_tabs[ 'plugin-install-' . $action ] = array(
+                'url'     => self_admin_url( 'plugin-install.php?tab=' . $action ),
+                'label'   => $text,
+                'current' => $action === $tab,
+            );
         }
         // No longer a real tab.
         unset( $display_tabs['plugin-install-upload'] );
 
-        return $display_tabs;
+        return $;
     }
 

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

@@ -577 +577 @@
 
             if ( 'search' !== $type ) {
-                $status_links[ $type ] = sprintf(
-                    "<a href='%s'%s>%s</a>",
-                    add_query_arg( 'plugin_status', $type, 'plugins.php' ),
-                    ( $type === $status ) ? ' class="current" aria-current="page"' : '',
-                    sprintf( $text, number_format_i18n( $count ) )
+                $status_links[ $type ] = array(
+                    'url'     => add_query_arg( 'plugin_status', $type, 'plugins.php' ),
+                    'label'   => sprintf( $text, number_format_i18n( $count ) ),
+                    'current' => $type === $status,
                 );
             }
         }
 
-        return $status_links;
+        return $;
     }
 

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

@@ -332 +332 @@
             );
 
-            $mine = $this->get_edit_link( $mine_args, $mine_inner_html, $class );
+            $mine = array(
+                'url'     => esc_url( add_query_arg( $mine_args, 'edit.php' ) ),
+                'label'   => $mine_inner_html,
+                'current' => isset( $_GET['author'] ) && ( $current_user_id === (int) $_GET['author'] ),
+            );
 
             $all_args['all_posts'] = 1;
             $class                 = '';
-        }
-
-        if ( empty( $class ) && ( $this->is_base_request() || isset( $_REQUEST['all_posts'] ) ) ) {
-            $class = 'current';
         }
 
@@ -353 +353 @@
         );
 
-        $status_links['all'] = $this->get_edit_link( $all_args, $all_inner_html, $class );
+        $status_links['all'] = array(
+            'url'     => esc_url( add_query_arg( $all_args, 'edit.php' ) ),
+            'label'   => $all_inner_html,
+            'current' => empty( $class ) && ( $this->is_base_request() || isset( $_REQUEST['all_posts'] ) ),
+        );
 
         if ( $mine ) {
@@ -382 +386 @@
             );
 
-            $status_links[ $status_name ] = $this->get_edit_link( $status_args, $status_label, $class );
+            $status_links[ $status_name ] = array(
+                'url'     => esc_url( add_query_arg( $status_args, 'edit.php' ) ),
+                'label'   => $status_label,
+                'current' => isset( $_REQUEST['post_status'] ) && $status_name === $_REQUEST['post_status'],
+            );
         }
 
@@ -405 +413 @@
 
             $sticky_link = array(
-                'sticky' => $this->get_edit_link( $sticky_args, $sticky_inner_html, $class ),
+                'sticky' => array(
+                    'url'     => esc_url( add_query_arg( $sticky_args, 'edit.php' ) ),
+                    'label'   => $sticky_inner_html,
+                    'current' => ! empty( $_REQUEST['show_sticky'] ),
+                ),
             );
 
@@ -413 +425 @@
         }
 
-        return $status_links;
+        return $;
     }
 

trunk/src/wp-admin/includes/class-wp-privacy-requests-table.php

@@ -154 +154 @@
         $admin_url = $this->get_admin_url();
 
-        $current_link_attributes = empty( $current_status ) ? ' class="current" aria-current="page"' : '';
-        $status_label            = sprintf(
+        $status_label = sprintf(
             /* translators: %s: Number of requests. */
             _nx(
@@ -166 +165 @@
         );
 
-        $views['all'] = sprintf(
-            '<a href="%s"%s>%s</a>',
-            esc_url( $admin_url ),
-            $current_link_attributes,
-            $status_label
+        $views['all'] = array(
+            'url'     => esc_url( $admin_url ),
+            'label'   => $status_label,
+            'current' => empty( $current_status ),
         );
 
@@ -179 +177 @@
             }
 
-            $current_link_attributes = $status === $current_status ? ' class="current" aria-current="page"' : '';
-            $total_status_requests   = absint( $counts->{$status} );
+            $total_status_requests = absint( $counts->{$status} );
 
             if ( ! $total_status_requests ) {
@@ -193 +190 @@
             $status_link = add_query_arg( 'filter-status', $status, $admin_url );
 
-            $views[ $status ] = sprintf(
-                '<a href="%s"%s>%s</a>',
-                esc_url( $status_link ),
-                $current_link_attributes,
-                $status_label
+            $views[ $status ] = array(
+                'url'     => esc_url( $status_link ),
+                'label'   => $status_label,
+                'current' => $status === $current_status,
             );
         }
 
-        return $views;
+        return $;
     }
 

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

@@ -187 +187 @@
         $display_tabs = array();
         foreach ( (array) $tabs as $action => $text ) {
-            $current_link_attributes                    = ( $action === $tab ) ? ' class="current" aria-current="page"' : '';
-            $href                                       = self_admin_url( 'theme-install.php?tab=' . $action );
-            $display_tabs[ 'theme-install-' . $action ] = "<a href='$href'$current_link_attributes>$text</a>";
-        }
-
-        return $display_tabs;
+            $display_tabs[ 'theme-install-' . $action ] = array(
+                'url'     => self_admin_url( 'theme-install.php?tab=' . $action ),
+                'label'   => $text,
+                'current' => $action === $tab,
+            );
+        }
+
+        return $this->get_views_links( $display_tabs );
     }
 

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

@@ -186 +186 @@
         }
 
-        $role_links              = array();
-        $avail_roles             = array();
-        $all_text                = __( 'All' );
-        $current_link_attributes = empty( $role ) ? ' class="current" aria-current="page"' : '';
+        $role_links  = array();
+        $avail_roles = array();
+        $all_text    = __( 'All' );
 
         if ( $count_users ) {
@@ -216 +215 @@
         }
 
-        $role_links['all'] = sprintf( '<a href="%s"%s>%s</a>', $url, $current_link_attributes, $all_text );
+        $role_links['all'] = array(
+            'url'     => $url,
+            'label'   => $all_text,
+            'current' => empty( $role ),
+        );
 
         foreach ( $wp_roles->get_names() as $this_role => $name ) {
             if ( $count_users && ! isset( $avail_roles[ $this_role ] ) ) {
                 continue;
-            }
-
-            $current_link_attributes = '';
-
-            if ( $this_role === $role ) {
-                $current_link_attributes = ' class="current" aria-current="page"';
             }
 
@@ -239 +236 @@
             }
 
-            $role_links[ $this_role ] = "<a href='" . esc_url( add_query_arg( 'role', $this_role, $url ) ) . "'$current_link_attributes>$name</a>";
+            $role_links[ $this_role ] = array(
+                'url'     => esc_url( add_query_arg( 'role', $this_role, $url ) ),
+                'label'   => $name,
+                'current' => $this_role === $role,
+            );
         }
 
         if ( ! empty( $avail_roles['none'] ) ) {
-
-            $current_link_attributes = '';
-
-            if ( 'none' === $role ) {
-                $current_link_attributes = ' class="current" aria-current="page"';
-            }
 
             $name = __( 'No role' );
@@ -258 +253 @@
             );
 
-            $role_links['none'] = "<a href='" . esc_url( add_query_arg( 'role', 'none', $url ) ) . "'$current_link_attributes>$name</a>";
-        }
-
-        return $role_links;
+            $role_links['none'] = array(
+                'url'     => esc_url( add_query_arg( 'role', 'none', $url ) ),
+                'label'   => $name,
+                'current' => 'none' === $role,
+            );
+        }
+
+        return $this->get_views_links( $role_links );
     }
 

trunk/tests/phpunit/tests/admin/wpCommentsListTable.php

@@ -196 +196 @@
     }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/admin/wpListTable.php

@@ -7 +7 @@
  */
 class Tests_Admin_WpListTable extends WP_UnitTestCase {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
     /**
@@ -105 +123 @@
         return $datasets;
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/admin/wpPostsListTable.php

@@ -320 +320 @@
     }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/admin/wpPrivacyRequestsTable.php

@@ -199 +199 @@
         );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
 }

trunk/tests/phpunit/tests/multisite/wpMsSitesListTable.php

@@ -231 +231 @@
             $this->assertSameSets( $expected, $items );
         }
+
+
+
+
+
+
+
+
+
+
+
+
     }
 endif;