Skip to content

Comments: Allow the Notes @mention chip markup in comment content (kses)#12503

Open
adamsilverstein wants to merge 26 commits into
WordPress:trunkfrom
adamsilverstein:add/notes-mention-kses
Open

Comments: Allow the Notes @mention chip markup in comment content (kses)#12503
adamsilverstein wants to merge 26 commits into
WordPress:trunkfrom
adamsilverstein:add/notes-mention-kses

Conversation

@adamsilverstein

@adamsilverstein adamsilverstein commented Jul 13, 2026

Copy link
Copy Markdown
Member

Backports the mention kses allowance from the Gutenberg Notes @mention work:

The notification layer (from the still-open WordPress/gutenberg#79606) has been split out to #12548 with its own Trac ticket, so this PR can land as soon as it is reviewed without waiting on the upstream notification work.

What

The Notes @ mention completer stores a mention as a non-interactive chip carrying the mentioned user's ID in a class token:

<span class="wp-note-mention user-N">@Name</span>

This PR allows exactly that markup - and nothing more - through comment kses, via two small always-on filters (hooked in default-filters.php):

  • _wp_kses_allow_note_mention_span() (new, private) extends the pre_comment_content allowlist with class on span elements.
  • _wp_kses_sanitize_note_mention_classes() (new, private) runs on pre_comment_content at priority 11 - right after wp_filter_kses - and uses the HTML API (class_list() / remove_class()) to strip every span class token except wp-note-mention and user-N. It bails while wp_filter_kses is not attached, so users with unfiltered_html (filtered through wp_filter_post_kses, where arbitrary classes are already permitted) are never narrowed below what core allows them.

wp_filter_comment() is untouched: no per-comment-type arming or disarming of kses state.

Why

This follows the discussion on this PR and on WordPress/gutenberg#80496:

  • @westonruter's concern about the original approach: allowing an open-ended class on note links is a live CSS/JS selector surface in the admin. His data-attribute suggestion turned out to need a kses allowance anyway (data-* is not allowed by default in the comment context), and per @Mamaduka's review, an anchor-based mention breaks in the Link format UI regardless of how the ID is carried - mentions aren't links, they're tokens rendered as chips.
  • The resolution keeps the class (it doubles as the rich-text format-differentiation and styling hook) but closes the open-class hole a different way: the allowance is unconditional yet reduced to exactly two inert tokens on a semantics-free element, so there is nothing left to scope per comment type and the stateful arm/disarm machinery disappears.

Behavior change: all commenters (including anonymous ones) can persist <span> elements whose class is limited to wp-note-mention and/or user-N. This is inert - the tokens are not styling or scripting hooks outside the notes sidebar, and mention notification parsing (#12548) only processes note-type comments.

Testing

Unit tests in tests/phpunit/tests/kses.php:

  • test_wp_kses_allowed_html_pre_comment_content_allows_only_the_mention_span verifies the context gains the span allowance and nothing else beyond the stock $allowedtags.
  • test_note_mention_markup_survives_note_content_sanitization / test_note_mention_markup_survives_regular_comment_content_sanitization verify the chip survives for both comment types.
  • test_note_mention_span_classes_are_reduced_to_the_mention_tokens verifies junk class tokens are stripped.
  • test_note_mention_class_attribute_removed_when_no_tokens_remain verifies the class attribute is dropped entirely when no valid tokens remain.
  • test_note_mention_allows_only_class_on_mention_spans verifies every other span attribute (onclick, style, data-*, id) is still stripped.
  • test_class_is_still_stripped_from_links_in_comment_content verifies links keep the default sanitization.
  • test_note_mention_class_reduction_skipped_when_restrictive_kses_is_inactive verifies the reduction never narrows unfiltered_html users.
npm run test:php -- tests/phpunit/tests/kses.php

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


Proposed commit message

Comments: Allow the Notes @mention chip markup in comment content.

The Notes @mention completer stores a mention as a non-interactive chip,
`<span class="wp-note-mention user-N">@Name</span>`, the `user-N` class
token carrying the mentioned user's ID. The default comment kses allowlist
does not permit `span`, so for users without the `unfiltered_html`
capability the mention markup is stripped when the note is saved.

Allow `span` with `class` in the comment kses context, and reduce span
classes to the two mention tokens in a companion `pre_comment_content`
pass running right after kses, so the allowance stays inert: no other
element, attribute, or class token is newly available to commenters.

See related Gutenberg pull requests: https://github.com/WordPress/gutenberg/pull/79604 and https://github.com/WordPress/gutenberg/pull/80528.

Props mamaduka, westonruter.
Fixes #65622.

The notes @-mention completer stores a mention as
`<a class="wp-note-mention" data-user-id="N" href="...">@name</a>`.
The default comment kses allowlist only keeps `href` and `title` on
links, so for users without `unfiltered_html` the attributes that make
a mention a mention (the chip class and the mentioned user's ID) are
stripped on save.

Add a 'pre_comment_content' context to wp_kses_allowed_html() that
allows `class` and `data-user-id` on links so saved mentions survive
sanitization. Both attributes are inert markup.

Backports the PHP changes from the Gutenberg mentions PR:
WordPress/gutenberg#79604
@github-actions

github-actions Bot commented Jul 13, 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. 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 adamsilverstein, westonruter, wildworks, mamaduka.

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

@github-actions

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.

Comment thread src/wp-includes/kses.php Outdated
Allowing class and data-user-id on links in the pre_comment_content
context loosened sanitization for every comment, including anonymous
front-end comments. Both attributes are CSS/JS selector hooks, so that
would let any commenter publish links styled by theme classes or
reachable by delegated script handlers.

Attach the extended allowlist in wp_filter_comment() only while a note
comment's content is being filtered instead. Notes can only be written
by logged-in users who can edit the post and never render on the front
end, and the sanitization of regular comments is unchanged.
Design review on the Gutenberg side changed the stored mention from a
link to a plain span, since a mention marks a person rather than
offering navigation. Allow span.class and span.data-user-id instead of
the link attributes; the allowance is still attached only while a note
comment is filtered.
… attribute

The notes mention completer now stores a mention as
`<span class="wp-note-mention user-N">@name</span>`, so the kses
allowance for note comments shrinks to the single `class` attribute
and no longer needs `data-user-id`. Add a test asserting that any
other attribute is still stripped from note spans.

Trac ticket: https://core.trac.wordpress.org/ticket/65622
@adamsilverstein
adamsilverstein force-pushed the add/notes-mention-kses branch from 1fc1250 to f74c68b Compare July 13, 2026 18:26
Mentions are now inserted as links to the mentioned user's author page
- <a class="wp-note-mention user-N" href="..."> - instead of spans, so
the note allowance moves from span.class to a.class. Note content now
also picks up wp_rel_ugc()'s rel="nofollow ugc" like any other comment
link, which the tests cover with a deterministic external href.
@adamsilverstein adamsilverstein self-assigned this Jul 14, 2026
@adamsilverstein adamsilverstein added the Gutenberg Sync Pull requests syncing changes from WordPress/Gutenberg. label Jul 14, 2026
@adamsilverstein
adamsilverstein requested a review from t-hamano July 14, 2026 15:51
@adamsilverstein adamsilverstein changed the title Comments: allow note mention attributes in comment content Comments: Support Notes @mentions: kses allowance and notifications Jul 14, 2026
@Mamaduka

Copy link
Copy Markdown
Member

Sorry, only have time for a surface review.

  • Not sure if we need new methods like wp_get_note_thread_root_id. Values can be easily derived.
  • The follower notifications seem like work for a separate PR. I don't think it should be in scope for mention notifications.

I think the general API for managing email (or other) notifications would be better for the project than handling each case individually.

@adamsilverstein
adamsilverstein force-pushed the add/notes-mention-kses branch from dc57c7f to e31873f Compare July 15, 2026 20:23
@adamsilverstein adamsilverstein changed the title Comments: Support Notes @mentions: kses allowance and notifications Comments: Allow Notes @mention attributes in comment content (kses) Jul 15, 2026
@adamsilverstein

Copy link
Copy Markdown
Member Author

Sorry, only have time for a surface review.

  • Not sure if we need new methods like wp_get_note_thread_root_id. Values can be easily derived.
  • The follower notifications seem like work for a separate PR. I don't think it should be in scope for mention notifications.

I think the general API for managing email (or other) notifications would be better for the project than handling each case individually.

Reducing this to the kses only changes which matches the merged PRs. Opening a follow up for the notifications part to dig deeper.

@adamsilverstein

Copy link
Copy Markdown
Member Author

Follow up: #12548

Comment thread src/wp-includes/kses.php Outdated
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 21, 2026 16:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

src/wp-includes/kses.php:1207

  • The early bailout str_contains( $unslashed, '<span' ) is case-sensitive. A commenter could use <SPAN class="..."> so this function returns early and never strips class tokens, leaving an open-ended class attribute on spans (since class is now allowed through KSES). Removing this check avoids the bypass and matches the intended “always reduce span classes” behavior.
	$unslashed = wp_unslash( $content );

	if ( ! str_contains( $unslashed, '<span' ) ) {
		return $content;
	}

…tion

An uppercase <SPAN> survives kses with its casing preserved, so the
str_contains( ..., '<span' ) early return skipped the class reduction
entirely for such tags. Run the tag processor unconditionally and cover
the uppercase case with a test.
Copilot AI review requested due to automatic review settings July 21, 2026 21:53

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread src/wp-includes/kses.php Outdated
Copilot AI review requested due to automatic review settings July 21, 2026 23:22

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread src/wp-includes/kses.php
Copilot AI review requested due to automatic review settings July 22, 2026 00:31

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Copilot AI review requested due to automatic review settings July 22, 2026 01:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

Comment thread src/wp-includes/kses.php Outdated
Comment on lines +1152 to +1153
* @param array<string, array<string, bool>> $allowed The allowed tags structure for the context.
* @param string|array<string, array<string, bool>> $context The kses context.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot This contradicts with what you previously said in #12503 (comment)

It seems here you are right. Updated in 1bef13b

Copilot AI review requested due to automatic review settings July 22, 2026 02:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

src/wp-includes/kses.php:1154

  • The phpdoc types for _wp_kses_allow_note_mention_span() don’t match what the wp_kses_allowed_html filter can actually pass. $allowed is not always an “allowed tags structure” (e.g. for the entities context it’s an array of entity-name strings), and $context is documented as possibly being an array even though wp_kses_allowed_html() normalizes array contexts to the string 'explicit' before applying the filter. This can mislead static analysis and future maintainers.

Consider loosening these annotations to match the filter contract (array + string).

 * @param array<string, array<string, bool>>        $allowed The allowed tags structure for the context.
 * @param string|array<string, array<string, bool>> $context The kses context.
 * @return array<string, array<string, bool>> Modified allowed tags structure.

Copilot AI review requested due to automatic review settings July 22, 2026 03:21

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 3 out of 3 changed files in this pull request and generated no new comments.

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

Labels

Gutenberg Sync Pull requests syncing changes from WordPress/Gutenberg.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants