Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings
This repository was archived by the owner on Sep 24, 2018. It is now read-only.

Commit 69a720d

Browse filesBrowse files
rachelbakerrachelbaker
committed
Merge pull request #1831 from WP-API/consistent-prepare-filters
Make `prepare_*` filters more consistent
2 parents 920a1c0 + 525325a commit 69a720d
Copy full SHA for 69a720d

7 files changed

+52-35Lines changed: 52 additions & 35 deletions
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎lib/endpoints/class-wp-rest-attachments-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-attachments-controller.php
+6-7Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -217,21 +217,20 @@ public function prepare_item_for_response( $post, $request ) {
217217
$data = $this->filter_response_by_context( $data, $context );
218218

219219
// Wrap the data in a response object
220-
$data = rest_ensure_response( $data );
220+
$response = rest_ensure_response( $data );
221221

222-
$data->add_links( $this->prepare_links( $post ) );
222+
$response->add_links( $this->prepare_links( $post ) );
223223

224224
/**
225225
* Filter an attachment returned from the API.
226226
*
227227
* Allows modification of the attachment right before it is returned.
228228
*
229-
* @param array $data Key value array of attachment data: alt_text, caption, description,
230-
* media_type, media_details, post, source_url. Piossibly media_details.
231-
* @param WP_Post $post The attachment post.
232-
* @param WP_REST_Request $request Request used to generate the response.
229+
* @param WP_REST_Response $response The response object.
230+
* @param WP_Post $post The original attachment post.
231+
* @param WP_REST_Request $request Request used to generate the response.
233232
*/
234-
return apply_filters( 'rest_prepare_attachment', $data, $post, $request );
233+
return apply_filters( 'rest_prepare_attachment', $response, $post, $request );
235234
}
236235

237236
/**
Collapse file

‎lib/endpoints/class-wp-rest-comments-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-comments-controller.php
+12-3Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -512,11 +512,20 @@ public function prepare_item_for_response( $comment, $request ) {
512512
$data = $this->add_additional_fields_to_object( $data, $request );
513513

514514
// Wrap the data in a response object
515-
$data = rest_ensure_response( $data );
515+
$response = rest_ensure_response( $data );
516516

517-
$data->add_links( $this->prepare_links( $comment ) );
517+
$response->add_links( $this->prepare_links( $comment ) );
518518

519-
return apply_filters( 'rest_prepare_comment', $data, $comment, $request );
519+
/**
520+
* Filter a comment returned from the API.
521+
*
522+
* Allows modification of the comment right before it is returned.
523+
*
524+
* @param WP_REST_Response $response The response object.
525+
* @param object $comment The original comment object.
526+
* @param WP_REST_Request $request Request used to generate the response.
527+
*/
528+
return apply_filters( 'rest_prepare_comment', $response, $comment, $request );
520529
}
521530

522531
/**
Collapse file

‎lib/endpoints/class-wp-rest-posts-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-posts-controller.php
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1143,21 +1143,21 @@ public function prepare_item_for_response( $post, $request ) {
11431143
$data = $this->add_additional_fields_to_object( $data, $request );
11441144

11451145
// Wrap the data in a response object.
1146-
$data = rest_ensure_response( $data );
1146+
$response = rest_ensure_response( $data );
11471147

1148-
$data->add_links( $this->prepare_links( $post ) );
1148+
$response->add_links( $this->prepare_links( $post ) );
11491149

11501150
/**
11511151
* Filter the post data for a response.
11521152
*
11531153
* The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
11541154
* prepared for the response.
11551155
*
1156-
* @param array $data An array of post data, prepared for response.
1157-
* @param WP_Post $post Post object.
1158-
* @param WP_REST_Request $request Request object.
1156+
* @param WP_REST_Response $response The response object.
1157+
* @param WP_Post $post Post object.
1158+
* @param WP_REST_Request $request Request object.
11591159
*/
1160-
return apply_filters( 'rest_prepare_' . $this->post_type, $data, $post, $request );
1160+
return apply_filters( 'rest_prepare_' . $this->post_type, $response, $post, $request );
11611161
}
11621162

11631163
/**
Collapse file

‎lib/endpoints/class-wp-rest-revisions-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-revisions-controller.php
+10-1Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,16 @@ public function prepare_item_for_response( $post, $request ) {
221221
$response->add_link( 'parent', rest_url( sprintf( 'wp/%s/%d', $this->parent_base, $data['parent'] ) ) );
222222
}
223223

224-
return $response;
224+
/**
225+
* Filter a revision returned from the API.
226+
*
227+
* Allows modification of the revision right before it is returned.
228+
*
229+
* @param WP_REST_Response $response The response object.
230+
* @param WP_Post $post The original revision object.
231+
* @param WP_REST_Request $request Request used to generate the response.
232+
*/
233+
return apply_filters( 'rest_prepare_revision', $response, $post, $request );
225234
}
226235

227236
/**
Collapse file

‎lib/endpoints/class-wp-rest-taxonomies-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-taxonomies-controller.php
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,10 @@ public function prepare_item_for_response( $taxonomy, $request ) {
112112
$data = $this->add_additional_fields_to_object( $data, $request );
113113

114114
// Wrap the data in a response object.
115-
$data = rest_ensure_response( $data );
115+
$response = rest_ensure_response( $data );
116116

117117
$base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
118-
$data->add_links( array(
118+
$response->add_links( array(
119119
'collection' => array(
120120
'href' => rest_url( sprintf( 'wp/v2/%s', $base ) ),
121121
),
@@ -126,11 +126,11 @@ public function prepare_item_for_response( $taxonomy, $request ) {
126126
*
127127
* Allows modification of the taxonomy data right before it is returned.
128128
*
129-
* @param array $data An array of taxonomy date, prepared for response.
130-
* @param object $item The taxonomy object.
131-
* @param WP_REST_Request $request Request used to generate the response.
129+
* @param WP_REST_Response $response The response object.
130+
* @param object $item The original taxonomy object.
131+
* @param WP_REST_Request $request Request used to generate the response.
132132
*/
133-
return apply_filters( 'rest_prepare_taxonomy', $data, $taxonomy, $request );
133+
return apply_filters( 'rest_prepare_taxonomy', $response, $taxonomy, $request );
134134
}
135135

136136
/**
Collapse file

‎lib/endpoints/class-wp-rest-terms-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-terms-controller.php
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -453,20 +453,20 @@ public function prepare_item_for_response( $item, $request ) {
453453
$data = $this->filter_response_by_context( $data, $context );
454454
$data = $this->add_additional_fields_to_object( $data, $request );
455455

456-
$data = rest_ensure_response( $data );
456+
$response = rest_ensure_response( $data );
457457

458-
$data->add_links( $this->prepare_links( $item ) );
458+
$response->add_links( $this->prepare_links( $item ) );
459459

460460
/**
461461
* Filter a term item returned from the API.
462462
*
463463
* Allows modification of the term data right before it is returned.
464464
*
465-
* @param array $data Key value array of term data.
466-
* @param object $item The term object.
467-
* @param WP_REST_Request $request Request used to generate the response.
465+
* @param WP_REST_Response $response The response object.
466+
* @param object $item The original term object.
467+
* @param WP_REST_Request $request Request used to generate the response.
468468
*/
469-
return apply_filters( 'rest_prepare_term', $data, $item, $request );
469+
return apply_filters( 'rest_prepare_term', $response, $item, $request );
470470
}
471471

472472
/**
Collapse file

‎lib/endpoints/class-wp-rest-users-controller.php‎

Copy file name to clipboardExpand all lines: lib/endpoints/class-wp-rest-users-controller.php
+6-6Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -493,18 +493,18 @@ public function prepare_item_for_response( $user, $request ) {
493493
$data = $this->add_additional_fields_to_object( $data, $request );
494494

495495
// Wrap the data in a response object
496-
$data = rest_ensure_response( $data );
496+
$response = rest_ensure_response( $data );
497497

498-
$data->add_links( $this->prepare_links( $user ) );
498+
$response->add_links( $this->prepare_links( $user ) );
499499

500500
/**
501501
* Filter user data returned from the REST API.
502502
*
503-
* @param WP_REST_Response $data Response data.
504-
* @param object $user User object used to create response.
505-
* @param WP_REST_Request $request Request object.
503+
* @param WP_REST_Response $response The response object.
504+
* @param object $user User object used to create response.
505+
* @param WP_REST_Request $request Request object.
506506
*/
507-
return apply_filters( 'rest_prepare_user', $data, $user, $request );
507+
return apply_filters( 'rest_prepare_user', $response, $user, $request );
508508
}
509509

510510
/**

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.