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

Timestamp:

05/26/2021 02:15:51 AM (5 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Add support for modifying the term relation when querying posts.

By default, a post most contain any of the requested terms to be included in the response. This commit adds a new operator property that can be set to AND to require a post to contain all of the requested terms.

For example, /wp/v2/posts?tags[terms]=1,2,3&tags[operator]=AND will return posts that have tags with the ids of 1, 2, and 3.

Props dlh, earnjam, Clorith, jnylen0, sebbb.
Fixes #41287.

File:

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

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

@@ -2942 +2942 @@
                                 $terms            = array();
                                 $include_children = false;
+                                $operator         = 'IN';
 
                                 if ( rest_is_array( $tax_include ) ) {
@@ -2948 +2949 @@
                                         $terms            = empty( $tax_include['terms'] ) ? array() : $tax_include['terms'];
                                         $include_children = ! empty( $tax_include['include_children'] );
+
+                                        if ( isset( $tax_include['operator'] ) && 'AND' === $tax_include['operator'] ) {
+                                                $operator = 'AND';
+                                        }
                                 }
 
@@ -2956 +2961 @@
                                                 'terms'            => $terms,
                                                 'include_children' => $include_children,
+                                                'operator'         => $operator,
                                         );
                                 }
@@ -3049 +3055 @@
                         $limit_schema
                 );
+                // 'operator' is supported only for 'include' queries.
+                $include_schema['oneOf'][1]['properties']['operator'] = array(
+                        'description' => __( 'Whether items must be assigned all or any of the specified terms.' ),
+                        'type'        => 'string',
+                        'enum'        => array( 'AND', 'OR' ),
+                        'default'     => 'OR',
+                );
+
                 $exclude_schema = array_merge(
                         array(