Changeset 51295

Timestamp:

07/01/2021 06:49:30 PM (5 years ago)

Author:

desrosj

Message:

Docs: Correct documentation for rest_{$post_type}_query and rest_{$taxonomy}_query` filters.

Synchronize documentation for related rest_{$object_type}_query filters for consistency.

Props dlh.
Merges [51293] to the 5.8 branch.
Fixes #53568.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (2 diffs)
• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (2 diffs)

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

@@ -262 +262 @@
 
                 /**
-                 * Filters arguments, before passing to WP_Comment_Query, when querying comments via the REST API.
+                 * Filters WP_Comment_Query arguments when querying comments via the REST API.
                  *
                  * @since 4.7.0
@@ -269 +269 @@
                  *
                  * @param array           $prepared_args Array of arguments for WP_Comment_Query.
-                 * @param WP_REST_Request $request       The current request.
+                 * @param WP_REST_Request $request       The REST API request.
                  */
                 $prepared_args = apply_filters( 'rest_comment_query', $prepared_args, $request );

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

@@ -327 +327 @@
 
                 /**
-                 * Filters WP_Query arguments when querying users via the REST API.
+                 * Filters WP_Query arguments when querying posts via the REST API.
                  *
                  * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
@@ -344 +344 @@
                  * @link https://developer.wordpress.org/reference/classes/wp_query/
                  *
-                 * @param array           $args    Array of arguments to be passed to WP_Query.
+                 * @param array           $args    Array of arguments for WP_Query.
                  * @param WP_REST_Request $request The REST API request.
                  */

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

@@ -234 +234 @@
 
                 /**
-                 * Filters get_terms() arguments when querying users via the REST API.
+                 * Filters get_terms() arguments when querying terms via the REST API.
                  *
                  * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
@@ -250 +250 @@
                  * @link https://developer.wordpress.org/reference/functions/get_terms/
                  *
-                 * @param array           $prepared_args Array of arguments to be
-                 *                                       passed to get_terms().
+                 * @param array           $prepared_args Array of arguments for get_terms().
                  * @param WP_REST_Request $request       The REST API request.
                  */