WP_REST_Comments_Controller::prepare_item_for_response( WP_Comment $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemWP_Comment

Comment object.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 3

3 hooks fire while WP_REST_Comments_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_comment )filterline 1137 (+7 into the body)

   Filters a comment returned from the REST API.

2. 2
   apply_filters( comment_text )filterline 1190 (+60 into the body)

   Filters the text of a comment to be displayed.

3. 3
   apply_filters( rest_prepare_comment )filterline 1237 (+107 into the body)

   Filters a comment returned from the REST API.

Uses · 13

• apply_filters()Calls the callback functions that have been added to a filter hook.
• mysql_to_rfc3339()Parses and formats a MySQL datetime (Y-m-d H:i:s) for ISO8601 (Y-m-d\TH:i:s).
• get_comment_link()Retrieves the link to a given comment.
• get_comment_type()Retrieves the comment type of the current comment.
• rest_get_avatar_urls()Retrieves the avatar URLs in various sizes.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_is_field_included()Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body.
• WP_REST_Response::__construct()
• WP_REST_Comments_Controller::get_fields_for_response()
• WP_REST_Comments_Controller::prepare_status_response()Checks comment_approved to set comment status for single comment output.
• WP_REST_Comments_Controller::add_additional_fields_to_object()
• WP_REST_Comments_Controller::filter_response_by_context()

Used by · 5

• WP_REST_Comments_Controller::create_item()Creates a comment.
• WP_REST_Comments_Controller::delete_item()Deletes a comment.
• WP_REST_Comments_Controller::get_item()Retrieves a comment.
• WP_REST_Comments_Controller::get_items()Retrieves a list of comment items.
• WP_REST_Comments_Controller::update_item()Updates a comment.

Source

View on Trac ↗View on GitHub ↗

1130	public function prepare_item_for_response( $item, $request ) {1131		// Restores the more descriptive, specific name for use within this method.1132		$comment = $item;1133 1134		// Don't prepare the response body for HEAD requests.1135		if ( $request->is_method( 'HEAD' ) ) {1136			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php */1137			return apply_filters( 'rest_prepare_comment', new WP_REST_Response( array() ), $comment, $request );1138		}1139 1140		$fields = $this->get_fields_for_response( $request );1141		$data   = array();1142 1143		if ( in_array( 'id', $fields, true ) ) {1144			$data['id'] = (int) $comment->comment_ID;1145		}1146 1147		if ( in_array( 'post', $fields, true ) ) {1148			$data['post'] = (int) $comment->comment_post_ID;1149		}1150 1151		if ( in_array( 'parent', $fields, true ) ) {1152			$data['parent'] = (int) $comment->comment_parent;1153		}1154 1155		if ( in_array( 'author', $fields, true ) ) {1156			$data['author'] = (int) $comment->user_id;1157		}1158 1159		if ( in_array( 'author_name', $fields, true ) ) {1160			$data['author_name'] = $comment->comment_author;1161		}1162 1163		if ( in_array( 'author_email', $fields, true ) ) {1164			$data['author_email'] = $comment->comment_author_email;1165		}1166 1167		if ( in_array( 'author_url', $fields, true ) ) {1168			$data['author_url'] = $comment->comment_author_url;1169		}1170 1171		if ( in_array( 'author_ip', $fields, true ) ) {1172			$data['author_ip'] = $comment->comment_author_IP;1173		}1174 1175		if ( in_array( 'author_user_agent', $fields, true ) ) {1176			$data['author_user_agent'] = $comment->comment_agent;1177		}1178 1179		if ( in_array( 'date', $fields, true ) ) {1180			$data['date'] = mysql_to_rfc3339( $comment->comment_date );1181		}1182 1183		if ( in_array( 'date_gmt', $fields, true ) ) {1184			$data['date_gmt'] = mysql_to_rfc3339( $comment->comment_date_gmt );1185		}1186 1187		if ( in_array( 'content', $fields, true ) ) {1188			$data['content'] = array(1189				/** This filter is documented in wp-includes/comment-template.php */1190				'rendered' => apply_filters( 'comment_text', $comment->comment_content, $comment, array() ),1191				'raw'      => $comment->comment_content,1192			);1193		}1194 1195		if ( in_array( 'link', $fields, true ) ) {1196			$data['link'] = get_comment_link( $comment );1197		}1198 1199		if ( in_array( 'status', $fields, true ) ) {1200			$data['status'] = $this->prepare_status_response( $comment->comment_approved );1201		}1202 1203		if ( in_array( 'type', $fields, true ) ) {1204			$data['type'] = get_comment_type( $comment->comment_ID );1205		}1206 1207		if ( in_array( 'author_avatar_urls', $fields, true ) ) {1208			$data['author_avatar_urls'] = rest_get_avatar_urls( $comment );1209		}

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.