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

REST API: Introduce search post format handler.

Browse Source 
This allows for clients to search the used post formats via the /wp/v2/search endpoint by using a type=post-format query parameter.
Fixes #51459.
Props andraganescu, zieladam, noisysocks, TimothyBlynJacobs.


git-svn-id: https://develop.svn.wordpress.org/trunk@49132 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Timothy Jacobs 2020-10-12 19:52:57 +00:00
parent 405a561301
commit c39f290124
5 changed files with 197 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -276,6 +276,7 @@ function create_initial_rest_routes() {
$search_handlers = array(
new WP_REST_Post_Search_Handler(),
new WP_REST_Term_Search_Handler(),
new WP_REST_Post_Format_Search_Handler(),
);
/**

128
src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php Normal file
View File

@ -0,0 +1,128 @@
<?php
/**
* REST API: WP_REST_Post_Format_Search_Handler class
*
* @package WordPress
* @subpackage REST_API
* @since 5.6.0
*/
/**
* Core class representing a search handler for post formats in the REST API.
*
* @since 5.6.0
*
* @see WP_REST_Search_Handler
*/
class WP_REST_Post_Format_Search_Handler extends WP_REST_Search_Handler {
/**
* Constructor.
*
* @since 5.6.0
*/
public function __construct() {
$this->type = 'post-format';
}
/**
* 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 ) {
$format_strings = get_post_format_strings();
$format_slugs = array_keys( $format_strings );
$query_args = array();
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 post format search request.
*
* @since 5.6.0
*
* @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_post_format_search_query', $query_args, $request );
$found_ids = array();
foreach ( $format_slugs as $index => $format_slug ) {
if ( ! empty( $query_args['search'] ) ) {
$format_string = get_post_format_string( $format_slug );
$format_slug_match = stripos( $format_slug, $query_args['search'] ) !== false;
$format_string_match = stripos( $format_string, $query_args['search'] ) !== false;
if ( ! $format_slug_match && ! $format_string_match ) {
continue;
}
}
$format_link = get_post_format_link( $format_slug );
if ( $format_link ) {
$found_ids[] = $format_slug;
}
}
$page = (int) $request['page'];
$per_page = (int) $request['per_page'];
return array(
self::RESULT_IDS => array_slice( $found_ids, ( $page - 1 ) * $per_page, $per_page ),
self::RESULT_TOTAL => count( $found_ids ),
);
}
/**
* Prepares the search result for a given ID.
*
* @since 5.6.0
*
* @param string $id Item ID, the post format slug.
* @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 ) {
$data = array();
if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_ID ] = $id;
}
if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_TITLE ] = get_post_format_string( $id );
}
if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_URL ] = get_post_format_link( $id );
}
if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
$data[ WP_REST_Search_Controller::PROP_TYPE ] = $this->type;
}
return $data;
}
/**
* Prepares links for the search result.
*
* @since 5.6.0
*
* @param string $id Item ID, the post format slug.
* @return array Links for the given item.
*/
public function prepare_item_links( $id ) {
return array();
}
}

1
src/wp-settings.php
View File

@ -269,6 +269,7 @@ 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 . '/rest-api/search/class-wp-rest-post-format-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';

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

@ -54,6 +54,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
* @param WP_UnitTest_Factory $factory Helper that lets us create fake data.
*/
public static function wpSetUpBeforeClass( $factory ) {
add_theme_support( 'post-formats' );
self::$my_title_post_ids = $factory->post->create_many(
4,
array(
@ -77,6 +79,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
)
);
set_post_format( self::$my_title_post_ids[0], 'aside' );
self::$my_category_id = $factory->term->create(
array(
'taxonomy' => 'category',
@ -96,6 +100,8 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
* Delete our fake data after our tests run.
*/
public static function wpTearDownAfterClass() {
remove_theme_support( 'post-formats' );
$post_ids = array_merge(
self::$my_title_post_ids,
self::$my_title_page_ids,
@ -703,6 +709,65 @@ class WP_Test_REST_Search_Controller extends WP_Test_REST_Controller_Testcase {
$this->assertEmpty( $response->get_data() );
}
/**
* Search through post formats of any type.
*
* @ticket 51459
*/
public function test_get_items_search_type_post_format() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'type' => 'post-format',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertContains(
'Aside',
wp_list_pluck( $response->get_data(), 'title' )
);
}
/**
* Search through all that matches a 'Aside' search.
*
* @ticket 51459
*/
public function test_get_items_search_for_test_post_format() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'search' => 'Aside',
'type' => 'post-format',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertContains(
'Aside',
wp_list_pluck( $response->get_data(), 'title' )
);
}
/**
* Searching for a post format that doesn't exist should return an empty
* result.
*
* @ticket 51459
*/
public function test_get_items_search_for_missing_post_format() {
$response = $this->do_request_with_params(
array(
'per_page' => 100,
'search' => 'Doesn\'t exist',
'type' => 'post-format',
)
);
$this->assertEquals( 200, $response->get_status() );
$this->assertEmpty( $response->get_data() );
}
/**
* Perform a REST request to our search endpoint with given parameters.
*/

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

@ -4510,7 +4510,8 @@ mockedApiResponse.Schema = {
"default": "post",
"enum": [
"post",
"term"
"term",
"post-format"
],
"description": "Limit results to items of an object type.",
"type": "string"