IntenseWebs/WordPress
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Docs: Various docblock improvements.

Browse Source 
See #51800

Built from https://develop.svn.wordpress.org/trunk@49790


git-svn-id: http://core.svn.wordpress.org/trunk@49513 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn
2020-12-10 23:59:03 +00:00
parent 42fcfa5b3d
commit bf83c368fd
12 changed files with 55 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View File

@@ -266,7 +266,15 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
$args['post_type'] = $this->post_type;
/**
* 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.
*
@@ -274,8 +282,8 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
*
* @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 );
$query_args = $this->prepare_items_query( $args, $request );

4
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php
View File

@@ -233,7 +233,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
}
/**
* Filters the query arguments before passing them to get_terms().
* Filters get_terms() arguments when querying users via the REST API.
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
@@ -246,7 +246,7 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
*
* @param array $prepared_args Array of arguments to be
* passed to get_terms().
* @param WP_REST_Request $request The current request.
* @param WP_REST_Request $request The REST API request.
*/
$prepared_args = apply_filters( "rest_{$this->taxonomy}_query", $prepared_args, $request );

2
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php
View File

@@ -312,7 +312,7 @@ class WP_REST_Users_Controller extends WP_REST_Controller {
* @since 4.7.0
*
* @param array $prepared_args Array of arguments for WP_User_Query.
* @param WP_REST_Request $request The current request.
* @param WP_REST_Request $request The REST API request.
*/
$prepared_args = apply_filters( 'rest_user_query', $prepared_args, $request );