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

Timestamp:

09/19/2022 09:06:08 PM (2 years 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.

File:

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

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