Class: Preview

Extends

• wp.customize.Messenger
• wp.customize.Class

Methods

---

add(key, initial, options)

Create a new Value.

Parameters:

Name	Type	Description
key	string	Unique identifier.
initial	mixed	Initial value.
options	mixed	Options hash. Optional.

Inherited From:

• wp.customize.Messenger#add

Source:

• _enqueues/wp/customize/base.js, line 678

Returns:

Class instance of the Value.

Type

Value

---

handleFormSubmit(event)

Handle form submit.

Parameters:

Name	Type	Description
event	jQuery.Event	Event.

Since:

• 4.7.0

Source:

• _enqueues/wp/customize/preview.js, line 193

---

handleLinkClick(event)

Handle link clicks in preview.

Parameters:

Name	Type	Description
event	jQuery.Event	Event.

Since:

• 4.7.0

Source:

• _enqueues/wp/customize/preview.js, line 147

---

initialize(params, options)

Parameters:

Name	Type	Description
params	object	Parameters to configure the messenger.
options	object	Extend any instance parameter or method with this object.

Overrides:

• wp.customize.Messenger#initialize

Source:

• _enqueues/wp/customize/preview.js, line 108

---

receive(event)

Receive data from the other window.

Parameters:

Name	Type	Description
event	jQuery.Event	Event with embedded data.

Inherited From:

• wp.customize.Messenger#receive

Source:

• _enqueues/wp/customize/base.js, line 752

---

send(id, data)

Send data to the other window.

Parameters:

Name	Type	Description
id	string	The event name.
data	object	Data.

Inherited From:

• wp.customize.Messenger#send

Source:

• _enqueues/wp/customize/base.js, line 792