Clarify in our documentation that our shortcode analysis filter does not work in the block editor.
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 15
- Forks
- 23
- PR merge metrics
- No merged PRs in 30d
Description
Please give us a description of the issue
We have documentation here on how to get Yoast SEO to analyze content inside shortcodes:
https://developer.yoast.com/customization/yoast-seo/filters/shortcodes-filter/
However, this only works in the Classic editor, not on the block editor.
We've received a support request from a user that was trying to use the filter without success.
We should add a comment in the documentation that this filter will only work in the Classic editor.
Additional information:
- https://github.com/Yoast/wordpress-seo/issues/16207
- Slack conversation here.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the shortcode analysis filter documentation page linked in the issue and review its current usage guidance. Add a clear note that the filter works only in the Classic editor, not the block editor; the documentation should explicitly set that expectation for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- wordpress
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100