Changeset 59115 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Timestamp:

09/30/2024 01:17:40 AM (19 months ago)

Author:

peterwilsoncc

Message:

REST API/Editor: Support post formats in Query Block & Posts API.

Introduces post format support for both the Query Block with the new parameter format. In the build_query_vars_from_query_block() function, this is converted to a post_format taxonomy query passed to WP_Query.

Also introduces the format parameter to the REST API's Posts controller to support the feature in the Query block. The parameter type is an enumerated string accepted the post formats supported by each post type.

Props poena, mukesh27, mamaduka, noisysocks, TimothyBlynJacobs.
Fixes #62014.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)

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

@@ -346 +346 @@
 
         $args = $this->prepare_tax_query( $args, $request );
+
+        if ( ! empty( $request['format'] ) ) {
+            $formats = $request['format'];
+            /*
+             * The relation needs to be set to `OR` since the request can contain
+             * two separate conditions. The user may be querying for items that have
+             * either the `standard` format or a specific format.
+             */
+            $formats_query = array( 'relation' => 'OR' );
+
+            /*
+             * The default post format, `standard`, is not stored in the database.
+             * If `standard` is part of the request, the query needs to exclude all post items that
+             * have a format assigned.
+             */
+            if ( in_array( 'standard', $formats, true ) ) {
+                $formats_query[] = array(
+                    'taxonomy' => 'post_format',
+                    'field'    => 'slug',
+                    'operator' => 'NOT EXISTS',
+                );
+                // Remove the `standard` format, since it cannot be queried.
+                unset( $formats[ array_search( 'standard', $formats, true ) ] );
+            }
+
+            // Add any remaining formats to the formats query.
+            if ( ! empty( $formats ) ) {
+                // Add the `post-format-` prefix.
+                $terms = array_map(
+                    static function ( $format ) {
+                        return "post-format-$format";
+                    },
+                    $formats
+                );
+
+                $formats_query[] = array(
+                    'taxonomy' => 'post_format',
+                    'field'    => 'slug',
+                    'terms'    => $terms,
+                    'operator' => 'IN',
+                );
+            }
+
+            // Enable filtering by both post formats and other taxonomies by combining them with `AND`.
+            if ( isset( $args['tax_query'] ) ) {
+                $args['tax_query'][] = array(
+                    'relation' => 'AND',
+                    $formats_query,
+                );
+            } else {
+                $args['tax_query'] = $formats_query;
+            }
+        }
 
         // Force the post_type argument, since it's not a user input variable.
@@ -2993 +3046 @@
         }
 
+        if ( post_type_supports( $this->post_type, 'post-formats' ) ) {
+            $query_params['format'] = array(
+                'description' => __( 'Limit result set to items assigned one or more given formats.' ),
+                'type'        => 'array',
+                'uniqueItems' => true,
+                'items'       => array(
+                    'enum' => array_values( get_post_format_slugs() ),
+                    'type' => 'string',
+                ),
+            );
+        }
+
         /**
          * Filters collection parameters for the posts controller.