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

HTML API: Consistent case sensitive handling of class names #6931

Conversation

sirreal
Copy link
Member

@sirreal sirreal commented Jun 28, 2024

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

The Tag Processor CSS class name methods class_list, add_class, and remove_class should be consistent regarding case sensitivity.

These methods are intended to align with CSS class names, meaning that matching should be done ASCII case-insensitive. class_list already yields lower case unique class names, but remove_class and add_class do not have similar behavior of treating case-insensitive matching classes as equal.

  • add_class should only add classes that are not already present (compared ASCII case-insensitive).
  • remove_class should remove all matching classes (compared ASCII case-insensitive).

This was discussed with @dmsnell on Slack here: https://wordpress.slack.com/archives/C05NFB818PQ/p1719403633636769
Related to #61520 which documents the lower-casing behavior of class_list.


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.

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.

@sirreal sirreal marked this pull request as ready for review June 28, 2024 13:04
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 jonsurrell.

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

Comment on lines +682 to +689
* 'wp-block-group' => [ WP_HTML_Tag_Processor::ADD_CLASS, 'wp-block-group'],
* 'wp-group' => [ WP_HTML_Tag_Processor::REMOVE_CLASS ],
* );
*
* @since 6.2.0
* @var bool[]
* @since 6.7.0 Changed the structure of values to an array
*
* @var array[]
Copy link
Member Author

@sirreal sirreal Jun 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to be able to match the class_name case insensitively, but still add whatever class was provided.

I changed the values to be an array of one of the following shapes:

  • [ self::ADD_CLASS, (string) $class_to_add ]
  • [ self::REMOVE_CLASS ]
  • [ self::SKIP_CLASS ]
@sirreal
Copy link
Member Author

sirreal commented Jun 28, 2024

This doesn't seem like the right approach, it may not align with browser behavior.

@sirreal sirreal closed this Jun 28, 2024
@sirreal sirreal deleted the html-api/class-name-consistent-case-handling branch June 28, 2024 19:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
1 participant