Skip to content

Editor: Prevent wp.editor.autop() from doubling <br> tags inside captions - #14837

Open
robelsust wants to merge 1 commit into
WordPress:trunkfrom
robelsust:fix/66373-editor-autop-caption-doubles-br
Open

robelsust wants to merge 1 commit into
WordPress:trunkfrom
robelsust:fix/66373-editor-autop-caption-doubles-br

Conversation

@robelsust

Copy link
Copy Markdown

Description

Addresses Trac ticket #66373.

In wp.editor.autop() (src/js/_enqueues/wp/editor/base.js), <br /> tags followed by a newline (such as <br />\n or <br>\n) inside [caption] shortcodes were being converted into <br /><br />.

Root Cause

  1. In wp.editor.autop(), <br> tags inside captions are temporarily converted to <wp-temp-br> to protect them from standard paragraph splitting:
    a = a.replace( /<br([^>]*)>/g, '<wp-temp-br$1>' );
  2. Any newlines following those tags were retained.
  3. Later in caption handling, all newlines were unconditionally converted to <wp-temp-br />:
    return a.replace( /\s*\n\s*/g, '<wp-temp-br />' );
  4. As a result, <br />\n produced two adjacent <wp-temp-br /> tags (<wp-temp-br /><wp-temp-br />), which restored to <br /><br />. Each switch between the Visual and Text editor tabs doubled the number of <br> tags inside image captions.

Solution

Drop whitespace and newlines immediately following <wp-temp-br> tags before converting remaining standalone newlines into temporary breaks:

a = a.replace( /(<wp-temp-br[^>]*>)\s*\n\s*/g, '$1' );

Testing

  • Added unit tests in tests/qunit/wp-admin/js/editor.js covering:
    • <br />\n and <br>\n inside captions.
    • Windows newlines (\r\n).
    • Attributes on <br> tags inside captions.
    • Standalone newlines without <br>.
    • Multiple lines with breaks inside captions.
    • Stability across repeated wp.editor.autop() and wp.editor.removep() editor toggle cycles.
  • Enqueued editor.js and tests in tests/qunit/index.html.
  • Verified all 712 QUnit tests pass in both index.html and compiled.html.
  • Verified ESLint passes with 0 errors.

Props: @therssoftware, @yumiko.m
Fixes #66373.

…ions.

In wp.editor.autop(), drop newlines immediately following protected <wp-temp-br> tags within [caption] shortcodes so line breaks are preserved accurately without duplicating upon switching editor tabs.

Props therssoftware, yumiko.m.
Fixes #66373.
@github-actions

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 therssoftware.

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

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