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

Allow UTF-8 Encodings for SVGs in add_menu_page #8304

Open
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

sahil-gidwani
Copy link

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

Allow Additional Encodings for SVGs in add_menu_page

This PR improves the handling of SVGs in add_menu_page by allowing additional encoding formats beyond Base64. Previously, the function only checked for data:image/svg+xml;base64,, but SVGs don’t need to be Base64-encoded. This update introduces support for data:image/svg+xml;utf8, encoding and provides a more flexible approach to validating and sanitizing SVGs.

Changes Introduced

  • Extended Encoding Support:

    • Added support for data:image/svg+xml;utf8, SVG encoding.
    • Ensures proper sanitization and rendering of inline SVGs.
  • Enhanced SVG Sanitization:

    • Created a more comprehensive list of allowed SVG attributes and elements, including common tags like <g>, <path>, <circle>, <text>, and gradients.
    • Uses wp_kses_allowed_html( 'post' ) as the base and extends it with the new SVG attributes.
  • Improved Rendering & Styling:

    • Introduced a wrapper <div class="inline-svg-container"> to encapsulate the inline SVGs.
    • Added CSS styles to ensure proper scaling and display inside the WordPress admin menu.

Why This Change?

  • More Efficient & Flexible SVG Handling:

    • Avoids unnecessary Base64 encoding, which increases the file size and reduces readability.
    • Ensures WordPress menus can support different encoding methods for SVGs.
  • Security & Compatibility:

    • The SVG sanitization method (wp_kses) ensures safe and controlled rendering of inline SVGs.
    • Maintains backward compatibility while expanding support for other encoding types.

Potential Impact & Compatibility

  • No breaking changes—existing Base64-encoded SVGs will continue to work.
  • Enhances compatibility for developers using inline SVGs in WordPress menus.

…coded data URIs and add CSS styles for inline SVG containers.
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