Fix parameter documentation for wpseo_sitemap_entry filter - #23543
Open
hritikkumar07 wants to merge 1 commit into
Open
Fix parameter documentation for wpseo_sitemap_entry filter#23543hritikkumar07 wants to merge 1 commit into
hritikkumar07 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The documentation for the
wpseo_sitemap_entryfilter parameters was incorrect and did not match the actual types and shapes passed to the filter at runtime.Summary
This PR can be summarized in the following changelog entry:
(Note: Label the PR as
changelog: non-user-facing)Relevant technical choices:
inc/sitemaps/class-post-type-sitemap-provider.phpwhich is the central location where this filter's documentation is inherited from.Test instructions
Test instructions for the acceptance test before the PR gets merged
This PR can be acceptance tested by following these steps:
inc/sitemaps/class-post-type-sitemap-provider.php.wpseo_sitemap_entryfilter (around line 217).$urlis documented asarraycontaining the sitemap entry data.$typeis documented asstringrepresenting the type of sitemap entry (e.g.'post','term','user').$postis documented asobjectrepresenting the object associated with the sitemap entry.Relevant test scenarios
Test instructions for QA when the code is in the RC
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:
Other environments
[shopify-seo], added test instructions for Shopify and attached theShopifylabel to this PR.[yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached theGoogle Docs Add-onlabel to this PR.Documentation
Quality assurance
grunt build:imagesand committed the results, if my PR introduces or edits images or SVGs.Innovation
innovationlabel.Fixes #23148