Documentation

Class: SidebarControl

wp.customize.Widgets. SidebarControl

new SidebarControl()

wp.customize.Widgets.SidebarControl Customizer control for widgets. Note that 'sidebar_widgets' must match the WP_Widget_Area_Customize_Control::$type
Since:
  • 3.9.0
Source:

Extends

Members

defaults :object

Default params.
Type:
  • object
Since:
  • 4.9.0
Inherited From:
Source:

Methods

_applyCardinalOrderClassNames()

Add classes to the widget_form controls to assist with styling
Source:

_setupAddition()

Set up UI for adding a new widget
Source:

_setupModel()

Update ordering of widget control forms when the setting is updated
Source:

_setupSortable()

Allow widgets in sidebar to be re-ordered, and for the order to be previewed
Source:

<private> addNewPage()

Add a new page to a dropdown-pages control reusing menus code for this.
Since:
  • 4.7.0
Inherited From:
Source:
Returns:
Type
void

addWidget(widgetId)

Parameters:
Name Type Description
widgetId string or an id_base for adding a previously non-existing widget.
Source:
Returns:
widget_form control instance, or false on error.
Type
object | false

embed()

Embed the control into the page.
Inherited From:
Source:

expand( [params])

Normal controls do not expand, so just expand its parent
Parameters:
Name Type Argument Description
params Object <optional>
Inherited From:
Source:

getNotificationsContainerElement()

Get the element inside of a control's container that contains the validation error message. Control subclasses may override this to return the proper container to render notifications into. Injects the notification container for existing controls that lack the necessary container, including special handling for nav menu items and widgets.
Since:
  • 4.6.0
Inherited From:
Source:
Returns:
Setting validation message element.
Type
jQuery

getWidgetFormControls()

Get the widget_form Customize controls associated with the current sidebar.
Since:
  • 3.9.0
Source:
Returns:
Type
Array:.<wp.customize.controlConstructor.widget_form:>

linkElements()

Link elements between settings and inputs.
Since:
  • 4.7.0
Inherited From:
Source:
Returns:
Type
void

onChangeActive(active, args)

Update UI in response to a change in the control's active state. This does not change the active state, it merely handles the behavior for when it does change.
Parameters:
Name Type Description
active Boolean
args Object
Properties
Name Type Description
duration Number
completeCallback function
Since:
  • 4.1.0
Inherited From:
Source:

ready()

Set up the control
Overrides:
Source:

renderContent()

Render the control from its JS template, if it exists. The control's container must already exist in the DOM.
Since:
  • 4.1.0
Inherited From:
Source:

renderNotifications()

Render notifications. Renders the `control.notifications` into the control's container. Control subclasses may override this method to do their own handling of rendering notifications.
This:
Since:
  • 4.6.0
Inherited From:
Deprecated:
  • in favor of `control.notifications.render()`
Source:

setupNotifications()

Set up notifications.
Since:
  • 4.9.0
Inherited From:
Source:
Returns:
Type
void

toggle()

Inherited From:
Deprecated:
  • 4.1.0 Use this.onChangeActive() instead.
Source:

toggleReordering(showOrHide)

Enable/disable the reordering UI
Parameters:
Name Type Description
showOrHide Boolean to enable/disable reordering
Source:
To Do:
  • We should have a reordering state instead and rename this to onChangeReordering