Skip to content

Shortcodes: Honor empty-string replacements in wp.shortcode.replace() - #15347

Open
salvatorecorsi wants to merge 1 commit into
WordPress:trunkfrom
salvatorecorsi:fix/35216-shortcode-empty-replacement
Open

salvatorecorsi wants to merge 1 commit into
WordPress:trunkfrom
salvatorecorsi:fix/35216-shortcode-empty-replacement

Conversation

@salvatorecorsi

Copy link
Copy Markdown

Allow wp.shortcode.replace() callbacks to return an empty string to remove a matched shortcode and its enclosed content. The current truthiness check ignores that result and leaves the original shortcode unchanged.

wp.shortcode.replace( 'foo', 'before [foo]remove me[/foo] after', function() {
    return '';
} );
// Expected: 'before  after'.

The condition now accepts '' while preserving the existing fallback for false, null, undefined, numeric zero and NaN. Escaped shortcodes and unmatched extra brackets retain their existing behavior. This keeps the change focused on the reported case and matches the empty-string handling in Gutenberg's shortcode package.

Trac ticket: https://core.trac.wordpress.org/ticket/35216

Validation

  • The new QUnit coverage fails seven assertions before the fix; the shortcode module passes afterward.
  • Full build, JSHint, scoped JSDoc and JavaScript typecheck pass.
  • Both complete QUnit pages pass in Chromium: 719 assertions in compiled.html and 719 in index.html, using the unchanged upstream Playwright driver.
  • On Windows, the default Grunt QUnit launcher fails with spawn npm EINVAL, independently reproduced without loading this patch. The browser run uses a coordinator-only Playwright config that changes just executablePath to the installed Chromium. No assertions or repository configuration were changed for that adapter.

No PHP code changes are included.

Use of AI Tools

Codex investigated the ticket, authored the change and regression tests, ran the recorded checks and performed a separate automated source review. No separate human review by the account owner has taken place.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

Core Committers: Use this line as a base for the props when committing in SVN:

Props salvatorecorsi.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@github-actions

github-actions Bot commented Nov 2, 2026

Copy link
Copy Markdown

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant