WordPress.org

The Editor’s UI Data Edit

Selectors Selectors

getEditorMode getEditorMode

Returns the current editing mode.

Parameters

  • state: Global application state.

Top ↑

isEditorSidebarOpened isEditorSidebarOpened

Returns true if the editor sidebar is opened.

Parameters

  • state: Global application state

Returns

Whether the editor sidebar is opened.

Top ↑

isPluginSidebarOpened isPluginSidebarOpened

Returns true if the plugin sidebar is opened.

Parameters

  • state: Global application state

Returns

Whether the plugin sidebar is opened.

Top ↑

getActiveGeneralSidebarName getActiveGeneralSidebarName

Returns the current active general sidebar name, or null if there is no
general sidebar active. The active general sidebar is a unique name to
identify either an editor or plugin sidebar.

Examples:

  • edit-post/document
  • my-plugin/insert-image-sidebar

Parameters

  • state: Global application state.

Returns

Active general sidebar name.

Top ↑

getPreferences getPreferences

Returns the preferences (these preferences are persisted locally).

Parameters

  • state: Global application state.

Returns

Preferences Object.

Top ↑

getPreference getPreference

Parameters

  • state: Global application state.
  • preferenceKey: Preference Key.
  • defaultValue: Default Value.

Returns

Preference Value.

Top ↑

isPublishSidebarOpened isPublishSidebarOpened

Returns true if the publish sidebar is opened.

Parameters

  • state: Global application state

Returns

Whether the publish sidebar is open.

Top ↑

isEditorSidebarPanelOpened isEditorSidebarPanelOpened

Returns true if the editor sidebar panel is open, or false otherwise.

Parameters

  • state: Global application state.
  • panel: Sidebar panel name.

Returns

Whether the sidebar panel is open.

Top ↑

isModalActive isModalActive

Returns true if a modal is active, or false otherwise.

Parameters

  • state: Global application state.
  • modalName: A string that uniquely identifies the modal.

Returns

Whether the modal is active.

Top ↑

isFeatureActive isFeatureActive

Returns whether the given feature is enabled or not.

Parameters

  • state: Global application state.
  • feature: Feature slug.

Returns

Is active.

Top ↑

isPluginItemPinned isPluginItemPinned

Returns true if the plugin item is pinned to the header.
When the value is not set it defaults to true.

Parameters

  • state: Global application state.
  • pluginName: Plugin item name.

Returns

Whether the plugin item is pinned.

Top ↑

getMetaBoxes getMetaBoxes

Returns the state of legacy meta boxes.

Parameters

  • state: Global application state.

Returns

State of meta boxes.

Top ↑

getMetaBox getMetaBox

Returns the state of legacy meta boxes.

Parameters

  • state: Global application state.
  • location: Location of the meta box.

Returns

State of meta box at specified location.

Top ↑

hasMetaBoxes hasMetaBoxes

Returns true if the post is using Meta Boxes

Parameters

  • state: Global application state

Returns

Whether there are metaboxes or not.

Top ↑

isSavingMetaBoxes isSavingMetaBoxes

Returns true if the Meta Boxes are being saved.

Parameters

  • state: Global application state.

Returns

Whether the metaboxes are being saved.

Top ↑

Actions Actions

Top ↑

openGeneralSidebar openGeneralSidebar

Returns an action object used in signalling that the user opened an editor sidebar.

Parameters

  • name: Sidebar name to be opened.

Top ↑

closeGeneralSidebar closeGeneralSidebar

Returns an action object signalling that the user closed the sidebar.

Top ↑

openModal openModal

Returns an action object used in signalling that the user opened an editor sidebar.

Parameters

  • name: A string that uniquely identifies the modal.

Top ↑

closeModal closeModal

Returns an action object signalling that the user closed the sidebar.

Top ↑

openPublishSidebar openPublishSidebar

Returns an action object used in signalling that the user opened the publish
sidebar.

Top ↑

closePublishSidebar closePublishSidebar

Returns an action object used in signalling that the user closed the
publish sidebar.

Top ↑

togglePublishSidebar togglePublishSidebar

Returns an action object used in signalling that the user toggles the publish sidebar.

Top ↑

toggleGeneralSidebarEditorPanel toggleGeneralSidebarEditorPanel

Returns an action object used in signalling that use toggled a panel in the editor.

Parameters

  • panel: The panel to toggle.

Top ↑

toggleFeature toggleFeature

Returns an action object used to toggle a feature flag.

Parameters

  • feature: Feature name.

Top ↑

togglePinnedPluginItem togglePinnedPluginItem

Returns an action object used to toggle a plugin name flag.

Parameters

  • pluginName: Plugin name.

Top ↑

initializeMetaBoxState initializeMetaBoxState

Returns an action object used to check the state of meta boxes at a location.

This should only be fired once to initialize meta box state. If a meta box
area is empty, this will set the store state to indicate that React should
not render the meta box area.

Example: metaBoxes = { side: true, normal: false }.

This indicates that the sidebar has a meta box but the normal area does not.

Parameters

  • metaBoxes: Whether meta box locations are active.

Top ↑

requestMetaBoxUpdates requestMetaBoxUpdates

Returns an action object used to request meta box update.

Top ↑

metaBoxUpdatesSuccess metaBoxUpdatesSuccess

Returns an action object used signal a successful meta box update.

Top ↑

setMetaBoxSavedData setMetaBoxSavedData

Returns an action object used to set the saved meta boxes data.
This is used to check if the meta boxes have been touched when leaving the editor.

Parameters

  • dataPerLocation: Meta Boxes Data per location.
Skip to toolbar