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

Add is_string check to safeguard against array meta keys. #21306

Merged
merged 4 commits into from Apr 10, 2024

Conversation

thijsoo
Copy link
Contributor

@thijsoo thijsoo commented Apr 10, 2024

Context

  • It seems there are scenario's where deleted_post_meta is called with an array as the meta_keys parameter. We want to safeguard our code, since that gives a fatal in php 8.1

Summary

This PR can be summarized in the following changelog entry:

  • Fixes a bug where there would be a fatal error when deleting post meta in PHP 8.1 and higher. Props to @izzygld.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Make sure you are on php 8.1 or higher.
  • Add the following code to your functions.php or a mu plugin.
add_action( 'admin_init', 'admin_init_cb', 1 );
function admin_init_cb() {
	do_action( 'deleted_post_meta', 1, null, ['this','is','an','array'] );
}
  • Without this PR/RC make sure you get an fatal error.
  • With this pr make sure this error is gone.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • This touches the way we handle post meta. So it would be good to smoke test setting some values in the sidebare/metabox. Like the focus keyphrase.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

@thijsoo thijsoo added the changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog label Apr 10, 2024
@coveralls
Copy link

coveralls commented Apr 10, 2024

Pull Request Test Coverage Report for Build d5fd5b1fd0efa138d72835d9c6467dcb2fdfdf29

Details

  • 1 of 1 (100.0%) changed or added relevant line in 1 file are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 52.566%

Totals Coverage Status
Change from base Build dfcc56dd8ea44984b27442be5b9197f6659ad9d9: 0.0%
Covered Lines: 28352
Relevant Lines: 54400

💛 - Coveralls

Co-authored-by: Paolo L. Scala <68744851+pls78@users.noreply.github.com>
Copy link
Member

@pls78 pls78 left a comment

Choose a reason for hiding this comment

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

CR && Acc: ✅

@pls78 pls78 added this to the 22.5 milestone Apr 10, 2024
@pls78 pls78 merged commit 1af6fa4 into trunk Apr 10, 2024
22 checks passed
@pls78 pls78 deleted the add-is-string-to-post-meta-watcher branch April 10, 2024 12:40
@izzygld
Copy link

izzygld commented Apr 17, 2024

@thijsoo Was this pushed into the latest release (22.5)?

Fixes a bug where there would be a fatal error when deleting post meta in PHP 8.1 and higher. Props to @izzygld.

I don't see any mention of it on the release notes?

@thijsoo
Copy link
Contributor Author

thijsoo commented Apr 18, 2024

@izzygld This will be included in 22.6. So you should see it mentioned there in the release notes :) You can see the tentative tag here: https://github.com/Yoast/wordpress-seo/releases/tag/22.6-RC1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: bugfix Needs to be included in the 'Bugfixes' category in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants