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.

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

Fix attempt to read post ID on update_post_thumbnail_cache #6636

Open
wants to merge 4 commits into
base: trunk
Choose a base branch
from

Conversation

itzmekhokan
Copy link

Fix attempt to read post ID on update_post_thumbnail_cache function as some cases $wp_query->posts return array of post IDs instead of WP_Post object.

Trac ticket: #59521


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

Copy link

github-actions bot commented May 26, 2024

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props khokansardar, mukesh27, rajinsharwar.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link
Member

@mukeshpanchal27 mukeshpanchal27 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @itzmekhokan for PR. Could you please add unit tests that cover that scenario?

/*
* Check $post is valid post object of WP_Post or not,
* while some cases it can be an array of $posts IDs.
*
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
*
*

Fix PHPCS

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mukeshpanchal27 fixed and updated test cases.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

@@ -79,11 +80,28 @@ public function test_update_post_thumbnail_cache() {
)
);

// Test case where `$query1->posts` should return Array of post IDs.
$query1 = new WP_Query(

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit pick, let's use 2.

Suggested change
$query1 = new WP_Query(
$query2 = new WP_Query(
Comment on lines 100 to 104
$this->assertFalse( $query1->thumbnails_cached );

update_post_thumbnail_cache( $query1 );

$this->assertTrue( $query1->thumbnails_cached );

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
$this->assertFalse( $query1->thumbnails_cached );
update_post_thumbnail_cache( $query1 );
$this->assertTrue( $query1->thumbnails_cached );
$this->assertFalse( $query2->thumbnails_cached );
update_post_thumbnail_cache( $query2 );
$this->assertTrue( $query2->thumbnails_cached );
@@ -79,11 +80,28 @@ public function test_update_post_thumbnail_cache() {
)
);

// Test case where `$query1->posts` should return Array of post IDs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Test case where `$query1->posts` should return Array of post IDs.
// Test case where `$query2->posts` should return Array of post IDs.
$this->assertFalse( $query->thumbnails_cached );

update_post_thumbnail_cache( $query );

$this->assertTrue( $query->thumbnails_cached );

// Check test cases for `$query1`.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Check test cases for `$query1`.
// Check test cases for `$query2`.
*
* See https://core.trac.wordpress.org/ticket/59521.
*/
if ( ! ( $post instanceof WP_Post ) ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if ( ! ( $post instanceof WP_Post ) ) {
if ( ! $post instanceof WP_Post ) {

Nit-pick

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
3 participants