Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

62292 warning in wp rest posts controllerget items #8021

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from
+125 −3
Open

62292 warning in wp rest posts controllerget items #8021

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
838798d
This diff introduces a new test, `test_get_items_pagination`, to the …
Dec 18, 2024
25a1d06
Merge branch 'WordPress:trunk' into 62292-Warning-in-WP_REST_Posts_Co…
pbearne Dec 18, 2024
3b6b4f3
Refactor pagination logic and add related unit tests.
Dec 19, 2024
51cb287
Merge remote-tracking branch 'origin/62292-Warning-in-WP_REST_Posts_C…
Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-revisions-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ public function get_items( $request ) {
$revisions_query = new WP_Query();
$revisions = $revisions_query->query( $query_args );
$offset = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;
$page = (int) $query_args['paged'];
$page = isset( $query_args['paged'] ) ? (int) $query_args['paged'] : 0;
$total_revisions = $revisions_query->found_posts;

if ( $total_revisions < 1 ) {
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,7 +457,7 @@ static function ( $format ) {
remove_filter( 'post_password_required', array( $this, 'check_password_required' ) );
}

$page = (int) $query_args['paged'];
$page = isset( $query_args['paged'] ) ? (int) $query_args['paged'] : 0;
$total_posts = $posts_query->found_posts;

if ( $total_posts < 1 && $page > 1 ) {
Expand Down
2 changes: 1 addition & 1 deletion src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ public function get_items( $request ) {
$revisions_query = new WP_Query();
$revisions = $revisions_query->query( $query_args );
$offset = isset( $query_args['offset'] ) ? (int) $query_args['offset'] : 0;
$page = (int) $query_args['paged'];
$page = isset( $query_args['paged'] ) ? (int) $query_args['paged'] : 0;
$total_revisions = $revisions_query->found_posts;

if ( $total_revisions < 1 ) {
Expand Down
41 changes: 41 additions & 0 deletions tests/phpunit/tests/rest-api/rest-global-styles-revisions-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,6 +826,47 @@ public function test_get_items_out_of_bounds_page_should_not_error_if_offset() {
$this->assertCount( $expected_count, $response->get_data() );
}


/**
* tests for the pagination
*
* @ticket 62292
*
* @covers WP_REST_Global_Styles_Controller::get_items
*/
public function test_get_global_styles_revisions_pagination() {
wp_set_current_user( self::$admin_id );

// Test offset
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'offset', 1 );
$request->set_param( 'per_page', 1 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertEquals( 3, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 3, $response->get_headers()['X-WP-TotalPages'] );

// Test paged
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'page', 2 );
$request->set_param( 'per_page', 2 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertEquals( 3, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 2, $response->get_headers()['X-WP-TotalPages'] );

// Test out of bounds
$request = new WP_REST_Request( 'GET', '/wp/v2/global-styles/' . self::$global_styles_id . '/revisions' );
$request->set_param( 'page', 4 );
$request->set_param( 'per_page', 6 );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_revision_invalid_page_number', $response, 400 );
}

/**
* @doesNotPerformAssertions
*/
Expand Down
41 changes: 41 additions & 0 deletions tests/phpunit/tests/rest-api/rest-posts-controller.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5637,6 +5637,45 @@ public function test_multiple_post_format_support() {
$this->assertCount( 2, $response->get_data(), 'Two posts are expected to be returned' );
}

/**
* tests for the pagination
*
* @ticket 62292
*
* @covers WP_REST_Posts_Controller::get_items
*/
public function test_get_posts_with_pagination() {

// Test offset
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'offset', 1 );
$request->set_param( 'per_page', 1 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertEquals( 30, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 30, $response->get_headers()['X-WP-TotalPages'] );

// Test paged
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'page', 2 );
$request->set_param( 'per_page', 2 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 2, $data );
$this->assertEquals( 30, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 15, $response->get_headers()['X-WP-TotalPages'] );

// Test out of bounds
$request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
$request->set_param( 'page', 4 );
$request->set_param( 'per_page', 10 );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_post_invalid_page_number', $response, 400 );
}

/**
* Internal function used to disable an insert query which
* will trigger a wpdb error for testing purposes.
Expand All @@ -5663,6 +5702,8 @@ public function filter_post_item_schema( $schema ) {
return $schema;
}



public function filter_post_item_schema_add_property( $schema ) {
$schema['properties']['something_entirely_new'] = array(
'description' => __( 'A new prop added with a the rest_post_item_schema filter.' ),
Expand Down
40 changes: 40 additions & 0 deletions tests/phpunit/tests/rest-api/wpRestTemplateRevisionsController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,46 @@ public function test_get_items() {
);
}

/**
* tests for the pagination
*
* @ticket 62292
*
* @covers WP_REST_Template_Revisions_Controller::get_items
*/
public function test_get_template_revisions_pagination() {
wp_set_current_user( self::$admin_id );

// Test offset
$request = new WP_REST_Request( 'GET', '/wp/v2/templates/' . self::TEST_THEME . '/' . self::TEMPLATE_NAME . '/revisions' );
$request->set_param( 'offset', 1 );
$request->set_param( 'per_page', 1 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 1, $data );
$this->assertEquals( 4, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 4, $response->get_headers()['X-WP-TotalPages'] );

// Test paged
$request = new WP_REST_Request( 'GET', '/wp/v2/templates/' . self::TEST_THEME . '/' . self::TEMPLATE_NAME . '/revisions' );
$request->set_param( 'page', 2 );
$request->set_param( 'per_page', 2 );
$response = rest_get_server()->dispatch( $request );
$this->assertEquals( 200, $response->get_status() );
$data = $response->get_data();
$this->assertCount( 2, $data );
$this->assertEquals( 4, $response->get_headers()['X-WP-Total'] );
$this->assertEquals( 2, $response->get_headers()['X-WP-TotalPages'] );

// Test out of bounds
$request = new WP_REST_Request( 'GET', '/wp/v2/templates/' . self::TEST_THEME . '/' . self::TEMPLATE_NAME . '/revisions' );
$request->set_param( 'page', 4 );
$request->set_param( 'per_page', 6 );
$response = rest_get_server()->dispatch( $request );
$this->assertErrorResponse( 'rest_revision_invalid_page_number', $response, 400 );
}


/**
* @covers WP_REST_Template_Revisions_Controller::get_items_permissions_check
Expand Down
Loading