Skip to content

Yoast SEO 28.3 — docs(sitemaps): Document new wpseo_disable_xml_sitemap_cache_priming filter - #421

Open
claude[bot] wants to merge 1 commit into
mainfrom
rc-sync/wordpress-seo/28.3-RC2/sitemaps
Open

Yoast SEO 28.3 — docs(sitemaps): Document new wpseo_disable_xml_sitemap_cache_priming filter#421
claude[bot] wants to merge 1 commit into
mainfrom
rc-sync/wordpress-seo/28.3-RC2/sitemaps

Conversation

@claude

@claude claude Bot commented Aug 5, 2026

Copy link
Copy Markdown

RC docs sync — 28.3-RC2

Product: wordpress-seo
Area: sitemaps
Source evidence:

  • inc/sitemaps/class-post-type-sitemap-provider.php:775: new apply_filters('wpseo_disable_xml_sitemap_cache_priming', false) call — disables _prime_post_caches() + prime_thumbnail_caches() bulk priming that was added to improve sitemap generation performance

Changes in this PR

  • docs/features/xml-sitemaps/api.md: adds a new "Performance" section with documentation for the wpseo_disable_xml_sitemap_cache_priming filter, including a complete add_filter() example with PHPDoc

Verification

  • yarn build passes locally in this workflow.
  • yarn lint clean for files touched by this PR.

Reviewer notes

  • The filter's @since annotation in the source code says 28.0, but the filter appears as all-new + lines in the 28.3-RC2 diff vs. 28.3-RC1. This is likely a typo in the source — the filter was added in 28.3, not 28.0. Please verify against the Yoast SEO 28.0–28.2 tags if needed before merging, and adjust the "since" version in the doc if the filter was backported.
  • The bulk cache priming it controls also warms featured-image caches via the new prime_thumbnail_caches() method on WPSEO_Sitemap_Image_Parser. That method is internal (not a filter/action/CLI command) and is therefore not documented here separately.

Sibling PRs from this RC


Authored by the RC docs-sync agent. Not auto-merged — requires human review. Run: https://github.com/Yoast/developer/actions/runs/30983367949

…filter

Yoast SEO 28.3-RC2 adds a new filter that lets integrators opt out of
the bulk cache priming introduced for sitemap performance.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: a06fe76
Status: ✅  Deploy successful!
Preview URL: https://dfccb2f7.yoast-developer.pages.dev
Branch Preview URL: https://rc-sync-wordpress-seo-28-3-r-njk7.yoast-developer.pages.dev

View logs

@leonidasmi leonidasmi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ready to be merged when 28.3 is released

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

Labels

area/sitemaps Related to XML sitemaps feature product/wordpress-seo Related to Yoast SEO for WordPress rc/28.3-RC2 RC docs sync for Yoast SEO 28.3-RC2 rc-doc-sync RC documentation sync PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant