From f5c67c386fe9a76b15cf282460b84686b929ed5d Mon Sep 17 00:00:00 2001 From: TimothyBlynJacobs Date: Thu, 8 Oct 2020 01:32:05 +0000 Subject: [PATCH] REST API: Introduce search term handler. 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. Built from https://develop.svn.wordpress.org/trunk@49103 git-svn-id: http://core.svn.wordpress.org/trunk@48865 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/rest-api.php | 7 +- .../class-wp-rest-term-search-handler.php | 154 ++++++++++++++++++ wp-includes/version.php | 2 +- wp-settings.php | 1 + 4 files changed, 162 insertions(+), 2 deletions(-) create mode 100644 wp-includes/rest-api/search/class-wp-rest-term-search-handler.php diff --git a/wp-includes/rest-api.php b/wp-includes/rest-api.php index 6bfba39ca8..33d8535533 100644 --- a/wp-includes/rest-api.php +++ b/wp-includes/rest-api.php @@ -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(); diff --git a/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php b/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php new file mode 100644 index 0000000000..e2d0e3b6cd --- /dev/null +++ b/wp-includes/rest-api/search/class-wp-rest-term-search-handler.php @@ -0,0 +1,154 @@ +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; + } +} diff --git a/wp-includes/version.php b/wp-includes/version.php index 05153bb54c..22c3d0fe7c 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -13,7 +13,7 @@ * * @global string $wp_version */ -$wp_version = '5.6-alpha-49102'; +$wp_version = '5.6-alpha-49103'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-settings.php b/wp-settings.php index 7fdc067158..e21e51999b 100644 --- a/wp-settings.php +++ b/wp-settings.php @@ -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';