WP_REST_Abilities_V1_Categories_Controller::prepare_item_for_response( WP_Ability_Category $category, WP_REST_Request $request ): WP_REST_Response

In this article

Prepares an ability category for response.

Parameters

$categoryWP_Ability_Categoryrequired
The ability category object.
$requestWP_REST_Requestrequired
Request object.

Return

WP_REST_Response Response object.

Source

public function prepare_item_for_response( $category, $request ) {
	$data = array(
		'slug'        => $category->get_slug(),
		'label'       => $category->get_label(),
		'description' => $category->get_description(),
		'meta'        => $category->get_meta(),
	);

	$context = $request['context'] ?? 'view';
	$data    = $this->add_additional_fields_to_object( $data, $request );
	$data    = $this->filter_response_by_context( $data, $context );

	$response = rest_ensure_response( $data );

	$fields = $this->get_fields_for_response( $request );
	if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
		$links = array(
			'self'       => array(
				'href' => rest_url( sprintf( '%s/%s/%s', $this->namespace, $this->rest_base, $category->get_slug() ) ),
			),
			'collection' => array(
				'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
			),
			'abilities'  => array(
				'href' => rest_url( sprintf( '%s/abilities?category=%s', $this->namespace, $category->get_slug() ) ),
			),
		);

		$response->add_links( $links );
	}

	return $response;
}

Changelog

VersionDescription
6.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.