WordPress.org

Make WordPress Core

Opened 7 days ago

Last modified 108 minutes ago

#41876 new enhancement

Add inline help to Custom HTML widget

Reported by: westonruter Owned by:
Milestone: 4.9 Priority: high
Severity: normal Version:
Component: Widgets Keywords: needs-patch
Focuses: accessibility Cc:

Description

There is no inline help in the Custom HTML widget for how to interact with the code editor. While the widget will add this to the help text on the widgets admin screen, this is not easily discoverable. Additionally, this help tab text is not displayed in the Customizer at all. Just like the Additional CSS section description in the Customizer, there could be a (?) icon in the widget, and once expanded it could reveal the same help text to guide usage of the widget. I suggest the icon could be placed in the top-right corner of the widget with the help text then appearing at the top when expanded, similar to the Customizer section description.

See also:

Builds off of [41376] for #12423.

Change History (4)

This ticket was mentioned in Slack in #core-customize by westonruter. View the logs.


7 days ago

#2 @westonruter
7 days ago

As suggested by @afercia, this can be generalized so that when you construct WP_Widget there can be an optional help parameter for control_options which, when supplied, would automatically be inserted into the widget control. In that way it wouldn't be something ad hoc for the Custom HTML widget alone but could be re-used by other widgets. I am not aware of other widgets that need help text, however.

#3 @afercia
7 days ago

Custom widgets :)

#4 @westonruter
108 minutes ago

  • Priority changed from normal to high

Bumping priority to high for visibility and alignment with 4.9 goals, and given proximity to beta 1 deadline.

Note: See TracTickets for help on using tickets.