PHPXRef 0.7.1 : WordPress Trunk (Updated Daily) : Detail view of editor.js

Internal dependencies

This component renders a navigation bar at the top of the editor. It displays the title of the current document,
a back button (if applicable), and a command center button. It also handles different states of the document,
such as "not found" or "unsynced".

return: {JSX.Element} The rendered DocumentBar component.
param: {Object}   props       The component props.
param: {string}   props.title A title for the document, defaulting to the document or
param: {IconType} props.icon  An icon for the document, no default.

EmptyOutlineIllustration() X-Ref

No description

DocumentOutline({onSelect,isTitleSupported,hasOutlineItemsDisabled}) X-Ref

Renders a document outline component.

return: {Component} The component to be rendered.
param: {Object}   props                         Props.
param: {Function} props.onSelect                Function to be called when an outline item is selected.
param: {boolean}  props.isTitleSupported        Indicates whether the title is supported.
param: {boolean}  props.hasOutlineItemsDisabled Indicates whether the outline items are disabled.

DocumentOutlineCheck({children}) X-Ref

Component check if there are any headings (core/heading blocks) present in the document.

return: {Component|null} The component to be rendered or null if there are headings.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

EditorKeyboardShortcutsRegister() X-Ref

Component for registering editor keyboard shortcuts.

return: {Element} The component to be rendered.

EditorHistoryRedo(props, ref) X-Ref

Internal dependencies

EditorHistoryUndo(props, ref) X-Ref

Internal dependencies

TemplateValidationNotice() X-Ref

No description

EditorNotices() X-Ref

No description

EditorSnackbars() X-Ref

Renders the editor snackbars component.

return: {JSX.Element} The rendered component.

EntityRecordItem({record,checked,onChange}) X-Ref

No description

getEntityDescription(entity, count) X-Ref

No description

GlobalStylesDescription({record}) X-Ref

No description

EntityDescription({record,count}) X-Ref

No description

EntityTypeList({list,unselectedEntities,setUnselectedEntities}) X-Ref

No description

identity(values) X-Ref

No description

EntitiesSavedStates({close,renderDialog = undefined}) X-Ref

Renders the component for managing saved states of entities.

return: {JSX.Element} The rendered component.
param: {Object} props The component props.
param: {Function} props.close The function to close the dialog.
param: {Function} props.renderDialog The function to render the dialog.

EntitiesSavedStatesExtensible({additionalPrompt = undefined,close,onSave = identity,saveEnabled: saveEnabledProp = undefined,saveLabel = (0,external_wp_i18n_namespaceObject.__) X-Ref

Renders a panel for saving entities with dirty records.

return: {JSX.Element} The rendered component.
param: {Object}   props                       The component props.
param: {string}   props.additionalPrompt      Additional prompt to display.
param: {Function} props.close                 Function to close the panel.
param: {Function} props.onSave                Function to call when saving entities.
param: {boolean}  props.saveEnabled           Flag indicating if save is enabled.
param: {string}   props.saveLabel             Label for the save button.
param: {Function} props.renderDialog          Function to render a custom dialog.
param: {Array}    props.dirtyEntityRecords    Array of dirty entity records.
param: {boolean}  props.isDirty               Flag indicating if there are dirty entities.
param: {Function} props.setUnselectedEntities Function to set unselected entities.
param: {Array}    props.unselectedEntities    Array of unselected entities.

getContent() X-Ref

Internal dependencies

CopyButton({text,children}) X-Ref

No description

Class: ErrorBoundary - X-Ref

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({children}) X-Ref

Wrapper component that renders its children only if the post type supports page attributes.

return: {Component|null} The rendered child components or null if page attributes are not supported.
param: {Object} props - The component props.
param: {Element} props.children - The child components to render.

PostTypeSupportCheck({children,supportKeys}) X-Ref

A component which renders its own children only if the current editor post
type supports one of the given `supportKeys` prop.

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

PageAttributesOrder() X-Ref

No description

PageAttributesOrderWithChecks() X-Ref

Renders the Page Attributes Order component. A number input in an editor interface
for setting the order of a given page.
The component is now not used in core but was kept for backward compatibility.

return: {Component} The component to be rendered.

buildTermsTree(flatTerms) X-Ref

Returns terms in a tree form.

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

getTitle(post) X-Ref

No description

PageAttributesParent() X-Ref

Renders the Page Attributes Parent component. A dropdown menu in an editor interface
for selecting the parent page of a given page.

return: {Component|null} The component to be rendered. Return null if post type is not hierarchical.

PostParentToggle({isOpen,onClick}) X-Ref

No description

ParentRow() X-Ref

No description

AttributesPanel() X-Ref

No description

PageAttributesPanel() X-Ref

Renders the Page Attributes Panel component.

return: {Component} The component to be rendered.

CreateNewTemplateModal({onClose}) X-Ref

No description

useEditedPostContext() X-Ref

Internal dependencies

useAllowSwitchingTemplates() X-Ref

No description

useTemplates(postType) X-Ref

No description

useAvailableTemplates(postType) X-Ref

No description

useCurrentTemplateSlug() X-Ref

No description

PostTemplateToggle({isOpen,onClick}) X-Ref

No description

PostTemplateDropdownContent({onClose}) X-Ref

Renders the dropdown content for selecting a post template.

return: {JSX.Element} The rendered dropdown content.
param: {Object} props The component props.
param: {Function} props.onClose The function to close the dropdown.

ClassicThemeControl() X-Ref

No description

PluginSidebar({className,...props}) X-Ref

Renders a sidebar when activated. The contents within the `PluginSidebar` will appear as content within the sidebar.
It also automatically renders a corresponding `PluginSidebarMenuItem` component when `isPinnable` flag is set to `true`.
If you wish to display the sidebar, you can with use the `PluginSidebarMoreMenuItem` component or the `wp.data.dispatch` API:

```js
wp.data.dispatch( 'core/edit-post' ).openGeneralSidebar( 'plugin-name/sidebar-name' );
```

param: {Object}                props                                 Element props.
param: {string}                props.name                            A string identifying the sidebar. Must be unique for every sidebar registered within the scope of your plugin.
param: {string}                [props.className]                     An optional class name added to the sidebar body.
param: {string}                props.title                           Title displayed at the top of the sidebar.
param: {boolean}               [props.isPinnable=true]               Whether to allow to pin sidebar to the toolbar. When set to `true` it also automatically renders a corresponding menu item.
param: {WPBlockTypeIconRender} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered when the sidebar is pinned to toolbar.

PluginSidebarMoreMenuItem(props) X-Ref

Renders a menu item in `Plugins` group in `More Menu` drop down,
and can be used to activate the corresponding `PluginSidebar` component.
The text within the component appears as the menu item label.

return: {Component} The component to be rendered.
param: {Object} props Component props.
param: {string} props.target A string identifying the target sidebar you wish to be activated by this menu item. Must be the same as the `name` prop you have given to that sidebar.
param: {WPBlockTypeIconRender} [props.icon=inherits from the plugin] The [Dashicon](https://developer.wordpress.org/resource/dashicons/) icon slug string, or an SVG WP element, to be rendered to the left of the menu item label.

SwapTemplateButton({onClick}) X-Ref

No description

TemplatesList({postType,onSelect}) X-Ref

No description

ResetDefaultTemplate({onClick}) X-Ref

Internal dependencies

CreateNewTemplate({onClick}) X-Ref

No description

BlockThemeControl({id}) X-Ref

No description

PostTemplatePanel() X-Ref

Displays the template controls based on the current editor settings and user permissions.

return: {JSX.Element|null} The rendered PostTemplatePanel component.

useAuthorsQuery(search) X-Ref

Internal dependencies

PostAuthorCombobox() X-Ref

No description

PostAuthorSelect() X-Ref

No description

PostAuthor() X-Ref

Renders the component for selecting the post author.

return: {Component} The component to be rendered.

PostAuthorCheck({children}) X-Ref

Wrapper component that renders its children only if the post type supports the author.

return: {Component|null} The component to be rendered. Return `null` if the post type doesn't
param: {Object} props The component props.
param: {Element} props.children Children to be rendered.

PostAuthorToggle({isOpen,onClick}) X-Ref

No description

panel_PostAuthor() X-Ref

Renders the Post Author Panel component.

return: {Component} The component to be rendered.

PostComments() X-Ref

No description

PostPingbacks() X-Ref

Internal dependencies

ModalContents({onClose}) X-Ref

No description

PostDiscussionToggle({isOpen,onClick}) X-Ref

No description

PostDiscussionPanel() X-Ref

This component allows to update comment and pingback
settings for the current post. Internally there are
checks whether the current post has support for the
above and if the `discussion-panel` panel is enabled.

return: {JSX.Element|null} The rendered PostDiscussionPanel component.

PostExcerpt({hideLabelFromVision = false,updateOnBlur = false}) X-Ref

Renders an editable textarea for the post excerpt.
Templates, template parts and patterns use the `excerpt` field as a description semantically.
Additionally templates and template parts override the `excerpt` field as `description` in
REST API. So this component handles proper labeling and updating the edited entity.

param: {Object} props - Component props.
param: {boolean} [props.hideLabelFromVision=false] - Whether to visually hide the textarea's label.
param: {boolean} [props.updateOnBlur=false] - Whether to update the post on change or use local state and update on blur.

PostExcerptCheck({children}) X-Ref

Component for checking if the post type supports the excerpt field.

return: {Component} The component to be rendered.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

ExcerptPanel() X-Ref

No description

PostExcerptPanel() X-Ref

Is rendered if the post type supports excerpts and allows editing the excerpt.

return: {JSX.Element} The rendered PostExcerptPanel component.

PrivatePostExcerptPanel() X-Ref

No description

PrivateExcerpt() X-Ref

No description

ThemeSupportCheck({children,supportKeys}) X-Ref

Checks if the current theme supports specific features and renders the children if supported.

return: {JSX.Element|null} The rendered children if the theme supports the specified features, otherwise null.
param: {Object} props The component props.
param: {Element} props.children The children to render if the theme supports the specified features.
param: {string|string[]} props.supportKeys The key(s) of the theme support(s) to check.

PostFeaturedImageCheck({children}) X-Ref

Wrapper component that renders its children only if the post type supports a featured image
and the theme supports post thumbnails.

return: {Component} The component to be rendered.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

getMediaDetails(media, postId) X-Ref

No description

PostFeaturedImage({currentPostId,featuredImageId,onUpdateImage,onRemoveImage,media,postType,noticeUI,noticeOperations}) X-Ref

No description

onDropFiles(filesList) X-Ref

No description

PostFeaturedImagePanel({withPanelBody = true}) X-Ref

Renders the panel for the post featured image.

return: {Component|null} The component to be rendered.
param: {Object} props Props.
param: {boolean} props.withPanelBody Whether to include the panel body. Default true.

PostFormatCheck({children}) X-Ref

No description

PostFormat() X-Ref

`PostFormat` a component that allows changing the post format while also providing a suggestion for the current post.

return: {JSX.Element} The rendered PostFormat component.

PostLastRevisionCheck({children}) X-Ref

Wrapper component that renders its children if the post has more than one revision.

return: {Component|null} Rendered child components if post has more than one revision, otherwise null.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

usePostLastRevisionInfo() X-Ref

No description

PostLastRevision() X-Ref

Renders the component for displaying the last revision of a post.

return: {Component} The component to be rendered.

PrivatePostLastRevision() X-Ref

No description

PostLastRevisionPanel() X-Ref

Renders the panel for displaying the last revision of a post.

return: {Component} The component to be rendered.

PostLockedModal() X-Ref

No description

sendPostLock(data) X-Ref

Keep the lock refreshed.

When the user does not send a heartbeat in a heartbeat-tick
the user is no longer editing and another user can start editing.

param: {Object} data Data to send in the heartbeat request.

receivePostLock(data) X-Ref

Refresh post locks: update the lock string or show the dialog if somebody has taken over editing.

param: {Object} data Data received in the heartbeat request

releasePostLock() X-Ref

Unlock the post before the window is exited.

PostPendingStatusCheck({children}) X-Ref

This component checks the publishing status of the current post.
If the post is already published or the user doesn't have the
capability to publish, it returns null.

return: {JSX.Element|null} The rendered child elements or null if the post is already published or the user doesn't have the capability to publish.
param: {Object} props Component properties.
param: {Element} props.children Children to be rendered.

PostPendingStatus() X-Ref

A component for displaying and toggling the pending status of a post.

return: {JSX.Element} The rendered component.

writeInterstitialMessage(targetDocument) X-Ref

No description

PostPreviewButton({className,textContent,forceIsAutosaveable,role,onPreview}) X-Ref

Renders a button that opens a new window or tab for the preview,
writes the interstitial message to this window, and then navigates
to the actual preview link. The button is not rendered if the post
is not viewable and disabled if the post is not saveable.

return: {JSX.Element|null} The rendered button component.
param: {Object}   props                     The component props.
param: {string}   props.className           The class name for the button.
param: {string}   props.textContent         The text content for the button.
param: {boolean}  props.forceIsAutosaveable Whether to force autosave.
param: {string}   props.role                The role attribute for the button.
param: {Function} props.onPreview           The callback function for preview event.

PublishButtonLabel() X-Ref

Renders the label for the publish button.

return: {string} The label for the publish button.

Class: PostPublishButton - X-Ref

PostVisibility({onClose}) X-Ref

Allows users to set the visibility of a post.

return: {JSX.Element} The rendered component.
param: {Object} props The component props.
param: {Function} props.onClose Function to call when the popover is closed.

PostVisibilityChoice({instanceId,value,label,info,...props}) X-Ref

No description

PostVisibilityLabel() X-Ref

Returns the label for the current post visibility setting.

return: {string} Post visibility label.

usePostVisibilityLabel() X-Ref

Get the label for the current post visibility setting.

return: {string} Post visibility label.

toDate(argument) X-Ref

param: argument - The value to convert
returns: The parsed date in the local time zone

startOfMonth(date) X-Ref

param: date - The original date
returns: The start of a month

endOfMonth(date) X-Ref

param: date - The original date
returns: The end of a month

parseISO(argument, options) X-Ref

param: argument - The value to convert
param: options - An object with options
returns: The parsed date in the local time zone

splitDateString(dateString) X-Ref

No description

parseYear(dateString, additionalDigits) X-Ref

No description

parseDate(dateString, year) X-Ref

No description

parseDateUnit(value) X-Ref

No description

parseTime(timeString) X-Ref

No description

parseTimeUnit(value) X-Ref

No description

parseTimezone(timezoneString) X-Ref

No description

dayOfISOWeekYear(isoWeekYear, week, day) X-Ref

No description

isLeapYearIndex(year) X-Ref

No description

validateDate(year, month, date) X-Ref

No description

validateDayOfYearDate(year, dayOfYear) X-Ref

No description

validateWeekDate(_year, week, day) X-Ref

No description

validateTime(hours, minutes, seconds) X-Ref

No description

validateTimezone(_hours, minutes) X-Ref

No description

PostSchedule(props) X-Ref

Renders the PostSchedule component. It allows the user to schedule a post.

return: {Component} The component to be rendered.
param: {Object} props Props.
param: {Function} props.onClose Function to close the component.

PrivatePostSchedule({onClose,showPopoverHeaderActions,isCompact}) X-Ref

No description

PostScheduleLabel(props) X-Ref

Renders the PostScheduleLabel component.

return: {Component} The component to be rendered.
param: {Object} props Props.

usePostScheduleLabel({full = false} = {}) X-Ref

Custom hook to get the label for post schedule.

return: {string} The label for post schedule.
param: {Object} options Options for the hook.
param: {boolean} options.full Whether to get the full label or not. Default is false.

getFullPostScheduleLabel(dateAttribute) X-Ref

No description

getPostScheduleLabel(dateAttribute, {isFloating = false,now = new Date() X-Ref

No description

getTimezoneAbbreviation() X-Ref

No description

isTimezoneSameAsSiteTimezone(date) X-Ref

No description

isSameDay(left, right) X-Ref

No description

MostUsedTerms({onSelect,taxonomy}) X-Ref

No description

FlatTermSelector({slug,__nextHasNoMarginBottom}) X-Ref

Renders a flat term selector component.

return: {JSX.Element} The rendered flat term selector component.
param: {Object} props The component props.
param: {string} props.slug The slug of the taxonomy.
param: {boolean} props.__nextHasNoMarginBottom Start opting into the new margin-free styles that will become the default in a future version, currently scheduled to be WordPress 7.0. (The prop can be safely removed once this happens.)

onUpdateTerms(newTermIds) X-Ref

No description

onChange(termNames) X-Ref

No description

appendTerm(newTerm) X-Ref

No description

PostFormatPanel() X-Ref

No description

sortBySelected(termsTree, terms) X-Ref

Sort Terms by Selected.

return: {Object[]} Sorted array of terms.
param: {Object[]} termsTree Array of terms in tree format.
param: {number[]} terms Selected terms.

findTerm(terms, parent, name) X-Ref

Find term by parent id or name.

return: {Object} Term object.
param: {Object[]} terms Array of Terms.
param: {number|string} parent id.
param: {string} name Term name.

getFilterMatcher(filterValue) X-Ref

Get filter matcher function.

return: {(function(Object): (Object|boolean))} Matcher function.
param: {string} filterValue Filter value.

HierarchicalTermSelector({slug}) X-Ref

Hierarchical term selector.

return: {Element} Hierarchical term selector component.
param: {Object} props Component props.
param: {string} props.slug Taxonomy slug.

MaybeCategoryPanel() X-Ref

No description

rng() X-Ref

No description

unsafeStringify(arr, offset = 0) X-Ref

No description

stringify(arr, offset = 0) X-Ref

No description

v4(options, buf, offset) X-Ref

No description

generateUniqueBasenames(urls) X-Ref

Generate a list of unique basenames given a list of URLs.

We want all basenames to be unique, since sometimes the extension
doesn't reflect the mime type, and may end up getting changed by
the server, on upload.

return: {Record< string, string >} A URL => basename record.
param: {string[]} urls The list of URLs

fetchMedia(urls) X-Ref

Fetch a list of URLs, turning those into promises for files with
unique filenames.

return: {Record< string, Promise< File > >} A URL => File promise record.
param: {string[]} urls The list of URLs

flattenBlocks(blocks) X-Ref

No description

hasExternalMedia(block) X-Ref

Determine whether a block has external media.

Different blocks use different attribute names (and potentially
different logic as well) in determining whether the media is
present, and whether it's external.

return: {boolean?} Whether the block has external media
param: {{name: string, attributes: Object}} block The block.

getMediaInfo(block) X-Ref

Retrieve media info from a block.

Different blocks use different attribute names, so we need this
function to normalize things into a consistent naming scheme.

return: {{url: ?string, alt: ?string, id: ?number}} The media info for the block.
param: {{name: string, attributes: Object}} block The block.

Image({clientId,alt,url}) X-Ref

No description

MaybeUploadMediaPanel() X-Ref

No description

updateBlockWithUploadedMedia(block, media) X-Ref

Update an individual block to point to newly-added library media.

Different blocks use different attribute names, so we need this
function to ensure we modify the correct attributes for each type.

param: {{name: string, attributes: Object}} block The block.
param: {{id: number, url: string}} media Media library file info.

uploadImages() X-Ref

No description

PostPublishPanelPrepublish({children}) X-Ref

No description

postpublish_CopyButton({text,onCopy,children}) X-Ref

No description

Class: PostPublishPanelPostpublish - X-Ref

Class: PostPublishPanel - X-Ref

Icon({icon,size = 24,...props}, ref) X-Ref

Return an SVG icon.

return: {JSX.Element}  Icon component
param: {IconProps}                                 props icon is the SVG component to render
param: {import('react').ForwardedRef<HTMLElement>} ref   The forwarded ref to the SVG element.

PostStickyCheck({children}) X-Ref

Wrapper component that renders its children only if post has a sticky action.

return: {Component} The component to be rendered or null if post type is not 'post' or hasStickyAction is false.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

PostSticky() X-Ref

Renders the PostSticky component. It provides a checkbox control for the sticky post feature.

return: {Component} The component to be rendered.

PostStatus() X-Ref

No description

PostSavedState({forceIsDirty}) X-Ref

Component showing whether the post is saved or not and providing save
buttons.

return: {import('react').ComponentType} The component.
param: {Object} props Component props.
param: {?boolean} props.forceIsDirty Whether to force the post to be marked

PostScheduleCheck({children}) X-Ref

Wrapper component that renders its children only if post has a publish action.

return: {Component} - The component to be rendered or null if there is no publish action.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

PostSchedulePanel() X-Ref

Renders the Post Schedule Panel component.

return: {Component} The component to be rendered.

PostSlugCheck({children}) X-Ref

Wrapper component that renders its children only if the post type supports the slug.

return: {Component} The component to be rendered.
param: {Object} props Props.
param: {Element} props.children Children to be rendered.

PostSlugControl() X-Ref

No description

PostSlug() X-Ref

Renders the PostSlug component. It provide a control for editing the post slug.

return: {Component} The component to be rendered.

PostSwitchToDraftButton() X-Ref

No description

PostSyncStatus() X-Ref

Renders the sync status of a post.

return: {JSX.Element|null} The rendered sync status component.

PostTaxonomies({taxonomyWrapper = post_taxonomies_identity}) X-Ref

No description

PostTaxonomiesCheck({children}) X-Ref

Renders the children components only if the current post type has taxonomies.

return: {Component|null} The rendered children components or null if the current post type has no taxonomies.
param: {Object} props The component props.
param: {Element} props.children The children components to render.

TaxonomyPanel({taxonomy,children}) X-Ref

No description

panel_PostTaxonomies() X-Ref

No description

PostTextEditor() X-Ref

No description

usePostTitleFocus(forwardedRef) X-Ref

Custom hook that manages the focus behavior of the post title input field.

return: {Object} - The ref object.
param: {Element} forwardedRef - The forwarded ref for the input field.

usePostTitle() X-Ref

Custom hook for managing the post title in the editor.

return: {Object} An object containing the current title and a function to update the title.

updateTitle(newTitle) X-Ref

No description

PostTitle(_, forwardedRef) X-Ref

No description

onInsertBlockAfter(blocks) X-Ref

No description

onSelect() X-Ref

No description

onUnselect() X-Ref

No description

onEnterPress() X-Ref

No description

onKeyDown(event) X-Ref

No description

onPaste(event) X-Ref

No description

PostTitleRaw(_, forwardedRef) X-Ref

Renders a raw post title input field.

return: {Component} The rendered component.
param: {Object} _ Unused parameter.
param: {Element} forwardedRef Reference to the component's DOM node.

onChange(value) X-Ref

No description

onSelect() X-Ref

No description

onUnselect() X-Ref

No description

PostTrashCheck({children}) X-Ref

Wrapper component that renders its children only if the post can trashed.

return: {Component|null} The rendered child components or null if the post can not trashed.
param: {Object} props - The component props.
param: {Element} props.children - The child components to render.

PostTrash({onActionPerformed}) X-Ref

Displays the Post Trash Button and Confirm Dialog in the Editor.

return: {JSX.Element|null} The rendered PostTrash component.
param: {?{onActionPerformed: Object}} An object containing the onActionPerformed function.

PostURL({onClose}) X-Ref

Renders the `PostURL` component.

return: {Component} The rendered PostURL component.
param: {Function} onClose Callback function to be executed when the popover is closed.

PostURLCheck({children}) X-Ref

Check if the post URL is valid and visible.

return: {Component|null} The child components if the post URL is valid and visible, otherwise null.
param: {Object} props The component props.
param: {Element} props.children The child components.

PostURLLabel() X-Ref

Represents a label component for a post URL.

return: {Component} The PostURLLabel component.

usePostURLLabel() X-Ref

Custom hook to get the label for the post URL.

return: {string} The filtered and decoded post URL label.

PostURLPanel() X-Ref

Renders the `PostURLPanel` component.

return: {JSX.Element} The rendered PostURLPanel component.

PostURLToggle({isOpen,onClick}) X-Ref

No description

PostVisibilityCheck({render}) X-Ref

Determines if the current post can be edited (published)
and passes this information to the provided render function.

return: {JSX.Element} The rendered component.
param: {Object} props The component props.
param: {Function} props.render Function to render the component.

WordCount() X-Ref

Renders the word count of the post content.

return: {JSX.Element|null} The rendered WordCount component.

TimeToRead() X-Ref

Component for showing Time To Read in Content.

return: {JSX.Element} The rendered TimeToRead component.

CharacterCount() X-Ref

Renders the character count of the post content.

return: {number} The character count.

TableOfContentsPanel({hasOutlineItemsDisabled,onRequestClose}) X-Ref

No description

TableOfContents({hasOutlineItemsDisabled,repositionDropdown,...props}, ref) X-Ref

Internal dependencies

UnsavedChangesWarning() X-Ref

Warns the user if there are unsaved changes before leaving the editor.
Compatible with Post Editor and Site Editor.

return: {Component} The component.

getSubRegistry(subRegistries, registry, useSubRegistry) X-Ref

Internal dependencies

mediaUpload({additionalData = {},allowedTypes,filesList,maxUploadFileSize,onError = media_upload_noop,onFileChange}) 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.

isObject(o) X-Ref

No description

isPlainObject(o) X-Ref

No description

mergeBaseAndUserConfigs(base, user) X-Ref

No description

useGlobalStylesUserConfig() X-Ref

No description

useGlobalStylesBaseConfig() X-Ref

No description

useGlobalStylesContext() X-Ref

No description

GlobalStylesProvider({children}) X-Ref

No description

__experimentalReusableBlocksSelect(select) X-Ref

No description

useBlockEditorSettings(settings, postType, postId, renderingMode) X-Ref

React hook used to compute the block editor settings to use for the post editor.

return: {Object} Block Editor Settings.
param: {Object} settings      EditorProvider settings prop.
param: {string} postType      Editor root level post type.
param: {string} postId        Editor root level post ID.
param: {string} renderingMode Editor rendering mode.

getSectionRootBlock() X-Ref

No description

DisableNonPageContentBlocks() X-Ref

Component that when rendered, makes it so that the site editor allows only
page content to be edited.

NavigationBlockEditingMode() X-Ref

For the Navigation block editor, we need to force the block editor to contentOnly for that block.

Set block editing mode to contentOnly when entering Navigation focus mode.
this ensures that non-content controls on the block will be hidden and thus
the user can focus on editing the Navigation Menu content only.

useHideBlocksFromInserter(postType, mode) X-Ref

In some specific contexts,
the template part and post content blocks need to be hidden.

param: {string} postType Post Type
param: {string} mode Rendering mode

PatternRenameModal() X-Ref

No description

PatternDuplicateModal() X-Ref

No description

useEditorCommandLoader() X-Ref

No description

useEditedEntityContextualCommands() X-Ref

No description

useCommands() X-Ref

No description

BlockRemovalWarnings() X-Ref

No description

useStartPatterns() X-Ref

No description

PatternSelection({blockPatterns,onChoosePattern}) X-Ref

No description

StartPageOptionsModal({onClose}) X-Ref

No description

StartPageOptions() X-Ref

No description

KeyCombination({keyCombination,forceAriaLabel}) X-Ref

No description

Shortcut({description,keyCombination,aliases = [],ariaLabel}) X-Ref

No description

DynamicShortcut({name}) X-Ref

Internal dependencies

KeyboardShortcutHelpModal() X-Ref

No description

ContentOnlySettingsMenuItems({clientId,onClose}) X-Ref

No description

TemplateLockContentOnlyMenuItems({clientId,onClose}) X-Ref

No description

ContentOnlySettingsMenu() X-Ref

No description

useFallbackTemplateContent(slug, isCustom = false) X-Ref

No description

start_template_options_useStartPatterns(fallbackContent) X-Ref

No description

injectThemeAttributeInBlockTemplateContent(block) X-Ref

No description

start_template_options_PatternSelection({fallbackContent,onChoosePattern,postType}) X-Ref

No description

StartModal({slug,isCustom,onClose,postType}) X-Ref

No description

StartTemplateOptions() X-Ref

No description

ConvertToRegularBlocks({clientId,onClose}) X-Ref

No description

ConvertToTemplatePart({clientIds,blocks}) X-Ref

No description

TemplatePartMenuItems() X-Ref

No description

TemplatePartConverterMenuItem({clientIds,onClose}) X-Ref

No description

useBlockEditorProps(post, template, mode) X-Ref

Depending on the post, template and template mode,
returns the appropriate blocks and change handlers for the block editor provider.

return: {Array} Block editor props.
param: {Array} post Block list.
param: {boolean} template Whether the page content has focus (and the surrounding template is inert). If `true` return page content blocks. Default `false`.
param: {string} mode Rendering mode.

EditorProvider(props) X-Ref

This component establishes a new post editing context, and serves as the entry point for a new post editor (or post with template editor).

It supports a large number of post types, including post, page, templates,
custom post types, patterns, template parts.

All modification and changes are performed to the `@wordpress/core-data` store.

return: {JSX.Element} The rendered EditorProvider component.
param: {Object}  props                      The component props.
param: {Object}  [props.post]               The post object to edit. This is required.
param: {Object}  [props.__unstableTemplate] The template object wrapper the edited post.
param: {Object}  [props.settings]           The settings object to use for the editor.
param: {Element} [props.children]           Children elements for which the BlockEditorProvider context should apply.

deprecateComponent(name, Wrapped, staticsToHoist = []) X-Ref

No description

deprecateFunction(name, func) X-Ref

No description

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 and underscores. Converts remaining string to lowercase.
It does not account for octets, HTML entities, or other encoded characters.

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

CollapsibleBlockToolbar({isCollapsed,onToggle}) X-Ref

No description

DocumentTools({className,disableBlockTools = false}) X-Ref

No description

CopyContentMenuItem() X-Ref

Internal dependencies

getText() X-Ref

No description

onSuccess() X-Ref

No description

ModeSwitcher() X-Ref

No description

MoreMenu() X-Ref

No description

PostPublishButtonOrToggle({forceIsDirty,hasPublishAction,isBeingScheduled,isPending,isPublished,isPublishSidebarEnabled,isPublishSidebarOpened,isScheduled,togglePublishSidebar,setEntitiesSavedStatesCallback,postStatusHasChanged,postStatus}) X-Ref

No description

PostViewLink() X-Ref

Internal dependencies

PreviewDropdown({forceIsAutosaveable,disabled}) X-Ref

No description

Header({customSaveButton,forceIsDirty,forceDisableBlockTools,setEntitiesSavedStatesCallback,title,isEditorIframed}) X-Ref

No description

InserterSidebar() X-Ref

No description

ListViewOutline() X-Ref

No description

ListViewSidebar() X-Ref

No description

handleSidebarFocus(currentTab) X-Ref

No description

SavePublishPanels({setEntitiesSavedStatesCallback,closeEntitiesSavedStates,isEntitiesSavedStatesOpen,forceIsDirtyPublishPanel}) X-Ref

No description

TextEditor({autoFocus = false}) X-Ref

No description

EditTemplateBlocksNotification({contentRef}) X-Ref

Component that:

- Displays a 'Edit your template to edit this block' notification when the
user is focusing on editing page content and clicks on a disabled template
block.
- Displays a 'Edit your template to edit this block' dialog when the user
is focusing on editing page conetnt and double clicks on a disabled
template block.

param: {Object} props
param: {import('react').RefObject<HTMLElement>} props.contentRef Ref to the block

ResizeHandle({direction,resizeWidthBy}) X-Ref

No description

handleKeyDown(event) X-Ref

No description

ResizableEditor({className,enableResizing,height,children}) X-Ref

No description

clamp(value, min, max) X-Ref

Internal dependencies

distanceFromRect(x, y, rect) X-Ref

No description

useSelectNearestEditableBlock({isEnabled = true} = {}) X-Ref

No description

getPostContentAttributes(blocks) X-Ref

Given an array of nested blocks, find the first Post Content
block inside it, recursing through any nesting levels,
and return its attributes.

return: {Object | undefined} The Post Content block.
param: {Array} blocks A list of blocks.

checkForPostContentAtRootLevel(blocks) X-Ref

No description

VisualEditor({autoFocus,styles,disableIframe = false,iframeProps,contentRef,className}) X-Ref

No description

EditorInterface({className,styles,children,forceIsDirty,contentRef,disableIframe,autoFocus,customSaveButton,customSavePanel,forceDisableBlockTools,title,iframeProps}) X-Ref

No description

PatternOverridesPanel() X-Ref

No description

usePostActions({postType,onActionPerformed,context}) X-Ref

No description

PostActions({postType,postId,onActionPerformed}) X-Ref

No description

DropdownMenuItemTrigger({action,onClick,items}) X-Ref

No description

ActionWithModal({action,item,ActionTrigger,onClose}) X-Ref

No description

ActionsDropdownMenuGroup({actions,item,onClose}) X-Ref

No description

PostCardPanel({postType,postId,onActionPerformed}) X-Ref

No description

PostContentInformation() X-Ref

No description

panel_PostFormat() X-Ref

Renders the Post Author Panel component.

return: {Component} The component to be rendered.

PostLastEditedPanel() X-Ref

Internal dependencies

PostPanelSection({className,children}) X-Ref

WordPress dependencies

BlogTitle() X-Ref

No description

PostsPerPage() X-Ref

No description

SiteDiscussion() X-Ref

No description

PostSummary({onActionPerformed}) X-Ref

No description

injectThemeAttributeInBlockTemplateContent(block, currentThemeStylesheet) X-Ref

No description

filterPatterns(patterns, template) X-Ref

Filter all patterns and return only the ones that are compatible with the current template.

return: {Array} Array of patterns that are compatible with the current template.
param: {Array} patterns An array of patterns.
param: {Object} template The current template.

preparePatterns(patterns, currentThemeStylesheet) X-Ref

No description

useAvailablePatterns(template) X-Ref

No description

post_transform_panel_TemplatesList({availableTemplates,onSelect}) X-Ref

No description

PostTransform() X-Ref

No description

PostTransformPanel() X-Ref

No description

TemplateContentPanel() X-Ref

No description

TemplatePartContentPanelInner() X-Ref

No description

TemplatePartContentPanel() X-Ref

No description

useAutoSwitchEditorSidebars() X-Ref

This listener hook monitors for block selection and triggers the appropriate
sidebar state.

Editor({postType,postId,templateId,settings,children,initialEdits,onActionPerformed,extraContent,extraSidebarPanels,...props}) X-Ref

No description

BlockTypesChecklist({blockTypes,value,onItemChange}) X-Ref

No description

BlockManagerCategory({title,blockTypes}) X-Ref

No description

BlockManager() X-Ref

No description

enableAllBlockTypes(newBlockTypes) X-Ref

No description

EditorPreferencesModal({extraSections = {}}) X-Ref

No description

PreferencesModalContents({extraSections = {}}) X-Ref

No description

getPostMetaFields(select, context) X-Ref

Gets a list of post meta fields with their values and labels
to be consumed in the needed callbacks.
If the value is not available based on context, like in templates,
it falls back to the default value, label, or key.

return: {Object} List of post meta fields with their value and label.
param: {Object} select The select function from the data store.
param: {Object} context The context provided.

registerCoreBlockBindingsSources() X-Ref

Function to register core block bindings sources provided by the editor.

api_registerEntityAction(kind, name, config) X-Ref

Registers a new DataViews action.

This is an experimental API and is subject to change.
it's only available in the Gutenberg plugin for now.

param: {string} kind Entity kind.
param: {string} name Entity name.
param: {Action} config Action configuration.

api_unregisterEntityAction(kind, name, actionId) X-Ref

Unregisters a DataViews action.

This is an experimental API and is subject to change.
it's only available in the Gutenberg plugin for now.

param: {string} kind Entity kind.
param: {string} name Entity name.
param: {string} actionId Action ID.

Functions

Functions that are not part of a class:

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

isNonNullObject(value) X-Ref

No description

isSpecial(value) X-Ref

No description

isReactElement(value) X-Ref

No description

emptyTarget(val) X-Ref

No description

cloneUnlessOtherwiseSpecified(value, options) X-Ref

No description

defaultArrayMerge(target, source, options) X-Ref

No description

getMergeFunction(key, options) X-Ref

No description

getEnumerableOwnPropertySymbols(target) X-Ref

No description

getKeys(target) X-Ref

No description

propertyIsOnObject(object, property) X-Ref

No description

propertyIsUnsafe(target, key) X-Ref

No description

mergeObject(target, source, options) X-Ref

No description

deepmerge(target, source, options) X-Ref

No description

lineHeight(node) X-Ref

Calculate the `line-height` of a given node

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

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

__() X-Ref

No description

TextareaAutosizeClass() X-Ref

A light replacement for built-in textarea component
which automaticaly adjusts its height to match the content

matcher(match) X-Ref

No description

__webpack_require__(moduleId) X-Ref

No description

isReady(state = {}, action) X-Ref

WordPress dependencies

actions(state = {}, action) 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.

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

hasSameKeys(a, b) X-Ref

Returns true if the two object arguments have the same keys, or false
otherwise.

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

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.

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

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.

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

postId(state = null, action) X-Ref

No description

templateId(state = null, action) X-Ref

No description

postType(state = null, action) X-Ref

No description

template(state = {isValid: true}, action) X-Ref

Reducer returning whether the post blocks match the defined template or not.

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

saving(state = {}, action) X-Ref

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

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

deleting(state = {}, action) X-Ref

Reducer returning deleting post request state.

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

postLock(state = {isLocked: false}, action) X-Ref

Reducer returning the post lock status.

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

postSavingLock(state = {}, action) X-Ref

Post saving lock.

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

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

postAutosavingLock(state = {}, action) X-Ref

Post autosaving lock.

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

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

editorSettings(state = EDITOR_SETTINGS_DEFAULTS, action) X-Ref

Reducer returning the post editor setting.

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

renderingMode(state = 'post-only', action) X-Ref

No description

deviceType(state = 'Desktop', action) X-Ref

Reducer returning the editing canvas device type.

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

removedPanels(state = [], action) X-Ref

Reducer storing the list of all programmatically removed panels.

return: {Array} Updated state.
param: {Array} state Current state.
param: {Object} action Action object.

blockInserterPanel(state = false, action) X-Ref

Reducer to set the block inserter panel open or closed.

Note: this reducer interacts with the list view panel reducer
to make sure that only one of the two panels is open at the same time.

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

listViewPanel(state = false, action) X-Ref

Reducer to set the list view panel open or closed.

Note: this reducer interacts with the inserter panel reducer
to make sure that only one of the two panels is open at the same time.

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

listViewToggleRef(state = {current: null}) X-Ref

This reducer does nothing aside initializing a ref to the list view toggle.
We will have a unique ref per "editor" instance.

return: {Object} Reference to the list view toggle button.
param: {Object} state

inserterSidebarToggleRef(state = {current: null}) X-Ref

This reducer does nothing aside initializing a ref to the inserter sidebar toggle.
We will have a unique ref per "editor" instance.

return: {Object} Reference to the inserter sidebar toggle button.
param: {Object} state

publishSidebarActive(state = false, action) X-Ref

No description

getTemplatePartIcon(iconName) X-Ref

Helper function to retrieve the corresponding icon by name.

return: {Object} The corresponding icon.
param: {string} iconName The name of the icon.

isEditedPostNew(state) X-Ref

Returns true if the currently edited post is yet to be saved, or false if
the post has been saved.

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

hasChangedContent(state) X-Ref

Returns true if content includes unsaved changes, or false otherwise.

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

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).

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

getCurrentPostType(state) X-Ref

Returns the post type of the post currently being edited.

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

getCurrentPostId(state) X-Ref

Returns the ID of the post currently being edited, or null if the post has
not yet been saved.

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

getCurrentTemplateId(state) X-Ref

Returns the template ID currently being rendered/edited

return: {string?} Template ID.
param: {Object} state Global application state.

getCurrentPostRevisionsCount(state) X-Ref

Returns the number of revisions of the post currently being edited.

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

getCurrentPostLastRevisionId(state) X-Ref

Returns the last revision ID of the post currently being edited,
or null if the post has no revisions.

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

getCurrentPostAttribute(state, attributeName) X-Ref

Returns an attribute value of the saved post.

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

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.

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

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".

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

isCurrentPostPending(state) X-Ref

Returns true if post is pending review.

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

isCurrentPostPublished(state, currentPost) X-Ref

Return true if the current post has already been published.

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

isCurrentPostScheduled(state) X-Ref

Returns true if post is already scheduled.

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

isEditedPostPublishable(state) X-Ref

Return true if the post being edited can be published.

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

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.

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

isEditedPostBeingScheduled(state) X-Ref

Return true if the post being edited is being scheduled. Preferring the
unsaved status values.

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

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.

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

isDeletingPost(state) X-Ref

Returns true if the post is currently being deleted, or false otherwise.

return: {boolean} Whether post is being deleted.
param: {Object} state Editor state.

isSavingPost(state) X-Ref

Returns true if the post is currently being saved, or false otherwise.

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

isAutosavingPost(state) X-Ref

Returns true if the post is autosaving, or false otherwise.

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

isPreviewingPost(state) X-Ref

Returns true if the post is being previewed, or false otherwise.

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

getEditedPostPreviewLink(state) X-Ref

Returns the post preview link

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

isPublishingPost(state) X-Ref

Returns true if the post is being published, or false otherwise.

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

isPermalinkEditable(state) X-Ref

Returns whether the permalink is editable or not.

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

getPermalink(state) X-Ref

Returns the permalink for the post.

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

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.

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

getPermalinkParts(state) X-Ref

Returns the permalink for a post, split into its three parts: the prefix,
the postName, and the suffix.

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

isPostLocked(state) X-Ref

Returns whether the post is locked.

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

isPostSavingLocked(state) X-Ref

Returns whether post saving is locked.

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

isPostAutosavingLocked(state) X-Ref

Returns whether post autosaving is locked.

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

isPostLockTakeover(state) X-Ref

Returns whether the edition of the post has been taken over.

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

getPostLockUser(state) X-Ref

Returns details about the post lock user.

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

getActivePostLock(state) X-Ref

Returns the active post lock.

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

canUserUseUnfilteredHTML(state) X-Ref

Returns whether or not the user has the unfiltered_html capability.

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

isEditorPanelRemoved(state, panelName) X-Ref

Returns true if the given panel was programmatically removed, or false otherwise.
All panels are not removed by default.

return: {boolean} Whether or not the panel is removed.
param: {Object} state Global application state.
param: {string} panelName A string that identifies the panel.

getEditorSelectionStart(state) X-Ref

Returns the current selection start.

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

getEditorSelectionEnd(state) X-Ref

Returns the current selection end.

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

getEditorSelection(state) X-Ref

Returns the current selection.

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

__unstableIsEditorReady(state) X-Ref

Is the editor ready

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

getEditorSettings(state) X-Ref

Returns the post editor settings.

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

getRenderingMode(state) X-Ref

Returns the post editor's rendering mode.

return: {string} Rendering mode.
param: {Object} state Editor state.

isListViewOpened(state) X-Ref

Returns true if the list view is opened.

return: {boolean} Whether the list view is opened.
param: {Object} state Global application state.

isInserterOpened(state) X-Ref

Returns true if the inserter is opened.

return: {boolean} Whether the inserter is opened.
param: {Object} state Global application state.

getStateBeforeOptimisticTransaction() 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.

inSomeHistory() X-Ref

Returns true if an optimistic transaction is pending commit, for which the
before state satisfies the given predicate function.

getBlockEditorSelector(name) X-Ref

No description

__experimentalGetDefaultTemplateTypes(state) X-Ref

Returns the default template types.

return: {Object} The template types.
param: {Object} state Global application state.

isPublishSidebarOpened(state) X-Ref

Returns true if the publish sidebar is opened.

return: {boolean} Whether the publish sidebar is open.
param: {Object} state Global application state

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.

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

localAutosaveGet(postId, isPostNew) X-Ref

No description

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

No description

localAutosaveClear(postId, isPostNew) X-Ref

No description

getNotificationArgumentsForSaveSuccess(data) X-Ref

Builds the arguments for a success notification dispatch.

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

getNotificationArgumentsForSaveFail(data) X-Ref

Builds the fail notification arguments for dispatch.

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

getNotificationArgumentsForTrashFail(data) X-Ref

Builds the trash fail notification arguments for dispatch.

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

__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() X-Ref

Returns an action object used in signalling that the latest version of the
post has been received, either by initialization or save.

updatePost() X-Ref

Returns an action object used in signalling that a patch of updates for the
latest version of the post have been received.

return: {Object} Action object.

setupEditorState(post) X-Ref

Setup the editor state.

param: {Object} post Post object.

setEditedPost(postType, postId) X-Ref

Returns an action that sets the current post Type and post ID.

return: {Object} Action object.
param: {string} postType Post Type.
param: {string} postId Post ID.

refreshPost() X-Ref

Action for refreshing the current post.

createUndoLevel() X-Ref

Action that creates an undo history record.

updatePostLock(lock) X-Ref

Action that locks the editor.

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

lockPostSaving(lockName) X-Ref

Action that locks post saving.

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

unlockPostSaving(lockName) X-Ref

Action that unlocks post saving.

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

lockPostAutosaving(lockName) X-Ref

Action that locks post autosaving.

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

unlockPostAutosaving(lockName) X-Ref

Action that unlocks post autosaving.

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

updateEditorSettings(settings) X-Ref

No description

setDeviceType(deviceType) X-Ref

Action that changes the width of the editing canvas.

return: {Object} Action object.
param: {string} deviceType

removeEditorPanel(panelName) X-Ref

Returns an action object used to remove a panel from the editor.

return: {Object} Action object.
param: {string} panelName A string that identifies the panel to remove.

setIsInserterOpened(value) X-Ref

Returns an action object used to open/close the inserter.

return: {Object} Action object.
param: {boolean|Object} value                Whether the inserter should be
param: {string}         value.rootClientId   The root client ID to insert at.
param: {number}         value.insertionIndex The index to insert at.

setIsListViewOpened(isOpen) X-Ref

Returns an action object used to open/close the list view.

return: {Object} Action object.
param: {boolean} isOpen A boolean representing whether the list view should be opened or closed.

openPublishSidebar() X-Ref

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

return: {Object} Action object

closePublishSidebar() X-Ref

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

return: {Object} Action object.

togglePublishSidebar() X-Ref

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

return: {Object} Action object

isTemplateRevertable(templateOrTemplatePart) X-Ref

Check if a template or template part is revertable to its original theme-provided file.

return: {boolean} Whether the entity is revertable.
param: {Object} templateOrTemplatePart The entity to check.

__extends(d, b) X-Ref

No description

__() X-Ref

No description

__rest(s, e) X-Ref

No description

__decorate(decorators, target, key, desc) X-Ref

No description

__param(paramIndex, decorator) X-Ref

No description

__esDecorate(ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) X-Ref

No description

accept(f) X-Ref

No description

__runInitializers(thisArg, initializers, value) X-Ref

No description

__propKey(x) X-Ref

No description

__setFunctionName(f, name, prefix) X-Ref

No description

__metadata(metadataKey, metadataValue) X-Ref

No description

__awaiter(thisArg, _arguments, P, generator) X-Ref

No description

adopt(value) X-Ref

No description

fulfilled(value) X-Ref

No description

rejected(value) X-Ref

No description

step(result) X-Ref

No description

__generator(thisArg, body) X-Ref

No description

verb(n) X-Ref

No description

step(op) X-Ref

No description

__exportStar(m, o) X-Ref

No description

__values(o) X-Ref

No description

__read(o, n) X-Ref

No description

__spread() X-Ref

No description

__spreadArrays() X-Ref

No description

__spreadArray(to, from, pack) X-Ref

No description

__await(v) X-Ref

No description

__asyncGenerator(thisArg, _arguments, generator) X-Ref

No description

awaitReturn(f) X-Ref

No description

verb(n, f) X-Ref

No description

resume(n, v) X-Ref

No description

step(r) X-Ref

No description

fulfill(value) X-Ref

No description

reject(value) X-Ref

No description

settle(f, v) X-Ref

No description

__asyncDelegator(o) X-Ref

No description

verb(n, f) X-Ref

No description

__asyncValues(o) X-Ref

No description

verb(n) X-Ref

No description

settle(resolve, reject, d, v) X-Ref

No description

__makeTemplateObject(cooked, raw) X-Ref

No description

__importStar(mod) X-Ref

No description

__importDefault(mod) X-Ref

No description

__classPrivateFieldGet(receiver, state, kind, f) X-Ref

No description

__classPrivateFieldSet(receiver, state, value, kind, f) X-Ref

No description

__classPrivateFieldIn(state, receiver) X-Ref

No description

__addDisposableResource(env, value, async) X-Ref

No description

__disposeResources(env) X-Ref

No description

fail(e) X-Ref

No description

next() X-Ref

No description

localeLowerCase(str, locale) X-Ref

Localized lower case.

lowerCase(str) X-Ref

Lower case as a function.

noCase(input, options) X-Ref

Normalize the string into something other libraries can manipulate easier.

replace(input, re, value) X-Ref

Replace `re` in the input string with the replacement value.

dotCase(input, options) X-Ref

No description

paramCase(input, options) X-Ref

No description

CreateTemplatePartModal({modalTitle,...restProps}) X-Ref

No description

CreateTemplatePartModalContents({defaultArea = TEMPLATE_PART_AREA_DEFAULT_CATEGORY,blocks = [],confirmLabel = (0,external_wp_i18n_namespaceObject.__) X-Ref

No description

isTemplate(post) X-Ref

Internal dependencies

isTemplatePart(post) X-Ref

No description

isTemplateOrTemplatePart(p) X-Ref

No description

getItemTitle(item) X-Ref

No description

isTemplateRemovable(template) X-Ref

Check if a template is removable.

return: Whether the template is removable.
param: template The template entity to check.

onTemplatePartSuccess() X-Ref

No description

sort(a, b, direction) X-Ref

Internal dependencies

isValid(value, context) X-Ref

No description

text_sort(valueA, valueB, direction) X-Ref

Internal dependencies

text_isValid(value, context) X-Ref

No description

datetime_sort(a, b, direction) X-Ref

Internal dependencies

datetime_isValid(value, context) X-Ref

No description

getFieldTypeDefinition(type) X-Ref

return: A field type definition.
param: {FieldType} type The field type definition to get.

DateTime({data,field,onChange,hideLabelFromVision}) X-Ref

Internal dependencies

Integer({data,field,onChange,hideLabelFromVision}) X-Ref

Internal dependencies

Radio({data,field,onChange,hideLabelFromVision}) X-Ref

Internal dependencies

Select({data,field,onChange,hideLabelFromVision}) X-Ref

Internal dependencies

Text({data,field,onChange,hideLabelFromVision}) X-Ref

Internal dependencies

getControl(field, fieldTypeDefinition) X-Ref

No description

getControlByType(type) X-Ref

No description

normalizeFields(fields) X-Ref

Apply default values and normalize the fields config.

return: Normalized fields config.
param: fields Fields config.

isItemValid(item, fields, form) X-Ref

Internal dependencies

FormRegular({data,fields,form,onChange}) X-Ref

Internal dependencies

DropdownHeader({title,onClose}) X-Ref

No description

FormField({data,field,onChange}) X-Ref

No description

FormPanel({data,fields,form,onChange}) X-Ref

No description

getFormLayout(type) X-Ref

No description

DataForm({form,...props}) X-Ref

No description

ReorderModal({items,closeModal,onActionPerformed}) X-Ref

No description

utils_isTemplate(post) X-Ref

No description

utils_isTemplatePart(post) X-Ref

No description

utils_isTemplateOrTemplatePart(p) X-Ref

No description

utils_getItemTitle(item) X-Ref

No description

utils_isTemplateRemovable(template) X-Ref

Check if a template is removable.

return: Whether the template is removable.
param: template The template entity to check.

getJsonFromItem(item) X-Ref

Internal dependencies

registerEntityAction(kind, name, config) X-Ref

No description

unregisterEntityAction(kind, name, actionId) X-Ref

No description

setIsReady(kind, name) X-Ref

No description

setCurrentTemplateId(id) X-Ref

Returns an action object used to set which template is currently being used/edited.

return: {Object} Action object.
param: {string} id Template Id.

getEntityActions(state, kind, name) X-Ref

Internal dependencies

isEntityReady(state, kind, name) X-Ref

No description

getListViewToggleRef(state) X-Ref

No description

getInserterSidebarToggleRef(state) X-Ref

No description

private_selectors_getEntityActions(state, ...args) X-Ref

No description

private_selectors_isEntityReady(state, ...args) X-Ref

No description

shimAttributeSource(settings) X-Ref

Filters a registered block's settings to enhance a block's `edit` component
to upgrade meta-sourced attributes to use the post's meta entity property.

return: {WPBlockSettings} Filtered block settings.
param: {WPBlockSettings} settings Registered block settings.

getUserLabel(user) X-Ref

No description

setDefaultCompleters(completers = []) X-Ref

Internal dependencies

ControlsWithStoreSubscription(props) X-Ref

No description

clsx_r(e) X-Ref

No description

normalizeComplementaryAreaScope(scope) X-Ref

WordPress dependencies

normalizeComplementaryAreaName(scope, name) X-Ref

No description

toggleFeature(scope, featureName) X-Ref

Returns an action object used in signalling that a feature should be toggled.

param: {string} scope The feature scope (e.g. core/edit-post).
param: {string} featureName The feature name.

setFeatureValue(scope, featureName, value) X-Ref

Returns an action object used in signalling that a feature should be set to
a true or false value

return: {Object} Action object.
param: {string}  scope       The feature scope (e.g. core/edit-post).
param: {string}  featureName The feature name.
param: {boolean} value       The value to set.

setFeatureDefaults(scope, defaults) X-Ref

Returns an action object used in signalling that defaults should be set for features.

return: {Object} Action object.
param: {string} scope The feature scope (e.g. core/edit-post).
param: {Object<string, boolean>} defaults A key/value map of feature names to values.

openModal(name) X-Ref

Returns an action object used in signalling that the user opened a modal.

return: {Object} Action object.
param: {string} name A string that uniquely identifies the modal.

closeModal() X-Ref

Returns an action object signalling that the user closed a modal.

return: {Object} Action object.

isModalActive(state, modalName) X-Ref

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

return: {boolean} Whether the modal is active.
param: {Object} state Global application state.
param: {string} modalName A string that uniquely identifies the modal.

complementaryAreas(state = {}, action) X-Ref

WordPress dependencies

activeModal(state = null, action) X-Ref

Reducer for storing the name of the open modal, or null if no modal is open.

return: {Object} Updated state
param: {Object} state Previous state.
param: {Object} action Action object containing the `name` of the modal

roleSupportsCheckedState(role) X-Ref

Whether the role supports checked state.

return: {boolean} Whether the role supports checked state.
param: {import('react').AriaRole} role Role.

ComplementaryAreaToggle({as = external_wp_components_namespaceObject.Button,scope,identifier,icon,selectedIcon,name,shortcut,...props}) X-Ref

No description

ActionItemSlot({name,as: Component = external_wp_components_namespaceObject.ButtonGroup,fillProps = {},bubblesVirtually,...props}) X-Ref

No description

ActionItem({name,as: Component = external_wp_components_namespaceObject.Button,onClick,...props}) X-Ref

No description

ComplementaryAreaMoreMenuItem({scope,target,__unstableExplicitMenuItem,...props}) X-Ref

No description

PinnedItems({scope,...props}) X-Ref

WordPress dependencies

PinnedItemsSlot({scope,className,...props}) X-Ref

No description

ComplementaryAreaSlot({scope,...props}) X-Ref

No description

ComplementaryAreaFill({activeArea,isActive,scope,children,className,id}) X-Ref

No description

useAdjustComplementaryListener(scope, identifier, activeArea, isActive, isSmall) X-Ref

No description

ComplementaryArea({children,className,closeLabel = (0,external_wp_i18n_namespaceObject.__) X-Ref

No description

useHTMLClass(className) X-Ref

No description

InterfaceSkeleton({isDistractionFree,footer,header,editorNotices,sidebar,secondarySidebar,content,actions,labels,className}, ref) X-Ref

No description

EditorKeyboardShortcuts() X-Ref

Handles the keyboard shortcuts for the editor.

It provides functionality for various keyboard shortcuts such as toggling editor mode,
toggling distraction-free mode, undo/redo, saving the post, toggling list view,
and toggling the sidebar.

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

PHP Cross Reference of WordPress Trunk (Updated Daily)

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

Defines 5 classes

Defines 158 functions