Changeset 39223

Timestamp:

11/14/2016 04:41:40 PM (8 years ago)

Author:

joehoyle

Message:

REST API: Make all collection params filterable.

For developers wanting to add their own registered collection parameters, they can now use the rest_$type_collection_params filter. This brings consistency with the already existing rest_$post_type_collection_params.

Fixes #38710.
Props jnylen0.

Location:

trunk/src/wp-includes/rest-api/endpoints

Files:

• class-wp-rest-comments-controller.php (modified) (1 diff)
• class-wp-rest-terms-controller.php (modified) (1 diff)
• class-wp-rest-users-controller.php (modified) (1 diff)

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

@@ -1390 +1390 @@
         );
 
-        return $query_params;
+        /**
+         * Filter collection parameters for the comments controller.
+         *
+         * This filter registers the collection parameter, but does not map the
+         * collection parameter to an internal WP_Comment_Query parameter. Use the
+         * `rest_comment_query` filter to set WP_Comment_Query parameters.
+         *
+         * @since 4.7.0
+         *
+         * @param $params JSON Schema-formatted collection parameters.
+         */
+        return apply_filters( 'rest_comment_collection_params', $query_params );
     }
 

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

@@ -960 +960 @@
         );
 
-        return $query_params;
+        /**
+         * Filter collection parameters for the terms controller.
+         *
+         * The dynamic part of the filter `$this->taxonomy` refers to the taxonomy
+         * slug for the controller.
+         *
+         * This filter registers the collection parameter, but does not map the
+         * collection parameter to an internal WP_Term_Query parameter.  Use the
+         * `rest_{$this->taxonomy}_query` filter to set WP_Term_Query parameters.
+         *
+         * @since 4.7.0
+         *
+         * @param $params JSON Schema-formatted collection parameters.
+         * @param WP_Taxonomy $taxonomy_obj Taxonomy object.
+         */
+        return apply_filters( 'rest_{$this->taxonomy}_collection_params', $query_params, $taxonomy );
     }
 

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

@@ -1299 +1299 @@
         );
 
-        return $query_params;
+        /**
+         * Filter collection parameters for the users controller.
+         *
+         * This filter registers the collection parameter, but does not map the
+         * collection parameter to an internal WP_User_Query parameter.  Use the
+         * `rest_user_query` filter to set WP_User_Query arguments.
+         *
+         * @since 4.7.0
+         *
+         * @param $params JSON Schema-formatted collection parameters.
+         */
+        return apply_filters( 'rest_user_collection_params', $query_params );
     }
 }