Documentation

Class: HeaderControl

wp.customize. HeaderControl

new HeaderControl()

Source:

Extends

Members

defaults :object

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

Methods

<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

calculateImageSelectOptions(attachment, controller)

Returns a set of options, computed from the attached image data and theme-specific data, to be fed to the imgAreaSelect plugin in wp.media.view.Cropper.
Parameters:
Name Type Description
attachment wp.media.model.Attachment
controller wp.media.controller.Cropper
Source:
Returns:
Options
Type
Object

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:

getInitialHeaderImage()

Returns a new instance of api.HeaderTool.ImageModel based on the currently saved header image (if any).
Since:
  • 4.2.0
Source:
Returns:
Options
Type
Object

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

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:

onCropped(croppedImage)

After the image has been cropped, apply the cropped image data to the setting.
Parameters:
Name Type Description
croppedImage object Cropped attachment data.
Source:

onSelect()

After an image is selected in the media modal, switch to the cropper state.
Source:

onSkippedCrop(selection)

If cropping was skipped, apply the image data directly to the setting.
Parameters:
Name Type Description
selection object
Source:

openMedia(event)

Sets up and opens the Media Manager in order to select an image. Depending on both the size of the image and the properties of the current theme, a cropping step after selection may be required or skippable.
Parameters:
Name Type Description
event event
Source:

ready()

Triggered when the control's markup has been injected into the DOM.
Inherited From:
Overrides:
Source:
Returns:
Type
void

removeImage()

Triggers the necessary events to deselect an image which was set as the currently selected one.
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:

setImageFromURL(url, attachmentId, width, height)

Creates a new wp.customize.HeaderTool.ImageModel from provided header image data and inserts it into the user-uploaded headers collection.
Parameters:
Name Type Description
url String
attachmentId Number
width Number
height Number
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: