vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 12:20:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

REST API: Support querying for multiple post statuses.

Browse Source 
Multiple post statuses can be specified by the usual CSV or array-propper format.

Props jnylen0, kadamwhite, websupporter.
Fixes #38420.


git-svn-id: https://develop.svn.wordpress.org/trunk@39104 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Joe Hoyle
2016-11-03 01:45:48 +00:00
parent a0876e06cd
commit 25b892c1ca
7 changed files with 188 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/phpunit/tests/rest-api/rest-attachments-controller.php
+31
View File
@@ -327,6 +327,37 @@ class WP_Test_REST_Attachments_Controller extends WP_Test_REST_Post_Type_Control
$this->assertEquals( $attachment_id1, $data[0]['id'] );
}
public function test_get_items_multiple_statuses() {
// Logged out users can't make the request
wp_set_current_user( 0 );
$attachment_id1 = $this->factory->attachment->create_object( $this->test_file, 0, array(
'post_mime_type' => 'image/jpeg',
'post_excerpt' => 'A sample caption',
'post_status' => 'private',
) );
$attachment_id2 = $this->factory->attachment->create_object( $this->test_file, 0, array(
'post_mime_type' => 'image/jpeg',
'post_excerpt' => 'A sample caption',
'post_status' => 'trash',
) );
$request = new WP_REST_Request( 'GET', '/wp/v2/media' );
$request->set_param( 'status', array( 'private', 'trash' ) );
$response = $this->server->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
// Properly authorized users can make the request
wp_set_current_user( self::$editor_id );
$response = $this->server->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertEquals( 2, count( $data ) );
$ids = array(
$data[0]['id'],
$data[1]['id'],
);
sort( $ids );
$this->assertEquals( array( $attachment_id1, $attachment_id2 ), $ids );
}
public function test_get_items_invalid_date() {
$request = new WP_REST_Request( 'GET', '/wp/v2/media' );
$request->set_param( 'after', rand_str() );
tests/phpunit/tests/rest-api/rest-posts-controller.php
+67
View File
@@ -310,6 +310,60 @@ class WP_Test_REST_Posts_Controller extends WP_Test_REST_Post_Type_Controller_Te
$this->assertEquals( 1, count( $response->get_data() ) );
}
public function test_get_items_multiple_statuses_string_query() {
wp_set_current_user( self::$editor_id );
$this->factory->post->create( array( 'post_status' => 'draft' ) );
$this->factory->post->create( array( 'post_status' => 'private' ) );
$this->factory->post->create( array( 'post_status' => 'publish' ) );
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'context', 'edit' );
$request->set_param( 'status', 'draft,private' );
$response = $this->server->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertEquals( 2, count( $data ) );
$statuses = array(
$data[0]['status'],
$data[1]['status'],
);
sort( $statuses );
$this->assertEquals( array( 'draft', 'private' ), $statuses );
}
public function test_get_items_multiple_statuses_array_query() {
wp_set_current_user( self::$editor_id );
$this->factory->post->create( array( 'post_status' => 'draft' ) );
$this->factory->post->create( array( 'post_status' => 'pending' ) );
$this->factory->post->create( array( 'post_status' => 'publish' ) );
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'context', 'edit' );
$request->set_param( 'status', array( 'draft', 'pending' ) );
$response = $this->server->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertEquals( 2, count( $data ) );
$statuses = array(
$data[0]['status'],
$data[1]['status'],
);
sort( $statuses );
$this->assertEquals( array( 'draft', 'pending' ), $statuses );
}
public function test_get_items_multiple_statuses_one_invalid_query() {
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'context', 'edit' );
$request->set_param( 'status', array( 'draft', 'nonsense' ) );
$response = $this->server->dispatch( $request );
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
}
public function test_get_items_invalid_status_query() {
wp_set_current_user( 0 );
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
@@ -1963,6 +2017,19 @@ class WP_Test_REST_Posts_Controller extends WP_Test_REST_Post_Type_Controller_Te
$this->assertArrayHasKey( 'categories_exclude', $properties );
}
public function test_status_array_enum_args() {
$request = new WP_REST_Request( 'GET', '/wp/v2' );
$response = $this->server->dispatch( $request );
$data = $response->get_data();
$list_posts_args = $data['routes']['/wp/v2/posts']['endpoints'][0]['args'];
$status_arg = $list_posts_args['status'];
$this->assertEquals( 'array', $status_arg['type'] );
$this->assertEquals( array(
'type' => 'string',
'enum' => array( 'publish', 'future', 'draft', 'pending', 'private', 'trash', 'auto-draft', 'inherit', 'any' ),
), $status_arg['items'] );
}
public function test_get_additional_field_registration() {
$schema = array(
tests/phpunit/tests/rest-api/rest-schema-sanitization.php
+24
View File
@@ -86,4 +86,28 @@ class WP_Test_REST_Schema_Sanitization extends WP_UnitTestCase {
$this->assertEquals( array( 1, 2 ), rest_sanitize_value_from_schema( '1,2', $schema ) );
$this->assertEquals( array( 1, 2, 0 ), rest_sanitize_value_from_schema( '1,2,a', $schema ) );
}
public function test_type_array_with_enum() {
$schema = array(
'type' => 'array',
'items' => array(
'enum' => array( 'chicken', 'ribs', 'brisket' ),
'type' => 'string',
),
);
$this->assertEquals( array( 'ribs', 'brisket' ), rest_sanitize_value_from_schema( array( 'ribs', 'brisket' ), $schema ) );
$this->assertEquals( array( 'coleslaw' ), rest_sanitize_value_from_schema( array( 'coleslaw' ), $schema ) );
}
public function test_type_array_with_enum_as_csv() {
$schema = array(
'type' => 'array',
'items' => array(
'enum' => array( 'chicken', 'ribs', 'brisket' ),
'type' => 'string',
),
);
$this->assertEquals( array( 'ribs', 'chicken' ), rest_sanitize_value_from_schema( 'ribs,chicken', $schema ) );
$this->assertEquals( array( 'chicken', 'coleslaw' ), rest_sanitize_value_from_schema( 'chicken,coleslaw', $schema ) );
}
}
tests/phpunit/tests/rest-api/rest-schema-validation.php
+24
View File
@@ -115,4 +115,28 @@ class WP_Test_REST_Schema_Validation extends WP_UnitTestCase {
$this->assertTrue( rest_validate_value_from_schema( '1,2,3', $schema ) );
$this->assertWPError( rest_validate_value_from_schema( 'lol', $schema ) );
}
public function test_type_array_with_enum() {
$schema = array(
'type' => 'array',
'items' => array(
'enum' => array( 'chicken', 'ribs', 'brisket' ),
'type' => 'string',
),
);
$this->assertTrue( rest_validate_value_from_schema( array( 'ribs', 'brisket' ), $schema ) );
$this->assertWPError( rest_validate_value_from_schema( array( 'coleslaw' ), $schema ) );
}
public function test_type_array_with_enum_as_csv() {
$schema = array(
'type' => 'array',
'items' => array(
'enum' => array( 'chicken', 'ribs', 'brisket' ),
'type' => 'string',
),
);
$this->assertTrue( rest_validate_value_from_schema( 'ribs,chicken', $schema ) );
$this->assertWPError( rest_validate_value_from_schema( 'chicken,coleslaw', $schema ) );
}
}