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

Timestamp:

12/10/2020 11:57:29 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Various docblock improvements.

See #51800

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

@@ -267 +267 @@
 
         /**
-         * Filters the query arguments for a request.
+         * Filters WP_Query arguments when querying users via the REST API.
+         *
+         * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+         *
+         * Possible filter names include:
+         *
+         *  - `rest_post_query`
+         *  - `rest_page_query`
+         *  - `rest_attachment_query`
          *
          * Enables adding extra arguments or setting defaults for a post collection request.
@@ -275 +283 @@
          * @link https://developer.wordpress.org/reference/classes/wp_query/
          *
-         * @param array           $args    Key value array of query var to query value.
-         * @param WP_REST_Request $request The request used.
+         * @param array           $args    Array of arguments to be passed to WP_Query.
+         * @param WP_REST_Request $request The REST API request.
          */
         $args       = apply_filters( "rest_{$this->post_type}_query", $args, $request );