[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/ -> editor.js (summary)

(no description)

File Size: 13275 lines (490 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 289 functions

  __webpack_require__()
  getDefault()
  getModuleExports()
  _iterableToArrayLimit()
  _slicedToArray()
  _objectWithoutProperties()
  ownKeys()
  _objectSpread()
  Icon()
  emptyFunction()
  emptyFunctionWithReset()
  shim()
  getShim()
  _assertThisInitialized()
  _arrayWithoutHoles()
  _nonIterableSpread()
  _toConsumableArray()
  __()
  TextareaAutosize()
  assign()
  init()
  changeOverflow()
  getParentOverflows()
  resize()
  update()
  destroy()
  update()
  lineHeight()
  _getPrototypeOf()
  _classCallCheck()
  _defineProperties()
  _createClass()
  _setPrototypeOf()
  _inherits()
  _possibleConstructorReturn()
  _arrayLikeToArray()
  _unsupportedIterableToArray()
  _iterableToArray()
  _arrayWithHoles()
  _nonIterableRest()
  _typeof()
  _objectWithoutPropertiesLoose()
  _objectWithoutProperties()
  optimist()
  beginReducer()
  commitReducer()
  revertReducer()
  baseReducer()
  matchesTransaction()
  validateState()
  separateState()
  asyncGeneratorStep()
  _asyncToGenerator()
  _next()
  _throw()
  ownKeys()
  _objectSpread()
  reducer_ownKeys()
  reducer_objectSpread()
  getPostRawValue()
  hasSameKeys()
  isUpdatingSamePostProperty()
  shouldOverwriteState()
  reducer_postId()
  reducer_postType()
  reducer_template()
  preferences()
  saving()
  postLock()
  postSavingLock()
  postAutosavingLock()
  reducer_isReady()
  reducer_editorSettings()
  getWPAdminURL()
  cleanForSlug()
  selectors_ownKeys()
  selectors_objectSpread()
  selectors_isEditedPostNew()
  hasChangedContent()
  selectors_isCleanNewPost()
  selectors_getCurrentPostType()
  selectors_getCurrentPostId()
  getCurrentPostRevisionsCount()
  getCurrentPostLastRevisionId()
  selectors_getCurrentPostAttribute()
  selectors_getEditedPostAttribute()
  selectors_getEditedPostVisibility()
  isCurrentPostPending()
  selectors_isCurrentPostPublished()
  selectors_isCurrentPostScheduled()
  selectors_isEditedPostPublishable()
  selectors_isEditedPostSaveable()
  isEditedPostEmpty()
  selectors_isEditedPostBeingScheduled()
  isEditedPostDateFloating()
  selectors_isAutosavingPost()
  isPreviewingPost()
  selectors_getEditedPostPreviewLink()
  selectors_getSuggestedPostFormat()
  getBlocksForSerialization()
  getStateBeforeOptimisticTransaction()
  selectors_isPublishingPost()
  isPermalinkEditable()
  getPermalink()
  getEditedPostSlug()
  getPermalinkParts()
  inSomeHistory()
  isPostLocked()
  selectors_isPostSavingLocked()
  isPostAutosavingLocked()
  isPostLockTakeover()
  getPostLockUser()
  getActivePostLock()
  selectors_canUserUseUnfilteredHTML()
  selectors_isPublishSidebarEnabled()
  selectors_getEditorBlocks()
  selectors_getEditorSelectionStart()
  selectors_getEditorSelectionEnd()
  __unstableIsEditorReady()
  selectors_getEditorSettings()
  getBlockEditorSelector()
  getNotificationArgumentsForSaveSuccess()
  getNotificationArgumentsForSaveFail()
  getNotificationArgumentsForTrashFail()
  actions_ownKeys()
  actions_objectSpread()
  setupEditor()
  __experimentalTearDownEditor()
  resetPost()
  resetAutosave()
  __experimentalRequestPostUpdateStart()
  __experimentalRequestPostUpdateFinish()
  updatePost()
  setupEditorState()
  actions_editPost()
  __experimentalOptimisticUpdatePost()
  actions_savePost()
  refreshPost()
  trashPost()
  actions_autosave()
  actions_redo()
  actions_undo()
  createUndoLevel()
  updatePostLock()
  enablePublishSidebar()
  disablePublishSidebar()
  lockPostSaving()
  unlockPostSaving()
  lockPostAutosaving()
  unlockPostAutosaving()
  actions_resetEditorBlocks()
  updateEditorSettings()
  postKey()
  localAutosaveGet()
  localAutosaveSet()
  localAutosaveClear()
  store_ownKeys()
  store_objectSpread()
  custom_sources_backwards_compatibility_ownKeys()
  custom_sources_backwards_compatibility_objectSpread()
  shimAttributeSource()
  setDefaultCompleters()
  _createSuper()
  _isNativeReflectConstruct()
  AutosaveMonitor()
  document_outline_ownKeys()
  document_outline_objectSpread()
  DocumentOutlineCheck()
  SaveShortcut()
  VisualEditorGlobalKeyboardShortcuts()
  EditorGlobalKeyboardShortcuts()
  TextEditorGlobalKeyboardShortcuts()
  EditorKeyboardShortcutsRegister()
  EditorHistoryRedo()
  EditorHistoryUndo()
  TemplateValidationNotice()
  EditorNotices()
  EntityRecordItem()
  EntityTypeList()
  EntitiesSavedStates()
  error_boundary_createSuper()
  error_boundary_isNativeReflectConstruct()
  ErrorBoundary()
  useAutosaveNotice()
  useAutosavePurge()
  LocalAutosaveMonitor()
  PageAttributesCheck()
  PostTypeSupportCheck()
  PageAttributesOrderWithChecks()
  terms_ownKeys()
  terms_objectSpread()
  buildTermsTree()
  getTitle()
  PageAttributesParent()
  PageTemplate()
  PostAuthorCheck()
  post_author_ownKeys()
  post_author_objectSpread()
  PostAuthor()
  PostComments()
  PostExcerpt()
  PostExcerptCheck()
  ThemeSupportCheck()
  PostFeaturedImageCheck()
  PostFeaturedImage()
  PostFormatCheck()
  PostFormat()
  PostLastRevisionCheck()
  LastRevision()
  post_preview_button_createSuper()
  post_preview_button_isNativeReflectConstruct()
  writeInterstitialMessage()
  PostPreviewButton()
  post_locked_modal_createSuper()
  post_locked_modal_isNativeReflectConstruct()
  PostLockedModal()
  PostPendingStatusCheck()
  PostPendingStatus()
  PostPingbacks()
  PublishButtonLabel()
  post_publish_button_createSuper()
  post_publish_button_isNativeReflectConstruct()
  PostPublishButton()
  post_visibility_createSuper()
  post_visibility_isNativeReflectConstruct()
  PostVisibility()
  PostVisibilityLabel()
  PostSchedule()
  PostScheduleLabel()
  flat_term_selector_createSuper()
  flat_term_selector_isNativeReflectConstruct()
  flat_term_selector_ownKeys()
  flat_term_selector_objectSpread()
  FlatTermSelector()
  maybe_tags_panel_createSuper()
  maybe_tags_panel_isNativeReflectConstruct()
  MaybeTagsPanel()
  PostFormatPanel()
  PostPublishPanelPrepublish()
  postpublish_createSuper()
  postpublish_isNativeReflectConstruct()
  PostPublishPanelPostpublish()
  post_publish_panel_createSuper()
  post_publish_panel_isNativeReflectConstruct()
  PostPublishPanel()
  PostSwitchToDraftButton()
  PostSavedState()
  PostScheduleCheck()
  PostSlugCheck()
  post_slug_createSuper()
  post_slug_isNativeReflectConstruct()
  PostSlug()
  PostStickyCheck()
  PostSticky()
  hierarchical_term_selector_ownKeys()
  hierarchical_term_selector_objectSpread()
  hierarchical_term_selector_createSuper()
  hierarchical_term_selector_isNativeReflectConstruct()
  HierarchicalTermSelector()
  PostTaxonomies()
  PostTaxonomiesCheck()
  PostTextEditor()
  post_title_createSuper()
  post_title_isNativeReflectConstruct()
  PostTitle()
  PostTrash()
  PostTrashCheck()
  PostVisibilityCheck()
  WordCount()
  CharacterCount()
  TableOfContentsPanel()
  TableOfContents()
  UnsavedChangesWarning()
  media_upload_ownKeys()
  media_upload_objectSpread()
  mediaUpload()
  ConvertToGroupButton()
  provider_ownKeys()
  provider_objectSpread()
  provider_createSuper()
  provider_isNativeReflectConstruct()
  EditorProvider()
  deprecateComponent()
  deprecateFunction()
  _defineProperty()
  memize()
  memoized()
  _extends()
  classNames()

Functions
Functions that are not part of a class:

__webpack_require__(moduleId)   X-Ref
No description

getDefault()   X-Ref
No description

getModuleExports()   X-Ref
No description

_iterableToArrayLimit(arr, i)   X-Ref
No description

_slicedToArray(arr, i)   X-Ref
No description

_objectWithoutProperties(source, excluded)   X-Ref
No description

ownKeys(object, enumerableOnly)   X-Ref
No description

_objectSpread(target)   X-Ref
No description

Icon(_ref)   X-Ref
Return an SVG icon.

param: {IconProps} props icon is the SVG component to render
return: {JSX.Element}  Icon component

emptyFunction()   X-Ref
No description

emptyFunctionWithReset()   X-Ref
No description

shim(props, propName, componentName, location, propFullName, secret)   X-Ref
No description

getShim()   X-Ref
No description

_assertThisInitialized(self)   X-Ref
No description

_arrayWithoutHoles(arr)   X-Ref
No description

_nonIterableSpread()   X-Ref
No description

_toConsumableArray(arr)   X-Ref
No description

__()   X-Ref
No description

TextareaAutosize()   X-Ref
A light replacement for built-in textarea component
which automaticaly adjusts its height to match the content


assign(ta)   X-Ref
No description

init()   X-Ref
No description

changeOverflow(value)   X-Ref
No description

getParentOverflows(el)   X-Ref
No description

resize()   X-Ref
No description

update()   X-Ref
No description

destroy(ta)   X-Ref
No description

update(ta)   X-Ref
No description

lineHeight(node)   X-Ref
Calculate the `line-height` of a given node

returns: {Number} `line-height` of the element in pixels
param: {HTMLElement} node Element to calculate line height of. Must be in the DOM.

_getPrototypeOf(o)   X-Ref
No description

_classCallCheck(instance, Constructor)   X-Ref
No description

_defineProperties(target, props)   X-Ref
No description

_createClass(Constructor, protoProps, staticProps)   X-Ref
No description

_setPrototypeOf(o, p)   X-Ref
No description

_inherits(subClass, superClass)   X-Ref
No description

_possibleConstructorReturn(self, call)   X-Ref
No description

_arrayLikeToArray(arr, len)   X-Ref
No description

_unsupportedIterableToArray(o, minLen)   X-Ref
No description

_iterableToArray(iter)   X-Ref
No description

_arrayWithHoles(arr)   X-Ref
No description

_nonIterableRest()   X-Ref
No description

_typeof(obj)   X-Ref
No description

_objectWithoutPropertiesLoose(source, excluded)   X-Ref
No description

_objectWithoutProperties(obj, keys)   X-Ref
No description

optimist(fn)   X-Ref
No description

beginReducer(state, action)   X-Ref
No description

commitReducer(state, action)   X-Ref
No description

revertReducer(state, action)   X-Ref
No description

baseReducer(optimist, innerState, action)   X-Ref
No description

matchesTransaction(action, id)   X-Ref
No description

validateState(newState, action)   X-Ref
No description

separateState(state)   X-Ref
No description

asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg)   X-Ref
No description

_asyncToGenerator(fn)   X-Ref
No description

_next(value)   X-Ref
No description

_throw(err)   X-Ref
No description

ownKeys(object, enumerableOnly)   X-Ref
No description

_objectSpread(target)   X-Ref
No description

reducer_ownKeys(object, enumerableOnly)   X-Ref
No description

reducer_objectSpread(target)   X-Ref
No description

getPostRawValue(value)   X-Ref
Returns a post attribute value, flattening nested rendered content using its
raw value in place of its original object form.

param: {*} value Original value.
return: {*} Raw value.

hasSameKeys(a, b)   X-Ref
Returns true if the two object arguments have the same keys, or false
otherwise.

param: {Object} a First object.
param: {Object} b Second object.
return: {boolean} Whether the two objects have the same keys.

isUpdatingSamePostProperty(action, previousAction)   X-Ref
Returns true if, given the currently dispatching action and the previously
dispatched action, the two actions are editing the same post property, or
false otherwise.

param: {Object} action         Currently dispatching action.
param: {Object} previousAction Previously dispatched action.
return: {boolean} Whether actions are updating the same post property.

shouldOverwriteState(action, previousAction)   X-Ref
Returns true if, given the currently dispatching action and the previously
dispatched action, the two actions are modifying the same property such that
undo history should be batched.

param: {Object} action         Currently dispatching action.
param: {Object} previousAction Previously dispatched action.
return: {boolean} Whether to overwrite present state.

reducer_postId()   X-Ref
No description

reducer_postType()   X-Ref
No description

reducer_template()   X-Ref
Reducer returning whether the post blocks match the defined template or not.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {boolean} Updated state.

preferences()   X-Ref
Reducer returning the user preferences.

param: {Object}  state                 Current state.
param: {Object}  action                Dispatched action.
return: {string} Updated state.

saving()   X-Ref
Reducer returning current network request state (whether a request to
the WP REST API is in progress, successful, or failed).

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

postLock()   X-Ref
Reducer returning the post lock status.

param: {PostLockState} state  Current state.
param: {Object} action Dispatched action.
return: {PostLockState} Updated state.

postSavingLock()   X-Ref
Post saving lock.

When post saving is locked, the post cannot be published or updated.

param: {PostLockState} state  Current state.
param: {Object}        action Dispatched action.
return: {PostLockState} Updated state.

postAutosavingLock()   X-Ref
Post autosaving lock.

When post autosaving is locked, the post will not autosave.

param: {PostLockState} state  Current state.
param: {Object}        action Dispatched action.
return: {PostLockState} Updated state.

reducer_isReady()   X-Ref
Reducer returning whether the editor is ready to be rendered.
The editor is considered ready to be rendered once
the post object is loaded properly and the initial blocks parsed.

param: {boolean} state
param: {Object} action
return: {boolean} Updated state.

reducer_editorSettings()   X-Ref
Reducer returning the post editor setting.

param: {Object} state  Current state.
param: {Object} action Dispatched action.
return: {Object} Updated state.

getWPAdminURL(page, query)   X-Ref
Returns the URL of a WPAdmin Page.

TODO: This should be moved to a module less specific to the editor.

param: {string} page  Page to navigate to.
param: {Object} query Query Args.
return: {string} WPAdmin URL.

cleanForSlug(string)   X-Ref
Performs some basic cleanup of a string for use as a post slug

This replicates some of what sanitize_title() does in WordPress core, but
is only designed to approximate what the slug will be.

Converts Latin-1 Supplement and Latin Extended-A letters to basic Latin
letters. Removes combining diacritical marks. Converts whitespace, periods,
and forward slashes to hyphens. Removes any remaining non-word characters
except hyphens. Converts remaining string to lowercase. It does not account
for octets, HTML entities, or other encoded characters.

param: {string} string Title or slug to be processed
return: {string} Processed string

selectors_ownKeys(object, enumerableOnly)   X-Ref
No description

selectors_objectSpread(target)   X-Ref
No description

selectors_isEditedPostNew(state)   X-Ref
Returns true if the currently edited post is yet to be saved, or false if
the post has been saved.

param: {Object} state Global application state.
return: {boolean} Whether the post is new.

hasChangedContent(state)   X-Ref
Returns true if content includes unsaved changes, or false otherwise.

param: {Object} state Editor state.
return: {boolean} Whether content includes unsaved changes.

selectors_isCleanNewPost(state)   X-Ref
Returns true if there are no unsaved values for the current edit session and
if the currently edited post is new (has never been saved before).

param: {Object} state Global application state.
return: {boolean} Whether new post and unsaved values exist.

selectors_getCurrentPostType(state)   X-Ref
Returns the post type of the post currently being edited.

param: {Object} state Global application state.
return: {string} Post type.

selectors_getCurrentPostId(state)   X-Ref
Returns the ID of the post currently being edited, or null if the post has
not yet been saved.

param: {Object} state Global application state.
return: {?number} ID of current post.

getCurrentPostRevisionsCount(state)   X-Ref
Returns the number of revisions of the post currently being edited.

param: {Object} state Global application state.
return: {number} Number of revisions.

getCurrentPostLastRevisionId(state)   X-Ref
Returns the last revision ID of the post currently being edited,
or null if the post has no revisions.

param: {Object} state Global application state.
return: {?number} ID of the last revision.

selectors_getCurrentPostAttribute(state, attributeName)   X-Ref
Returns an attribute value of the saved post.

param: {Object} state         Global application state.
param: {string} attributeName Post attribute name.
return: {*} Post attribute value.

selectors_getEditedPostAttribute(state, attributeName)   X-Ref
Returns a single attribute of the post being edited, preferring the unsaved
edit if one exists, but falling back to the attribute for the last known
saved state of the post.

param: {Object} state         Global application state.
param: {string} attributeName Post attribute name.
return: {*} Post attribute value.

selectors_getEditedPostVisibility(state)   X-Ref
Returns the current visibility of the post being edited, preferring the
unsaved value if different than the saved post. The return value is one of
"private", "password", or "public".

param: {Object} state Global application state.
return: {string} Post visibility.

isCurrentPostPending(state)   X-Ref
Returns true if post is pending review.

param: {Object} state Global application state.
return: {boolean} Whether current post is pending review.

selectors_isCurrentPostPublished(state, currentPost)   X-Ref
Return true if the current post has already been published.

param: {Object}  state       Global application state.
param: {Object?} currentPost Explicit current post for bypassing registry selector.
return: {boolean} Whether the post has been published.

selectors_isCurrentPostScheduled(state)   X-Ref
Returns true if post is already scheduled.

param: {Object} state Global application state.
return: {boolean} Whether current post is scheduled to be posted.

selectors_isEditedPostPublishable(state)   X-Ref
Return true if the post being edited can be published.

param: {Object} state Global application state.
return: {boolean} Whether the post can been published.

selectors_isEditedPostSaveable(state)   X-Ref
Returns true if the post can be saved, or false otherwise. A post must
contain a title, an excerpt, or non-empty content to be valid for save.

param: {Object} state Global application state.
return: {boolean} Whether the post can be saved.

isEditedPostEmpty(state)   X-Ref
Returns true if the edited post has content. A post has content if it has at
least one saveable block or otherwise has a non-empty content property
assigned.

param: {Object} state Global application state.
return: {boolean} Whether post has content.

selectors_isEditedPostBeingScheduled(state)   X-Ref
Return true if the post being edited is being scheduled. Preferring the
unsaved status values.

param: {Object} state Global application state.
return: {boolean} Whether the post has been published.

isEditedPostDateFloating(state)   X-Ref
Returns whether the current post should be considered to have a "floating"
date (i.e. that it would publish "Immediately" rather than at a set time).

Unlike in the PHP backend, the REST API returns a full date string for posts
where the 0000-00-00T00:00:00 placeholder is present in the database. To
infer that a post is set to publish "Immediately" we check whether the date
and modified date are the same.

param: {Object} state Editor state.
return: {boolean} Whether the edited post has a floating date value.

selectors_isAutosavingPost(state)   X-Ref
Returns true if the post is autosaving, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether the post is autosaving.

isPreviewingPost(state)   X-Ref
Returns true if the post is being previewed, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether the post is being previewed.

selectors_getEditedPostPreviewLink(state)   X-Ref
Returns the post preview link

param: {Object} state Global application state.
return: {string?} Preview Link.

selectors_getSuggestedPostFormat(state)   X-Ref
Returns a suggested post format for the current post, inferred only if there
is a single block within the post and it is of a type known to match a
default post format. Returns null if the format cannot be determined.

param: {Object} state Global application state.
return: {?string} Suggested post format.

getBlocksForSerialization(state)   X-Ref
Returns a set of blocks which are to be used in consideration of the post's
generated save content.

param: {Object} state Editor state.
return: {WPBlock[]} Filtered set of blocks for save.

getStateBeforeOptimisticTransaction(state, transactionId)   X-Ref
Returns state object prior to a specified optimist transaction ID, or `null`
if the transaction corresponding to the given ID cannot be found.

param: {Object} state         Current global application state.
param: {Object} transactionId Optimist transaction ID.
return: {Object} Global application state prior to transaction.

selectors_isPublishingPost(state)   X-Ref
Returns true if the post is being published, or false otherwise.

param: {Object} state Global application state.
return: {boolean} Whether post is being published.

isPermalinkEditable(state)   X-Ref
Returns whether the permalink is editable or not.

param: {Object} state Editor state.
return: {boolean} Whether or not the permalink is editable.

getPermalink(state)   X-Ref
Returns the permalink for the post.

param: {Object} state Editor state.
return: {?string} The permalink, or null if the post is not viewable.

getEditedPostSlug(state)   X-Ref
Returns the slug for the post being edited, preferring a manually edited
value if one exists, then a sanitized version of the current post title, and
finally the post ID.

param: {Object} state Editor state.
return: {string} The current slug to be displayed in the editor

getPermalinkParts(state)   X-Ref
Returns the permalink for a post, split into it's three parts: the prefix,
the postName, and the suffix.

param: {Object} state Editor state.
return: {Object} An object containing the prefix, postName, and suffix for

inSomeHistory(state, predicate)   X-Ref
Returns true if an optimistic transaction is pending commit, for which the
before state satisfies the given predicate function.

param: {Object}   state     Editor state.
param: {Function} predicate Function given state, returning true if match.
return: {boolean} Whether predicate matches for some history.

isPostLocked(state)   X-Ref
Returns whether the post is locked.

param: {Object} state Global application state.
return: {boolean} Is locked.

selectors_isPostSavingLocked(state)   X-Ref
Returns whether post saving is locked.

param: {Object} state Global application state.
return: {boolean} Is locked.

isPostAutosavingLocked(state)   X-Ref
Returns whether post autosaving is locked.

param: {Object} state Global application state.
return: {boolean} Is locked.

isPostLockTakeover(state)   X-Ref
Returns whether the edition of the post has been taken over.

param: {Object} state Global application state.
return: {boolean} Is post lock takeover.

getPostLockUser(state)   X-Ref
Returns details about the post lock user.

param: {Object} state Global application state.
return: {Object} A user object.

getActivePostLock(state)   X-Ref
Returns the active post lock.

param: {Object} state Global application state.
return: {Object} The lock object.

selectors_canUserUseUnfilteredHTML(state)   X-Ref
Returns whether or not the user has the unfiltered_html capability.

param: {Object} state Editor state.
return: {boolean} Whether the user can or can't post unfiltered HTML.

selectors_isPublishSidebarEnabled(state)   X-Ref
Returns whether the pre-publish panel should be shown
or skipped when the user clicks the "publish" button.

param: {Object} state Global application state.
return: {boolean} Whether the pre-publish panel should be shown or not.

selectors_getEditorBlocks(state)   X-Ref
Return the current block list.

param: {Object} state
return: {Array} Block list.

selectors_getEditorSelectionStart(state)   X-Ref
Returns the current selection start.

param: {Object} state
return: {WPBlockSelection} The selection start.

selectors_getEditorSelectionEnd(state)   X-Ref
Returns the current selection end.

param: {Object} state
return: {WPBlockSelection} The selection end.

__unstableIsEditorReady(state)   X-Ref
Is the editor ready

param: {Object} state
return: {boolean} is Ready.

selectors_getEditorSettings(state)   X-Ref
Returns the post editor settings.

param: {Object} state Editor state.
return: {Object} The editor settings object.

getBlockEditorSelector(name)   X-Ref
No description

getNotificationArgumentsForSaveSuccess(data)   X-Ref
Builds the arguments for a success notification dispatch.

param: {Object} data Incoming data to build the arguments from.
return: {Array} Arguments for dispatch. An empty array signals no

getNotificationArgumentsForSaveFail(data)   X-Ref
Builds the fail notification arguments for dispatch.

param: {Object} data Incoming data to build the arguments with.
return: {Array} Arguments for dispatch. An empty array signals no

getNotificationArgumentsForTrashFail(data)   X-Ref
Builds the trash fail notification arguments for dispatch.

param: {Object} data
return: {Array} Arguments for dispatch.

actions_ownKeys(object, enumerableOnly)   X-Ref
No description

actions_objectSpread(target)   X-Ref
No description

setupEditor(post, edits, template)   X-Ref
Returns an action generator used in signalling that editor has initialized with
the specified post object and editor settings.

param: {Object} post      Post object.
param: {Object} edits     Initial edited attributes object.
param: {Array?} template  Block Template.

__experimentalTearDownEditor()   X-Ref
Returns an action object signalling that the editor is being destroyed and
that any necessary state or side-effect cleanup should occur.

return: {Object} Action object.

resetPost(post)   X-Ref
Returns an action object used in signalling that the latest version of the
post has been received, either by initialization or save.

param: {Object} post Post object.
return: {Object} Action object.

resetAutosave(newAutosave)   X-Ref
Returns an action object used in signalling that the latest autosave of the
post has been received, by initialization or autosave.

param: {Object} newAutosave Autosave post object.
return: {Object} Action object.

__experimentalRequestPostUpdateStart()   X-Ref
Action for dispatching that a post update request has started.

param: {Object} options
return: {Object} An action object

__experimentalRequestPostUpdateFinish()   X-Ref
Action for dispatching that a post update request has finished.

param: {Object} options
return: {Object} An action object

updatePost(edits)   X-Ref
Returns an action object used in signalling that a patch of updates for the
latest version of the post have been received.

param: {Object} edits Updated post fields.
return: {Object} Action object.

setupEditorState(post)   X-Ref
Returns an action object used to setup the editor state when first opening
an editor.

param: {Object} post   Post object.
return: {Object} Action object.

actions_editPost(edits, options)   X-Ref
Returns an action object used in signalling that attributes of the post have
been edited.

param: {Object} edits   Post attributes to edit.
param: {Object} options Options for the edit.

__experimentalOptimisticUpdatePost(edits)   X-Ref
Returns action object produced by the updatePost creator augmented by
an optimist option that signals optimistically applying updates.

param: {Object} edits  Updated post fields.
return: {Object} Action object.

actions_savePost()   X-Ref
Action generator for saving the current post in the editor.

param: {Object} options

refreshPost()   X-Ref
Action generator for handling refreshing the current post.


trashPost()   X-Ref
Action generator for trashing the current post in the editor.


actions_autosave()   X-Ref
Action generator used in signalling that the post should autosave.  This
includes server-side autosaving (default) and client-side (a.k.a. local)
autosaving (e.g. on the Web, the post might be committed to Session
Storage).

param: {Object?} options Extra flags to identify the autosave.

actions_redo()   X-Ref
Returns an action object used in signalling that undo history should
restore last popped state.


actions_undo()   X-Ref
Returns an action object used in signalling that undo history should pop.


createUndoLevel()   X-Ref
Returns an action object used in signalling that undo history record should
be created.

return: {Object} Action object.

updatePostLock(lock)   X-Ref
Returns an action object used to lock the editor.

param: {Object}  lock Details about the post lock status, user, and nonce.
return: {Object} Action object.

enablePublishSidebar()   X-Ref
Returns an action object used in signalling that the user has enabled the
publish sidebar.

return: {Object} Action object

disablePublishSidebar()   X-Ref
Returns an action object used in signalling that the user has disabled the
publish sidebar.

return: {Object} Action object

lockPostSaving(lockName)   X-Ref
Returns an action object used to signal that post saving is locked.

param: {string} lockName The lock name.
return: {Object} Action object

unlockPostSaving(lockName)   X-Ref
Returns an action object used to signal that post saving is unlocked.

param: {string} lockName The lock name.
return: {Object} Action object

lockPostAutosaving(lockName)   X-Ref
Returns an action object used to signal that post autosaving is locked.

param: {string} lockName The lock name.
return: {Object} Action object

unlockPostAutosaving(lockName)   X-Ref
Returns an action object used to signal that post autosaving is unlocked.

param: {string} lockName The lock name.
return: {Object} Action object

actions_resetEditorBlocks(blocks)   X-Ref
Returns an action object used to signal that the blocks have been updated.

param: {Array}   blocks  Block Array.
param: {?Object} options Optional options.

updateEditorSettings(settings)   X-Ref
No description

postKey(postId, isPostNew)   X-Ref
Function returning a sessionStorage key to set or retrieve a given post's
automatic session backup.

Keys are crucially prefixed with 'wp-autosave-' so that wp-login.php's
`loggedout` handler can clear sessionStorage of any user-private content.

param: {string}  postId     Post ID.
param: {boolean} isPostNew  Whether post new.
return: {string}            sessionStorage key

localAutosaveGet(postId, isPostNew)   X-Ref
No description

localAutosaveSet(postId, isPostNew, title, content, excerpt)   X-Ref
No description

localAutosaveClear(postId, isPostNew)   X-Ref
No description

store_ownKeys(object, enumerableOnly)   X-Ref
No description

store_objectSpread(target)   X-Ref
No description

custom_sources_backwards_compatibility_ownKeys(object, enumerableOnly)   X-Ref
No description

custom_sources_backwards_compatibility_objectSpread(target)   X-Ref
No description

shimAttributeSource(settings)   X-Ref
No description

setDefaultCompleters()   X-Ref
No description

_createSuper(Derived)   X-Ref
No description

_isNativeReflectConstruct()   X-Ref
No description

AutosaveMonitor(props)   X-Ref
No description

document_outline_ownKeys(object, enumerableOnly)   X-Ref
No description

document_outline_objectSpread(target)   X-Ref
No description

DocumentOutlineCheck(_ref)   X-Ref
No description

SaveShortcut(_ref)   X-Ref
No description

VisualEditorGlobalKeyboardShortcuts()   X-Ref
No description

EditorGlobalKeyboardShortcuts()   X-Ref
No description

TextEditorGlobalKeyboardShortcuts()   X-Ref
Internal dependencies


EditorKeyboardShortcutsRegister()   X-Ref
No description

EditorHistoryRedo(props, ref)   X-Ref
No description

EditorHistoryUndo(props, ref)   X-Ref
No description

TemplateValidationNotice(_ref)   X-Ref
No description

EditorNotices(_ref)   X-Ref
Internal dependencies


EntityRecordItem(_ref)   X-Ref
No description

EntityTypeList(_ref)   X-Ref
No description

EntitiesSavedStates(_ref)   X-Ref
No description

error_boundary_createSuper(Derived)   X-Ref
No description

error_boundary_isNativeReflectConstruct()   X-Ref
No description

ErrorBoundary()   X-Ref
No description

useAutosaveNotice()   X-Ref
Custom hook which manages the creation of a notice prompting the user to
restore a local autosave, if one exists.


useAutosavePurge()   X-Ref
Custom hook which ejects a local autosave after a successful save occurs.


LocalAutosaveMonitor()   X-Ref
No description

PageAttributesCheck(_ref)   X-Ref
WordPress dependencies


PostTypeSupportCheck(_ref)   X-Ref
A component which renders its own children only if the current editor post
type supports one of the given `supportKeys` prop.

param: {Object}    props             Props.
param: {string}    [props.postType]  Current post type.
param: {WPElement} props.children    Children to be rendered if post
param: {(string|string[])}                      props.supportKeys String or string array of keys
return: {WPComponent} The component to be rendered.

PageAttributesOrderWithChecks(props)   X-Ref
No description

terms_ownKeys(object, enumerableOnly)   X-Ref
No description

terms_objectSpread(target)   X-Ref
No description

buildTermsTree(flatTerms)   X-Ref
Returns terms in a tree form.

param: {Array} flatTerms  Array of terms in flat format.
return: {Array} Array of terms in tree format.

getTitle(post)   X-Ref
No description

PageAttributesParent()   X-Ref
No description

PageTemplate(_ref)   X-Ref
No description

PostAuthorCheck(_ref)   X-Ref
Internal dependencies


post_author_ownKeys(object, enumerableOnly)   X-Ref
No description

post_author_objectSpread(target)   X-Ref
No description

PostAuthor()   X-Ref
No description

PostComments(_ref)   X-Ref
No description

PostExcerpt(_ref)   X-Ref
No description

PostExcerptCheck(props)   X-Ref
Internal dependencies


ThemeSupportCheck(_ref)   X-Ref
WordPress dependencies


PostFeaturedImageCheck(props)   X-Ref
No description

PostFeaturedImage(_ref)   X-Ref
No description

PostFormatCheck(_ref)   X-Ref
No description

PostFormat()   X-Ref
No description

PostLastRevisionCheck(_ref)   X-Ref
Internal dependencies


LastRevision(_ref)   X-Ref
No description

post_preview_button_createSuper(Derived)   X-Ref
No description

post_preview_button_isNativeReflectConstruct()   X-Ref
No description

writeInterstitialMessage(targetDocument)   X-Ref
No description

PostPreviewButton()   X-Ref
No description

post_locked_modal_createSuper(Derived)   X-Ref
No description

post_locked_modal_isNativeReflectConstruct()   X-Ref
No description

PostLockedModal()   X-Ref
No description

PostPendingStatusCheck(_ref)   X-Ref
No description

PostPendingStatus(_ref)   X-Ref
Internal dependencies


PostPingbacks(_ref)   X-Ref
No description

PublishButtonLabel(_ref)   X-Ref
No description

post_publish_button_createSuper(Derived)   X-Ref
No description

post_publish_button_isNativeReflectConstruct()   X-Ref
No description

PostPublishButton(props)   X-Ref
No description

post_visibility_createSuper(Derived)   X-Ref
No description

post_visibility_isNativeReflectConstruct()   X-Ref
No description

PostVisibility(props)   X-Ref
No description

PostVisibilityLabel(_ref)   X-Ref
No description

PostSchedule(_ref)   X-Ref
No description

PostScheduleLabel(_ref)   X-Ref
No description

flat_term_selector_createSuper(Derived)   X-Ref
No description

flat_term_selector_isNativeReflectConstruct()   X-Ref
No description

flat_term_selector_ownKeys(object, enumerableOnly)   X-Ref
No description

flat_term_selector_objectSpread(target)   X-Ref
No description

FlatTermSelector()   X-Ref
No description

maybe_tags_panel_createSuper(Derived)   X-Ref
No description

maybe_tags_panel_isNativeReflectConstruct()   X-Ref
No description

MaybeTagsPanel(props)   X-Ref
No description

PostFormatPanel()   X-Ref
No description

PostPublishPanelPrepublish(_ref)   X-Ref
No description

postpublish_createSuper(Derived)   X-Ref
No description

postpublish_isNativeReflectConstruct()   X-Ref
No description

PostPublishPanelPostpublish()   X-Ref
No description

post_publish_panel_createSuper(Derived)   X-Ref
No description

post_publish_panel_isNativeReflectConstruct()   X-Ref
No description

PostPublishPanel()   X-Ref
No description

PostSwitchToDraftButton(_ref)   X-Ref
No description

PostSavedState(_ref)   X-Ref
Component showing whether the post is saved or not and providing save
buttons.

param: {Object} props               Component props.
param: {?boolean} props.forceIsDirty  Whether to force the post to be marked
param: {?boolean} props.forceIsSaving Whether to force the post to be marked
param: {?boolean} props.showIconLabels Whether interface buttons show labels instead of icons
return: {import('@wordpress/element').WPComponent} The component.

PostScheduleCheck(_ref)   X-Ref
No description

PostSlugCheck(_ref)   X-Ref
Internal dependencies


post_slug_createSuper(Derived)   X-Ref
No description

post_slug_isNativeReflectConstruct()   X-Ref
No description

PostSlug(_ref)   X-Ref
No description

PostStickyCheck(_ref)   X-Ref
No description

PostSticky(_ref)   X-Ref
Internal dependencies


hierarchical_term_selector_ownKeys(object, enumerableOnly)   X-Ref
No description

hierarchical_term_selector_objectSpread(target)   X-Ref
No description

hierarchical_term_selector_createSuper(Derived)   X-Ref
No description

hierarchical_term_selector_isNativeReflectConstruct()   X-Ref
No description

HierarchicalTermSelector()   X-Ref
No description

PostTaxonomies(_ref)   X-Ref
No description

PostTaxonomiesCheck(_ref)   X-Ref
No description

PostTextEditor()   X-Ref
No description

post_title_createSuper(Derived)   X-Ref
No description

post_title_isNativeReflectConstruct()   X-Ref
No description

PostTitle()   X-Ref
No description

PostTrash(_ref)   X-Ref
No description

PostTrashCheck(_ref)   X-Ref
WordPress dependencies


PostVisibilityCheck(_ref)   X-Ref
No description

WordCount()   X-Ref
No description

CharacterCount()   X-Ref
WordPress dependencies


TableOfContentsPanel(_ref)   X-Ref
No description

TableOfContents(_ref, ref)   X-Ref
No description

UnsavedChangesWarning()   X-Ref
Warns the user if there are unsaved changes before leaving the editor.
Compatible with Post Editor and Site Editor.

return: {WPComponent} The component.

media_upload_ownKeys(object, enumerableOnly)   X-Ref
No description

media_upload_objectSpread(target)   X-Ref
No description

mediaUpload(_ref)   X-Ref
Upload a media file when the file upload button is activated.
Wrapper around mediaUpload() that injects the current post ID.

param: {Object}   $0                   Parameters object passed to the function.
param: {?Object}  $0.additionalData    Additional data to include in the request.
param: {string}   $0.allowedTypes      Array with the types of media that can be uploaded, if unset all types are allowed.
param: {Array}    $0.filesList         List of files.
param: {?number}  $0.maxUploadFileSize Maximum upload size in bytes allowed for the site.
param: {Function} $0.onError           Function called when an error happens.
param: {Function} $0.onFileChange      Function called each time a file or a temporary representation of the file is available.

ConvertToGroupButton(_ref)   X-Ref
No description

provider_ownKeys(object, enumerableOnly)   X-Ref
No description

provider_objectSpread(target)   X-Ref
No description

provider_createSuper(Derived)   X-Ref
No description

provider_isNativeReflectConstruct()   X-Ref
No description

EditorProvider(props)   X-Ref
No description

deprecateComponent(name, Wrapped)   X-Ref
No description

deprecateFunction(name, func)   X-Ref
No description

_defineProperty(obj, key, value)   X-Ref
No description

memize( fn, options )   X-Ref
Accepts a function to be memoized, and returns a new memoized function, with
optional options.

param: {F}             fn        Function to memoize.
param: {MemizeOptions} [options] Options object.
return: {F & MemizeMemoizedFunction} Memoized function.

memoized( )   X-Ref
No description

_extends()   X-Ref
No description

classNames()   X-Ref
No description



Generated : Fri Oct 30 08:20:01 2020 Cross-referenced by PHPXref