Skip to content

Docs: add PHPDoc for rest_revision_query filter #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
apermo wants to merge 1 commit into from
+13 −1
Closed

Docs: add PHPDoc for rest_revision_query filter #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -226,6 +226,8 @@ protected function get_revision( $id ) {
*
* @since 4.7.0
*
* @see WP_REST_Posts_Controller::get_items()
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
*/
Expand Down Expand Up @@ -297,7 +299,17 @@ public function get_items( $request ) {
$args['update_post_meta_cache'] = false;
}

/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */
/**
* Filters WP_Query arguments when querying revisions via the REST API.
*
* Serves the same purpose as the {@see 'rest_{$this->post_type}_query'} filter in
* WP_REST_Posts_Controller, but for the standalone WP_REST_Revisions_Controller.
*
* @since 4.7.0
*
* @param array $args Array of arguments for WP_Query.
* @param WP_REST_Request $request The REST API request.
*/
$args = apply_filters( 'rest_revision_query', $args, $request );
if ( ! is_array( $args ) ) {
$args = array();
Expand Down
Loading