Changeset 55132 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

Timestamp:

01/24/2023 04:52:42 PM (2 years ago)

Author:

hellofromTonya

Message:

Editor: Adds pagination and ordering support to WP_REST_Pattern_Directory_Controller.

Adds pagination and ordering support to WP_REST_Pattern_Directory_Controller by allow listing 'per_page', 'page', 'offset', 'order', and 'orderby' query parameters. This change enables pagination and ordering features in the pattern directory explorer by using the same sort as wordpress.org/patterns.

Reference:

• ​Gutenberg PR 45293

Follow-up to [55098], [51206], [51021].

Props ntsekouras, ryelle, arrasel403, hellofromTonya, ironprogrammer, mukesh27, robinwpdeveloper.
Fixes #57501.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php (modified) (5 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php

@@ -82 +82 @@
      * @since 5.8.0
      * @since 6.0.0 Added 'slug' to request.
+     * @since 6.2.0 Added 'per_page', 'page', 'offset', 'order', and 'orderby' to request.
      *
      * @param WP_REST_Request $request Full details about the request.
@@ -94 +95 @@
         require ABSPATH . WPINC . '/version.php';
 
-        $query_args = array(
-            'locale'     => get_user_locale(),
-            'wp-version' => $wp_version,
-        );
-
-        $category_id = $request['category'];
-        $keyword_id  = $request['keyword'];
-        $search_term = $request['search'];
-        $slug        = $request['slug'];
-
-        if ( $category_id ) {
-            $query_args['pattern-categories'] = $category_id;
-        }
-
-        if ( $keyword_id ) {
-            $query_args['pattern-keywords'] = $keyword_id;
-        }
-
-        if ( $search_term ) {
-            $query_args['search'] = $search_term;
-        }
-
-        if ( $slug ) {
-            $query_args['slug'] = $slug;
-        }
+        $valid_query_args = array(
+            'offset'   => true,
+            'order'    => true,
+            'orderby'  => true,
+            'page'     => true,
+            'per_page' => true,
+            'search'   => true,
+            'slug'     => true,
+        );
+        $query_args = array_intersect_key( $request->get_params(), $valid_query_args );
+
+        $query_args['locale']             = get_user_locale();
+        $query_args['wp-version']         = $wp_version; // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable -- it's defined in `version.php` above.
+        $query_args['pattern-categories'] = isset( $request['category'] ) ? $request['category'] : false;
+        $query_args['pattern-keywords']   = isset( $request['keyword'] ) ? $request['keyword'] : false;
+
+        $query_args = array_filter( $query_args );
 
         $transient_key = $this->get_transient_key( $query_args );
@@ -304 +297 @@
      *
      * @since 5.8.0
+     * @since 6.2.0 Added 'per_page', 'page', 'offset', 'order', and 'orderby' to request.
      *
      * @return array Collection parameters.
@@ -310 +304 @@
         $query_params = parent::get_collection_params();
 
-        // Pagination is not supported.
-        unset( $query_params['page'] );
-        unset( $query_params['per_page'] );
-
+        $query_params['per_page']['default'] = 100;
         $query_params['search']['minLength'] = 1;
         $query_params['context']['default']  = 'view';
@@ -332 +323 @@
             'description' => __( 'Limit results to those matching a pattern (slug).' ),
             'type'        => 'array',
+        );
+
+        $query_params['offset'] = array(
+            'description' => __( 'Offset the result set by a specific number of items.' ),
+            'type'        => 'integer',
+        );
+
+        $query_params['order'] = array(
+            'description' => __( 'Order sort attribute ascending or descending.' ),
+            'type'        => 'string',
+            'default'     => 'desc',
+            'enum'        => array( 'asc', 'desc' ),
+        );
+
+        $query_params['orderby'] = array(
+            'description' => __( 'Sort collection by post attribute.' ),
+            'type'        => 'string',
+            'default'     => 'date',
+            'enum'        => array(
+                'author',
+                'date',
+                'id',
+                'include',
+                'modified',
+                'parent',
+                'relevance',
+                'slug',
+                'include_slugs',
+                'title',
+                'favorite_count',
+            ),
         );