Documentation

Global

Members

ajaxWidgets :Array.<string>

These widgets can be populated via ajax.
Type:
  • Array.<string>
Since:
  • 2.7.0
Source:

Global

Initializes the custom header selection page.
Since:
  • 3.5.0
Deprecated:
  • 4.1.0 The page this is used on is never linked to from the UI. Setting a custom header is completely handled by the Customizer.
Source:

passwordStrength :wp.passwordStrength.meter

Password strength meter function.
Type:
Since:
  • 2.5.0
Deprecated:
  • 3.7.0 Use wp.passwordStrength.meter instead.
Source:

Methods

ajaxPopulateWidgets(el)

Triggers widget updates via AJAX.
Parameters:
Name Type Description
el string Optional. Widget to fetch or none to update all.
Since:
  • 2.7.0
Source:
Returns:
Type
void

edAddTag()

Back-compat Define all former global functions so plugins that hack quicktags.js directly don't cause fatal errors.
Source:

edButton()

Adds a button to all instances of the editor Added for back compatibility, use QTags.addButton() as it gives more flexibility like type of button, button placement, etc.
Source:
See:
  • QTags.addButton()

edInsertContent()

Inserts content at the caret in the active editor (textarea) Added for back compatibility
Source:
See:
  • QTags.insertContent()
Handle the editing of the post_name. Create the required HTML elements and update the changes via AJAX.
Source:
Returns:
void

out()

Closes the submenu when no longer hovering the menu item.
Source:
Returns:
Type
void

over()

Opens the submenu when hovered over the menu item for desktops.
Source:
Returns:
Type
void

quickPressLoad()

Control the Quick Press (Quick Draft) widget.
Since:
  • 2.7.0
Source:
Returns:
Type
void

quicktags()

Initialize new instance of the Quicktags editor
Source:

send_to_editor(html)

Sends the HTML passed in the parameters to TinyMCE.
Parameters:
Name Type Description
html string The HTML to be sent to the editor.
Since:
  • 2.5.0
Source:
Returns:
Returns false when both TinyMCE and QTags instances are unavailable. This means that the HTML was not sent to the editor.
Type
void | boolean

tb_position()

Recalculates and applies the new ThickBox position based on the current window size.
Since:
  • 2.6.0
Source:
Returns:
Array containing jQuery objects for all the found ThickBox anchors.
Type
Array.<Object>

WPRemoveThumbnail(nonce)

Remove the Featured Image
Parameters:
Name Type Description
nonce string Nonce to use in the request.
Source:

WPSetThumbnailHTML(html)

Overwrite the content of the Featured Image postbox
Parameters:
Name Type Description
html string New HTML to be displayed in the content area of the postbox.
Source:

WPSetThumbnailID(id)

Set the Image ID of the Featured Image
Parameters:
Name Type Description
id int The post_id of the image to use as Featured Image.
Source:

wptitlehint(id)

Adds screen reader text to the title prompt when needed.
Parameters:
Name Type Description
id string Optional. HTML ID to add the screen reader helper text to.
Source:
Returns:
void