Skip to content

Yoast SEO 28.3 — docs(indexables): Document new wpseo_indexable_indexing_failed action - #422

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

Yoast SEO 28.3 — docs(indexables): Document new wpseo_indexable_indexing_failed action#422
claude[bot] wants to merge 1 commit into
mainfrom
rc-sync/wordpress-seo/28.3-RC2/indexables

Conversation

@claude

@claude claude Bot commented Aug 5, 2026

Copy link
Copy Markdown

RC docs sync — 28.3-RC2

Product: wordpress-seo
Area: indexables
Source evidence:

  • src/builders/indexable-builder.php:5701 (diff line): new do_action('wpseo_indexable_indexing_failed', $object_id, $object_type, $object_sub_type, $exception) call fired from the rebuild_for_object() catch-all Throwable handler
  • src/exceptions/indexable/indexing-failed-exception.php (new file): Indexing_Failed_Exception wraps the failing object's identity (id, type, sub-type) and passes it up the call stack; the error message is also shown in the SEO data optimization error report (changelog 28.3)
  • Changelog (28.3): "Adds the failing object's type and ID to the SEO data optimization error report when an indexable cannot be built."

Changes in this PR

  • docs/features/indexables/filters.md: adds a new "Observing indexing failures" section documenting the wpseo_indexable_indexing_failed action, with parameter table and a complete add_action() example

Verification

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

Reviewer notes

  • The action fires once per failing object after Yoast's own logging. The $exception parameter is the original Throwable (not the wrapping Indexing_Failed_Exception), so callers get the root cause directly.
  • $object_id is null for id-less object types such as home-page, system-page, date-archive, and post-type-archive. The example's error_log call handles this correctly with wp_json_encode.

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

Yoast SEO 28.3-RC2 adds a new action that fires when an indexable
cannot be built due to an unexpected error, letting third parties
observe and forward build failures.
@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying yoast-developer with  Cloudflare Pages  Cloudflare Pages

Latest commit: 88ba950
Status: ✅  Deploy successful!
Preview URL: https://f6fc258a.yoast-developer.pages.dev
Branch Preview URL: https://rc-sync-wordpress-seo-28-3-r-ypgq.yoast-developer.pages.dev

View logs

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

Labels

area/indexables Related to indexables 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.

0 participants