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

Timestamp:

09/19/2022 09:06:08 PM (3 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-list-table.php (modified) (1 diff)

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

@@ -1515 +1515 @@
 
     /**
+     * Generates views links.
+     *
+     * @since 6.1.0
+     *
+     * @param array $link_data {
+     *     An array of link data.
+     *
+     *     @type string $url     The link URL.
+     *     @type string $label   The link label.
+     *     @type bool   $current Optional. Whether this is the currently selected view.
+     * }
+     * @return array An array of link markup. Keys match the $link_data input array.
+     */
+    protected function get_views_links( $link_data = array() ) {
+        if ( ! is_array( $link_data ) ) {
+            _doing_it_wrong(
+                __METHOD__,
+                sprintf(
+                    /* translators: %s: The $link_data argument. */
+                    __( 'The <code>%s</code> argument must be an array.' ),
+                    '$link_data'
+                ),
+                '6.1.0'
+            );
+
+            return array( '' );
+        }
+
+        $views_links = array();
+        foreach ( $link_data as $view => $link ) {
+            if ( empty( $link['url'] ) || ! is_string( $link['url'] ) || '' === trim( $link['url'] ) ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: %1$s: The argument name. %2$s: The view name. */
+                        __( 'The <code>%1$s</code> argument must be a non-empty string for <code>%2$s</code>.' ),
+                        'url',
+                        esc_html( $view )
+                    ),
+                    '6.1.0'
+                );
+
+                continue;
+            }
+
+            if ( empty( $link['label'] ) || ! is_string( $link['label'] ) || '' === trim( $link['label'] ) ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: %1$s: The argument name. %2$s: The view name. */
+                        __( 'The <code>%1$s</code> argument must be a non-empty string for <code>%2$s</code>.' ),
+                        'label',
+                        esc_html( $view )
+                    ),
+                    '6.1.0'
+                );
+
+                continue;
+            }
+
+            $views_links[ $view ] = sprintf(
+                '<a href="%s"%s>%s</a>',
+                esc_url( $link['url'] ),
+                isset( $link['current'] ) && true === $link['current'] ? ' class="current" aria-current="page"' : '',
+                $link['label']
+            );
+        }
+
+        return $views_links;
+    }
+
+    /**
      * Sends required variables to JavaScript land.
      *