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.

Sign up for GitHub

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

Jump to bottom

Widgets: Allow HTML tags in description #33814

Merged
merged 5 commits into from
Aug 9, 2021
Merged

Widgets: Allow HTML tags in description #33814

merged 5 commits into from
Aug 9, 2021

Conversation

walbo
Copy link
Member

@walbo walbo commented Aug 2, 2021

Description

Fixes #33106

How has this been tested?

  1. Registered a widget area as shown below.
register_sidebar([
    'name'          => 'Test Area',
    'id'            => 'test-area',
    'description'   => 'Widget description <b>test</b>. (<a href="#">Help link</a>)',
]);
  1. Check the description of the area.

Screenshots

Before After
Skjermbilde 2021-08-02 kl 13 32 32 Skjermbilde 2021-08-02 kl 13 30 55

Types of changes

Bug fix

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • I've tested my changes with keyboard and screen readers.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

@Mamaduka Mamaduka added [Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Bug An existing feature does not function as intended labels Aug 2, 2021
Use dangerouslySetInnerHTML
1872b10 
Avoid `<div />` inside the `<p />` tag
kevin940726
kevin940726 approved these changes Aug 3, 2021
View reviewed changes
Copy link
Member

@kevin940726 kevin940726 left a comment

Choose a reason for hiding this comment

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

Looks good! As long as we can be sure that the description is always sanitized.

packages/edit-widgets/src/components/sidebar/widget-areas.js Outdated Show resolved Hide resolved
@kevin940726 kevin940726 added this to the WordPress 5.8.1 milestone Aug 5, 2021
@Mamaduka Mamaduka merged commit 07051aa into WordPress:trunk Aug 9, 2021
@Mamaduka
Copy link
Member

Mamaduka commented Aug 9, 2021

Thanks for working on this, @walbo.

@walbo walbo deleted the fix/widgets-html-descriptions branch August 9, 2021 15:37
desrosj pushed a commit that referenced this pull request Aug 30, 2021
@desrosj
Widgets: Allow HTML tags in description (#33814)
bdaa7b6 
* Widgets: Allow HTML tags in description

* Use `dangerouslySetInnerHTML`

Avoid `<div />` inside the `<p />` tag

* Describe by dangerouslySetInnerHTML is used

* Use safeHTML

* Update comment
@desrosj desrosj mentioned this pull request Aug 30, 2021
Merged
7 tasks
desrosj added a commit that referenced this pull request Sep 1, 2021
@desrosj @nosolosw
@juanmaguitar @gziolo @jblz @ribaricplusplus @ellatrix @Mamaduka @talldan @torounit @kevin940726 @mkaz @noisysocks @anton-vlasenko
WordPress 5.8.1 backports (#34393)
70f5aaa 
* Fix API docs generation (#33384)

* Docs: use markdown headings instead of links for API declarations (#33381)

* Docs: Run Prettier after updating API in documentation (#33498)

(cherry picked from commit 626f233)

* Use tabs instead of spaces in block transform doc example (#33549)

(cherry picked from commit 8afca1e)

* Fix metabox reordering (#30617).

* Block editor: don't render layout and duotone styles in between blocks (#32083)

* Widgets: Allow HTML tags in description (#33814)

* Widgets: Allow HTML tags in description

* Use `dangerouslySetInnerHTML`

Avoid `<div />` inside the `<p />` tag

* Describe by dangerouslySetInnerHTML is used

* Use safeHTML

* Update comment

* Editor: Set 'hide_empty' for the most used terms query (#33457)

Don't include terms that aren't assigned to any posts as "most used" terms.

* Update widget editor help links to point to the new support article (#33482)

* If select-all fires in .editor-post-title__input, end the process.. (#33621)

* Writing flow: select all: remove early return for post title (#33699)

* Call onChangeSectionExpanded conditionally (#33618)

* FontSizePicker: Use number values when the initial value is a number (#33679)

* FontSizePicker: Don't use units if the value is a number
* Add unit tests
* Disable units when we have number values

* Fix justification for button block when selected (#33739)

* Remove margin setting, auto right conflict with justify buttons

* Per review, add little margin back

* Add error boundaries to widget screens (#33771)

* Add error boundary to edit widgets screen

* Add error boundary to customize widgets

* Refactor sidebar controls provider to application level so that its state is not lost when re-initializing

* Revert "Refactor sidebar controls provider to application level so that its state is not lost when re-initializing"

This reverts commit 7d607ff.

* Remove rebootability from customize widgets

* Remove debug code

* Fix insertion point in Widgets editors (#33802)

* Default batch processor: Respect the batch endpoint's maxItems (#34280)

This updates the default batch processor to make multiple batch requests
if the number of requests to process exceeds the number of requests that
the batch endpoint can handle.

We determine the number of requests that the batch endpoint can handle
by making a preflight OPTIONS request to /batch/v1. By default it is 25
requests.

See https://make.wordpress.org/core/2020/11/20/rest-api-batch-framework-in-wordpress-5-6/.

* Fix button block focus trap after a URL has been added (#34314)

* Rework button block link UI to match RichText format implementation

* Refine some more, determine visibility by selection and url state

* Add e2e test

* Also focus rich text when unlinking using a keyboard shortcut

* Text for dropdown fields within legacy widgets in the Customizer is off centered (#34076)

* Fix ESLint errors reported

* Regenerate autogenerated docs

* Update the `INSERTER_SEARCH_SELECTOR` path.

This is a partial cherry pick of 2356b2d in order to fix the performance tests.

Co-authored-by: André <[email protected]>
Co-authored-by: JuanMa <[email protected]>
Co-authored-by: Greg Ziółkowski <[email protected]>
Co-authored-by: Jeff Bowen <[email protected]>
Co-authored-by: Bruno Ribarić <[email protected]>
Co-authored-by: Ella van Durpe <[email protected]>
Co-authored-by: Petter Walbø Johnsgård <[email protected]>
Co-authored-by: George Mamadashvili <[email protected]>
Co-authored-by: Daniel Richards <[email protected]>
Co-authored-by: Hiroshi Urabe <[email protected]>
Co-authored-by: Kai Hao <[email protected]>
Co-authored-by: Marcus Kazmierczak <[email protected]>
Co-authored-by: Robert Anderson <[email protected]>
Co-authored-by: Anton Vlasenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kevin940726 kevin940726 kevin940726 approved these changes

@adamziel adamziel Awaiting requested review from adamziel adamziel is a code owner

@draganescu draganescu Awaiting requested review from draganescu draganescu is a code owner

@noisysocks noisysocks Awaiting requested review from noisysocks

@talldan talldan Awaiting requested review from talldan

@tellthemachines tellthemachines Awaiting requested review from tellthemachines

Assignees
No one assigned
Labels
[Feature] Widgets Screen The block-based screen that replaced widgets.php. [Type] Bug An existing feature does not function as intended
Projects
None yet
Milestone
WordPress 5.8.1
Development

Successfully merging this pull request may close these issues.

HTML tags in the description of the widget area are escaped
4 participants
@walbo @Mamaduka @talldan @kevin940726