Skip to content

Fix parameter documentation for wpseo_sitemap_entry filter - #23543

Open
hritikkumar07 wants to merge 1 commit into
Yoast:trunkfrom
hritikkumar07:fix/wpseo-sitemap-entry-documentation-23148
Open

Fix parameter documentation for wpseo_sitemap_entry filter#23543
hritikkumar07 wants to merge 1 commit into
Yoast:trunkfrom
hritikkumar07:fix/wpseo-sitemap-entry-documentation-23148

Conversation

@hritikkumar07

Copy link
Copy Markdown

Context

The documentation for the wpseo_sitemap_entry filter 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:

  • Corrects the parameter documentation for the wpseo_sitemap_entry filter.

(Note: Label the PR as changelog: non-user-facing)

Relevant technical choices:

  • Updated the docblock in inc/sitemaps/class-post-type-sitemap-provider.php which 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:

  1. Open inc/sitemaps/class-post-type-sitemap-provider.php.
  2. Inspect the docblock parameters for the wpseo_sitemap_entry filter (around line 217).
  3. Verify that:
    • $url is documented as array containing the sitemap entry data.
    • $type is documented as string representing the type of sitemap entry (e.g. 'post', 'term', 'user').
    • $post is documented as object representing the object associated with the sitemap entry.

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:

  • Not applicable (pure documentation fix).

Impact check

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

  • None (comments/documentation update only).

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.
  • This PR also affects Yoast SEO for Google Docs. I have added a changelog entry starting with [yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached the Google Docs Add-on 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.
  • I have run grunt build:images and committed the results, if my PR introduces or edits images or SVGs.

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 #23148

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: Fix documentation for the wpseo_sitemap_entry filter

2 participants