Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: Correct Parsing of Final Shortcode Attribute Without Trailing Space #8533

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from

Conversation

sahil-gidwani
Copy link

Trac Ticket: https://core.trac.wordpress.org/ticket/57790

Fix: Correct Parsing of Final Shortcode Attribute Without Trailing Space

Issue Summary

The shortcode_parse_atts() function, which uses get_shortcode_atts_regex(), fails to correctly parse the last attribute of a shortcode when there is no space between the final attribute’s closing quote and the closing bracket ].

Steps to Reproduce

Current Behavior (Bug)
shortcode_parse_atts('[shortcode-name category="banana-stand" money="yes"]'); // No space

Output:

Array(
    [0] => [shortcode-name
    [category] => banana-stand
    [1] => money="yes"]
)

The last attribute (money="yes") is incorrectly treated as a separate entry instead of being parsed as a key-value pair.

Expected Behavior

When a space is included before the closing ], the function behaves correctly:

shortcode_parse_atts('[shortcode-name category="banana-stand" money="yes" ]'); // Has space

Output:

Array(
    [0] => [shortcode-name
    [category] => banana-stand
    [money] => yes
    [1] => ]
)

Root Cause

The issue stems from the get_shortcode_atts_regex() pattern, where the final attribute pair is not properly matched if there is no space before ]. The previous regex enforced a space (\s) or end-of-string ($) after an attribute, causing the last attribute to be misinterpreted.

Proposed Fix

The updated regex removes unnecessary lookaheads and ensures correct parsing regardless of whether a space exists before ].

Old Code:
return '/([\w-]+)\s*=\s*"([^"]*)"(?:\s|$)|([\w-]+)\s*=\s*\'([^\']*)\'(?:\s|$)|([\w-]+)\s*=\s*([^\s\'"]+)(?:\s|$)|"([^"]*)"(?:\s|$)|\'([^\']*)\'(?:\s|$)|(\S+)(?:\s|$)/';
New Code:
return '/([\w-]+)\s*=\s*"([^"]*)"|([\w-]+)\s*=\s*\'([^\']*)\'|([\w-]+)\s*=\s*([^\s\'"\]]+)|"([^"]*)"|\'([^\']*)\'|(\S+)/';

Test Results

After applying the fix, both cases now produce the expected output:

Array(
    [0] => [shortcode-name
    [category] => banana-stand
    [money] => yes
    [1] => ]
)

Ensuring that the last attribute is parsed correctly, regardless of spacing.

Impact & Compatibility

  • This fix improves accuracy without affecting existing correctly formatted shortcodes.
  • Fully backward-compatible with previous WordPress versions.
  • Ensures shortcode_parse_atts() is more robust when handling shortcode attributes.

Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

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

Props sahilgidwani.

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

Copy link

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

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • 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