Changeset 10572 for sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php

Timestamp:

01/12/2021 09:30:56 PM (5 years ago)

Author:

iandunn

Message:

Pattern API: Use search param instead of /search endpoint.

Only one post type is being searched, so this is much simpler.

See ​https://github.com/WordPress/gutenberg/pull/26578#issuecomment-745032557

File:

• sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php (modified) (3 diffs)

sites/trunk/api.wordpress.org/public_html/patterns/1.0/index.php

@@ -8 +8 @@
  *
  * todo
- *  publish caching sysreq once query args settled, etc -- https://make.wordpress.org/systems/wp-admin/post.php?post=1788&action=edit
- *
- */
-
-
-/*
- * @todo
- *
+ * - publish caching sysreq once query args settled, etc -- https://make.wordpress.org/systems/wp-admin/post.php?post=1788&action=edit
+ * - add docs to codex
  */
 
@@ -24 +18 @@
  * Proxy w.org/patterns API endpoints for reliability.
  *
- * Core needs to send requests to api.w.org, because it has more resources and better caching than w.org.
+ * Core clients need to send requests to api.w.org, because it has more resources and better caching than w.org.
  *
  * @param string $query_string
@@ -31 +25 @@
     $api_url_base  = 'https://wordpress.org/patterns/wp-json';
     $wp_init_query = true;
+    $endpoint      = '/wp/v2/wporg-pattern';
 
+    /*
+     * Core clients should pass params for the desired action:
+     *
+     * @example Browse all:        `/patterns/1.0/`
+     * @example Browse a category: `/patterns/1.0/?pattern-categories={id}`
+     * @example Search:            `/patterns/1.0/?search={query}`
+     */
     parse_str( $query_string, $query_args );
 
-    switch ( $query_args['action'] ) {
-        // List all patterns, or all with in category.
-        // To restrict to a category, the client needs to provide `pattern-categories={id}` param.
-        default:
-        case 'get_patterns':
-            $endpoint = '/wp/v2/wporg-pattern';
+    /*
+     * Filter the returned fields down to only the ones Core uses.
+     *
+     * `_links` is necessary for `wp:term` to be embedded, see https://core.trac.wordpress.org/ticket/49985.
+     * Related https://core.trac.wordpress.org/ticket/49538.
+     */
+    $query_args['_fields'] = 'id,title,content,meta,_links';
+    $query_args['_embed']  = 'wp:term';
 
-            // `_links` is a workaround for https://core.trac.wordpress.org/ticket/49985. Related https://core.trac.wordpress.org/ticket/49538.
-            $query_args['_fields'] = 'id,title,content,meta,_links';
-            $query_args['_embed']  = 'wp:term';
-
-            break;
-
-        // Search patterns.
-        // Client needs to provide `search={string}` param.
-        case 'query_patterns':
-            $endpoint              = '/wp/v2/search';
-            $query_args['subtype'] = 'wporg-pattern';
-
-            // `_links` is a workaround for https://core.trac.wordpress.org/ticket/49985. Related https://core.trac.wordpress.org/ticket/49538.
-            $query_args['_fields'] = '_links';
-            $query_args['_embed']  = 'self';
-
-            break;
-    }
-
-    unset( $query_args['action'] );
-
-    $wp_init_host = $api_url_base . $endpoint;
-
-    if ( $query_args ) {
-        $wp_init_host .= '?' . urldecode( http_build_query( $query_args ) );
-    }
+    $wp_init_host = $api_url_base . $endpoint . '?' . urldecode( http_build_query( $query_args ) );
 
     // Load WordPress to process the request and output the response.