[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/js/dist/ -> edit-post.js (summary)

(no description)

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

Defines 2 classes

BrowserURL:: (1 method):
  MetaBoxesArea()

MetaBoxVisibility:: (32 methods):
  MetaBoxes()
  ManagePatternsMenuItem()
  WelcomeGuideMenuItem()
  submitCustomFieldsForm()
  CustomFieldsConfirmation()
  EnableCustomFieldsOption()
  MetaBoxesSection()
  EditPostPreferencesModal()
  WelcomeGuideImage()
  WelcomeGuideDefault()
  WelcomeGuideTemplate()
  WelcomeGuide()
  useCommands()
  usePaddingAppender()
  onMouseDown()
  useShouldIframe()
  useNavigateToEntityRecord()
  useEditorStyles()
  MetaBoxesMain()
  Layout()
  onPluginAreaError()
  PluginBlockSettingsMenuItem()
  PluginDocumentSettingPanel()
  PluginMoreMenuItem()
  PluginPrePublishPanel()
  PluginPostPublishPanel()
  PluginPostStatusInfo()
  PluginSidebar()
  PluginSidebarMoreMenuItem()
  __experimentalPluginPostExcerpt()
  initializeEditor()
  reinitializeEditor()

Defines 32 functions

  r()
  FullscreenModeClose()
  BackButton()
  EditorInitialization()
  isSavingMetaBoxes()
  mergeMetaboxes()
  metaBoxLocations()
  metaBoxesInitialized()
  updatePreferredStyleVariations()
  setAvailableMetaBoxesPerLocation()
  metaBoxUpdatesSuccess()
  metaBoxUpdatesFailure()
  setIsEditingTemplate()
  __unstableCreateTemplate()
  convertPanelsToOldFormat()
  getPreference()
  isMetaBoxLocationActive()
  getMetaBoxesPerLocation()
  hasMetaBoxes()
  selectors_isSavingMetaBoxes()
  areMetaBoxesInitialized()
  KeyboardShortcuts()
  InitPatternModal()
  getPostEditURL()

Class: BrowserURL  - X-Ref

MetaBoxesArea({location})   X-Ref
Render metabox area.

param: {Object} props          Component props.
param: {string} props.location metabox location.
return: {Component} The component to be rendered.

Class: MetaBoxVisibility  - X-Ref

MetaBoxes({location})   X-Ref
No description

ManagePatternsMenuItem()   X-Ref
No description

WelcomeGuideMenuItem()   X-Ref
No description

submitCustomFieldsForm()   X-Ref
No description

CustomFieldsConfirmation({willEnable})   X-Ref
No description

EnableCustomFieldsOption({label,areCustomFieldsEnabled})   X-Ref
No description

MetaBoxesSection({areCustomFieldsRegistered,metaBoxes,...sectionProps})   X-Ref
No description

EditPostPreferencesModal()   X-Ref
No description

WelcomeGuideImage({nonAnimatedSrc,animatedSrc})   X-Ref
No description

WelcomeGuideDefault()   X-Ref
No description

WelcomeGuideTemplate()   X-Ref
No description

WelcomeGuide({postType})   X-Ref
No description

useCommands()   X-Ref
No description

usePaddingAppender()   X-Ref
No description

onMouseDown(event)   X-Ref
No description

useShouldIframe()   X-Ref
No description

useNavigateToEntityRecord(initialPostId, initialPostType, defaultRenderingMode)   X-Ref
A hook that records the 'entity' history in the post editor as a user
navigates between editing a post and editing the post template or patterns.

Implemented as a stack, so a little similar to the browser history API.

Used to control displaying UI elements like the back button.

param: {number} initialPostId        The post id of the post when the editor loaded.
param: {string} initialPostType      The post type of the post when the editor loaded.
param: {string} defaultRenderingMode The rendering mode to switch to when navigating.
return: {Object} An object containing the `currentPost` variable and

useEditorStyles()   X-Ref
No description

MetaBoxesMain({isLegacy})   X-Ref

param: {Object}  props
param: {boolean} props.isLegacy True when the editor canvas is not in an iframe.

Layout({postId: initialPostId,postType: initialPostType,settings,initialEdits})   X-Ref
No description

onPluginAreaError(name)   X-Ref
No description

PluginBlockSettingsMenuItem(props)   X-Ref


PluginDocumentSettingPanel(props)   X-Ref


PluginMoreMenuItem(props)   X-Ref


PluginPrePublishPanel(props)   X-Ref


PluginPostPublishPanel(props)   X-Ref


PluginPostStatusInfo(props)   X-Ref


PluginSidebar(props)   X-Ref


PluginSidebarMoreMenuItem(props)   X-Ref


__experimentalPluginPostExcerpt()   X-Ref


initializeEditor(id, postType, postId, settings, initialEdits)   X-Ref
Initializes and returns an instance of Editor.

param: {string}  id           Unique identifier for editor instance.
param: {string}  postType     Post type of the post to edit.
param: {Object}  postId       ID of the post to edit.
param: {?Object} settings     Editor settings object.
param: {Object}  initialEdits Programmatic edits to apply initially, to be

reinitializeEditor()   X-Ref
Used to reinitialize the editor after an error. Now it's a deprecated noop function.


Functions
Functions that are not part of a class:

r(e)   X-Ref
No description

FullscreenModeClose({showTooltip,icon,href,initialPost})   X-Ref
No description

BackButton({initialPost})   X-Ref
No description

EditorInitialization()   X-Ref
Data component used for initializing the editor and re-initializes
when postId changes or on unmount.

return: {null} This is a data component so does not render any ui.

isSavingMetaBoxes(state = false, action)   X-Ref
Reducer keeping track of the meta boxes isSaving state.
A "true" value means the meta boxes saving request is in-flight.

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

mergeMetaboxes(metaboxes = [], newMetaboxes)   X-Ref
No description

metaBoxLocations(state = {}, action)   X-Ref
Reducer keeping track of the meta boxes per location.

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

metaBoxesInitialized(state = false, action)   X-Ref
Reducer tracking whether meta boxes are initialized.

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

updatePreferredStyleVariations()   X-Ref
Returns an action object used in signaling that a style should be auto-applied when a block is created.


setAvailableMetaBoxesPerLocation(metaBoxesPerLocation)   X-Ref
Stores info about which Meta boxes are available in which location.

param: {Object} metaBoxesPerLocation Meta boxes per location.

metaBoxUpdatesSuccess()   X-Ref
Returns an action object used to signal a successful meta box update.

return: {Object} Action object.

metaBoxUpdatesFailure()   X-Ref
Returns an action object used to signal a failed meta box update.

return: {Object} Action object.

setIsEditingTemplate()   X-Ref
Returns an action object used to switch to template editing.


__unstableCreateTemplate()   X-Ref
Create a block based template.


convertPanelsToOldFormat(inactivePanels, openPanels)   X-Ref
Converts panels from the new preferences store format to the old format
that the post editor previously used.

The resultant converted data should look like this:
{
panelName: {
enabled: false,
opened: true,
},
anotherPanelName: {
opened: true
},
}

param: {string[] | undefined} inactivePanels An array of inactive panel names.
param: {string[] | undefined} openPanels     An array of open panel names.
return: {Object} The converted panel data.

getPreference(state, preferenceKey, defaultValue)   X-Ref

param: {Object} state         Global application state.
param: {string} preferenceKey Preference Key.
param: {*}      defaultValue  Default Value.
return: {*} Preference Value.

isMetaBoxLocationActive(state, location)   X-Ref
Returns true if there is an active meta box in the given location, or false
otherwise.

param: {Object} state    Post editor state.
param: {string} location Meta box location to test.
return: {boolean} Whether the meta box location is active.

getMetaBoxesPerLocation(state, location)   X-Ref
Returns the list of all the available meta boxes for a given location.

param: {Object} state    Global application state.
param: {string} location Meta box location to test.
return: {?Array} List of meta boxes.

hasMetaBoxes(state)   X-Ref
Returns true if the post is using Meta Boxes

param: {Object} state Global application state
return: {boolean} Whether there are metaboxes or not.

selectors_isSavingMetaBoxes(state)   X-Ref
Returns true if the Meta Boxes are being saved.

param: {Object} state Global application state.
return: {boolean} Whether the metaboxes are being saved.

areMetaBoxesInitialized(state)   X-Ref
Returns true if meta boxes are initialized.

param: {Object} state Global application state.
return: {boolean} Whether meta boxes are initialized.

KeyboardShortcuts()   X-Ref
Internal dependencies


InitPatternModal()   X-Ref
No description

getPostEditURL(postId)   X-Ref
Returns the Post's Edit URL.

param: {number} postId Post ID.
return: {string} Post edit URL.



Generated : Thu Nov 21 08:20:01 2024 Cross-referenced by PHPXref