sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

REST API: Introduce search term handler.

Browse Source 
This allows for clients to search the available terms via the `/wp/v2/search` endpoint by using a `type=term` query parameter.

Fixes #51458.
Props andraganescu, zieladam, noisysocks, TimothyBlynJacobs.


git-svn-id: https://develop.svn.wordpress.org/trunk@49103 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2020-10-08 01:30:25 +00:00
parent b7b1584139
commit 5b6f5f9f6d
5 changed files with 354 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/wp-includes/rest-api.php
View File

@ -268,6 +268,11 @@ function create_initial_rest_routes() {
$controller = new WP_REST_Comments_Controller;
$controller->register_routes();
$search_handlers = array(
new WP_REST_Post_Search_Handler(),
new WP_REST_Term_Search_Handler(),
);
/**
* Filters the search handlers to use in the REST search controller.
*
@ -277,7 +282,7 @@ function create_initial_rest_routes() {
* handler instance must extend the `WP_REST_Search_Handler` class.
* Default is only a handler for posts.
*/
$search_handlers = apply_filters( 'wp_rest_search_handlers', array( new WP_REST_Post_Search_Handler() ) );
$search_handlers = apply_filters( 'wp_rest_search_handlers', $search_handlers );
$controller = new WP_REST_Search_Controller( $search_handlers );
$controller->register_routes();

154
src/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php Normal file
View File

@ -0,0 +1,154 @@
<?php
/**
* REST API: WP_REST_Term_Search_Handler class
*
* @package WordPress
* @subpackage REST_API
* @since 5.6.0
*/
/**
* Core class representing a search handler for terms in the REST API.
*
* @since 5.6.0
*
* @see WP_REST_Search_Handler
*/
class WP_REST_Term_Search_Handler extends WP_REST_Search_Handler {
/**
* Constructor.
*
* @since 5.6.0
*/
public function __construct() {
$this->type = 'term';
$this->subtypes = array_values(
get_taxonomies(
array(
'public' => true,
'show_in_rest' => true,
),
'names'
)
);
}
/**
* Searches the object type content for a given search request.
*
* @since 5.6.0
*
* @param WP_REST_Request $request Full REST request.
* @return array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing
* an array of found IDs and `WP_REST_Search_Handler::RESULT_TOTAL` containing the
* total count for the matching search results.
*/
public function search_items( WP_REST_Request $request ) {
$taxonomies = $request[ WP_REST_Search_Controller::PROP_SUBTYPE ];
if ( in_array( WP_REST_Search_Controller::TYPE_ANY, $taxonomies, true ) ) {
$taxonomies = $this->subtypes;
}
$page = (int) $request['page'];
$per_page = (int) $request['per_page'];
$query_args = array(
'taxonomy' => $taxonomies,
'hide_empty' => false,
'offset' => ( $page - 1 ) * $per_page,
'number' => $per_page,
);
if ( ! empty( $request['search'] ) ) {
$query_args['search'] = $request['search'];
}
/**
* Filters the query arguments for a search request.
*
* Enables adding extra arguments or setting defaults for a term search request.
*
* @param array $query_args Key value array of query var to query value.
* @param WP_REST_Request $request The request used.
*/
$query_args = apply_filters( 'rest_term_search_query', $query_args, $request );
$query = new WP_Term_Query();
$found_terms = $query->query( $query_args );
$found_ids = wp_list_pluck( $found_terms, 'term_id' );
unset( $query_args['offset'], $query_args['number'] );
$total = wp_count_terms( $query_args );
// wp_count_terms() can return a falsey value when the term has no children.
if ( ! $total ) {
$total = 0;
}
return array(
self::RESULT_IDS => $found_ids,
self::RESULT_TOTAL => $total,
);
}
/**
* Prepares the search result for a given ID.
*
* @since 5.6.0
*
* @param int $id Item ID.
* @param array $fields Fields to include for the item.
* @return array Associative array containing all fields for the item.
*/
public function prepare_item( $id, array $fields ) {
$term = get_term( $id );
$data = array();
if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_ID ] = (int) $id;
}
if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_TITLE ] = $term->name;
}
if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_URL ] = get_term_link( $id );
}
if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_TYPE ] = $term->taxonomy;
}
return $data;
}
/**
* Prepares links for the search result of a given ID.
*
* @since 5.6.0
*
* @param int $id Item ID.
* @return array Links for the given item.
*/
public function prepare_item_links( $id ) {
$term = get_term( $id );
$links = array();
$item_route = rest_get_route_for_term( $term );
if ( $item_route ) {
$links['self'] = array(
'href' => rest_url( $item_route ),
'embeddable' => true,
);
}
$links['about'] = array(
'href' => rest_url( sprintf( 'wp/v2/taxonomies/%s', $term->taxonomy ) ),
);
return $links;
}
}

1
src/wp-settings.php
View File

@ -266,6 +266,7 @@ require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-term-meta-fields.php';
require ABSPATH . WPINC . '/rest-api/fields/class-wp-rest-user-meta-fields.php';
require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-search-handler.php';
require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-post-search-handler.php';
require ABSPATH . WPINC . '/rest-api/search/class-wp-rest-term-search-handler.php';
require ABSPATH . WPINC . '/sitemaps.php';
require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps.php';
require ABSPATH . WPINC . '/sitemaps/class-wp-sitemaps-index.php';

189
tests/phpunit/tests/rest-api/rest-search-controller.php
View File

@ -34,6 +34,20 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
*/
private static $my_content_post_ids = array();
/**
* Categories.
*
* @var int
*/
private static $my_category_id;
/**
* Tags.
*
* @var int
*/
private static $my_tag_id;
/**
* Create fake data before our tests run.
*
@ -62,6 +76,20 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
'post_content' => 'my-foocontent',
)
);
self::$my_category_id = $factory->term->create(
array(
'taxonomy' => 'category',
'name' => 'Test Category',
)
);
self::$my_tag_id = $factory->term->create(
array(
'taxonomy' => 'post_tag',
'name' => 'Test Tag',
)
);
}
/**
@ -77,6 +105,15 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
foreach ( $post_ids as $post_id ) {
wp_delete_post( $post_id, true );
}
$term_ids = array(
self::$my_category_id,
self::$my_tag_id,
);
foreach ( $term_ids as $term_id ) {
wp_delete_term( $term_id, true );
}
}
/**
@ -514,6 +551,158 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
$this->assertSame( $data[ WP_REST_Search_Controller::PROP_ID ], $data['_embedded']['self'][0][ WP_REST_Search_Controller::PROP_ID ] );
}
/**
* Search through terms of any type.
*
* @ticket 51458
*/
public function test_get_items_search_type_term() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'type' => 'term',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEqualSets(
array(
0 => 1, // That is the default category.
self::$my_category_id,
self::$my_tag_id,
),
wp_list_pluck( $response->get_data(), 'id' )
);
}
/**
* Search through terms of subtype 'category'.
*
* @ticket 51458
*/
public function test_get_items_search_type_term_subtype_category() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'type' => 'term',
'subtype' => 'category',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEqualSets(
array(
0 => 1, // That is the default category.
self::$my_category_id,
),
wp_list_pluck( $response->get_data(), 'id' )
);
}
/**
* Search through posts of an invalid post type.
*
* @ticket 51458
*/
public function test_get_items_search_term_subtype_invalid() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'type' => 'term',
'subtype' => 'invalid',
)
);
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
}
/**
* Search through posts and pages.
*
* @ticket 51458
*/
public function test_get_items_search_categories_and_tags() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'type' => 'term',
'subtype' => 'category,post_tag',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEqualSets(
array(
0 => 1, // This is the default category.
self::$my_category_id,
self::$my_tag_id,
),
wp_list_pluck( $response->get_data(), 'id' )
);
}
/**
* Search through all that matches a 'Test Category' search.
*
* @ticket 51458
*/
public function test_get_items_search_for_test_category() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'search' => 'Test Category',
'type' => 'term',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEqualSets(
array(
self::$my_category_id,
),
wp_list_pluck( $response->get_data(), 'id' )
);
}
/**
* Search through all that matches a 'Test Tag' search.
*
* @ticket 51458
*/
public function test_get_items_search_for_test_tag() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'search' => 'Test Tag',
'type' => 'term',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEqualSets(
array(
self::$my_tag_id,
),
wp_list_pluck( $response->get_data(), 'id' )
);
}
/**
* Searching for a term that doesn't exist should return an empty result.
*
* @ticket 51458
*/
public function test_get_items_search_for_missing_term() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'search' => 'Doesn\'t exist',
'type' => 'term',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEmpty( $response->get_data() );
}
/**
* Perform a REST request to our search endpoint with given parameters.
*/

5
tests/qunit/fixtures/wp-api-generated.js
View File

@ -4413,7 +4413,8 @@ mockedApiResponse.Schema = {
"required": false,
"default": "post",
"enum": [
"post"
"post",
"term"
],
"description": "Limit results to items of an object type.",
"type": "string"
@ -4427,6 +4428,8 @@ mockedApiResponse.Schema = {
"enum": [
"post",
"page",
"category",
"post_tag",
"any"
],
"type": "string"