[ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 7853 lines (277 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
BrowserURL:: (15 methods):
FullscreenModeClose()
ModeSwitcher()
PreferencesMenuItem()
WritingMenu()
PostPublishButtonOrToggle()
Header()
PostVisibility()
PostVisibilityToggle()
PostTrash()
PostSticky()
PostSlug()
PostFormat()
PostPendingStatus()
PostStatus()
MetaBoxesArea()
MetaBoxVisibility:: (23 methods):
MetaBoxes()
PluginSidebarEditPost()
Icon()
TemplateSummary()
WelcomeGuideImage()
WelcomeGuideDefault()
WelcomeGuideTemplate()
WelcomeGuide()
ActionsPanel()
useStartPatterns()
PatternSelection()
StartPageOptionsModal()
StartPageOptions()
useCommonCommands()
useEditorStyles()
Layout()
onPluginAreaError()
EditorInitialization()
useNavigateToEntityRecord()
Editor()
PluginSidebarMoreMenuItem()
initializeEditor()
reinitializeEditor()
Class: BrowserURL - X-Ref
FullscreenModeClose({showTooltip,icon,href,initialPost}) X-Ref |
Internal dependencies |
ModeSwitcher() X-Ref |
No description |
PreferencesMenuItem() X-Ref |
Internal dependencies |
WritingMenu() X-Ref |
Internal dependencies |
PostPublishButtonOrToggle({forceIsDirty,hasPublishAction,isBeingScheduled,isPending,isPublished,isPublishSidebarEnabled,isPublishSidebarOpened,isScheduled,togglePublishSidebar,setEntitiesSavedStatesCallback}) X-Ref |
Internal dependencies |
Header({setEntitiesSavedStatesCallback,initialPost}) X-Ref |
No description |
PostVisibility() X-Ref |
No description |
PostVisibilityToggle({isOpen,onClick}) X-Ref |
No description |
PostTrash() X-Ref |
WordPress dependencies |
PostSticky() X-Ref |
No description |
PostSlug() X-Ref |
WordPress dependencies |
PostFormat() X-Ref |
WordPress dependencies |
PostPendingStatus() X-Ref |
No description |
PostStatus() X-Ref |
Module Constants |
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 |
PluginSidebarEditPost({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. |
Icon({icon,size = 24,...props}, ref) X-Ref |
Return an SVG icon. param: {IconProps} props icon is the SVG component to render param: {import('react').ForwardedRef<HTMLElement>} ref The forwarded ref to the SVG element. return: {JSX.Element} Icon component |
TemplateSummary() X-Ref |
No description |
WelcomeGuideImage({nonAnimatedSrc,animatedSrc}) X-Ref |
No description |
WelcomeGuideDefault() X-Ref |
Internal dependencies |
WelcomeGuideTemplate() X-Ref |
Internal dependencies |
WelcomeGuide() X-Ref |
No description |
ActionsPanel({setEntitiesSavedStatesCallback,closeEntitiesSavedStates,isEntitiesSavedStatesOpen}) X-Ref |
No description |
useStartPatterns() X-Ref |
Internal dependencies |
PatternSelection({blockPatterns,onChoosePattern}) X-Ref |
No description |
StartPageOptionsModal({onClose}) X-Ref |
No description |
StartPageOptions() X-Ref |
No description |
useCommonCommands() X-Ref |
No description |
useEditorStyles() X-Ref |
No description |
Layout({initialPost}) X-Ref |
No description |
onPluginAreaError(name) X-Ref |
No description |
EditorInitialization({postId}) X-Ref |
Data component used for initializing the editor and re-initializes when postId changes or on unmount. param: {number} postId The id of the post. return: {null} This is a data component so does not render any ui. |
useNavigateToEntityRecord(initialPostId, initialPostType) 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. return: {Object} An object containing the `currentPost` variable and |
Editor({postId: initialPostId,postType: initialPostType,settings,initialEdits,...props}) X-Ref |
No description |
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. 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. return: {Component} The component to be rendered. |
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. |
classNames() X-Ref |
No description |
__webpack_require__(moduleId) X-Ref |
No description |
findFirstOfSameType(blocks, name) X-Ref |
Recursively find very first block of an specific block type. param: {Object[]} blocks List of blocks. param: {string} name Block name to search. return: {Object|undefined} Return block object or undefined. |
getOutboundType(blockName) X-Ref |
Given a base block name, returns the default block type to which to offer transforms. param: {string} blockName Base block name. return: {?Object} The chosen default block type. |
CopyContentMenuItem() X-Ref |
No description |
getText() X-Ref |
No description |
onSuccess() 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 param: {string} scope The feature scope (e.g. core/edit-post). param: {string} featureName The feature name. param: {boolean} value The value to set. return: {Object} Action object. |
setFeatureDefaults(scope, defaults) X-Ref |
Returns an action object used in signalling that defaults should be set for features. 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. return: {Object} Action object. |
openModal(name) X-Ref |
Returns an action object used in signalling that the user opened a modal. param: {string} name A string that uniquely identifies the modal. return: {Object} Action object. |
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. param: {Object} state Global application state. param: {string} modalName A string that uniquely identifies the modal. return: {boolean} Whether the modal is active. |
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. param: {Object} state Previous state. param: {Object} action Action object containing the `name` of the modal return: {Object} Updated state |
ComplementaryAreaToggle({as = external_wp_components_namespaceObject.Button,scope,identifier,icon,selectedIcon,name,...props}) X-Ref |
Internal dependencies |
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({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 |
NavigableRegion({children,className,ariaLabel,as: Tag = 'div',...props}) X-Ref |
External dependencies |
useHTMLClass(className) X-Ref |
Internal dependencies |
InterfaceSkeleton({isDistractionFree,footer,header,editorNotices,sidebar,secondarySidebar,notices,content,actions,labels,className,enableRegionNavigation = true,shortcuts}, ref) X-Ref |
No description |
MoreMenuDropdown({as: DropdownComponent = external_wp_components_namespaceObject.DropdownMenu,className,label = (0,external_wp_i18n_namespaceObject.__) X-Ref |
No description |
KeyCombination({keyCombination,forceAriaLabel}) X-Ref |
WordPress dependencies |
Shortcut({description,keyCombination,aliases = [],ariaLabel}) X-Ref |
No description |
DynamicShortcut({name}) X-Ref |
Internal dependencies |
KeyboardShortcutHelpModal({isModalActive,toggleModal}) X-Ref |
No description |
KeyboardShortcutsHelpMenuItem({openModal}) X-Ref |
Internal dependencies |
WelcomeGuideMenuItem() X-Ref |
No description |
ManagePatternsMenuItem() X-Ref |
No description |
publishSidebarActive(state = false, action) X-Ref |
WordPress dependencies |
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. |
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 |
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. |
arrayOf(value) X-Ref |
Returns the first argument as the sole entry in an array. param: {T} value Value to return. return: {[T]} Value returned as entry in array. |
isObjectLike(value) X-Ref |
Returns true if the value passed is object-like, or false otherwise. A value is object-like if it can support property assignment, e.g. object or array. param: {*} value Value to test. return: {boolean} Whether value is object-like. |
createCache() X-Ref |
Creates and returns a new cache object. return: {Cache} Cache object. |
isShallowEqual(a, b, fromIndex) X-Ref |
Returns true if entries within the two arrays are strictly equal by reference from a starting index. param: {*[]} a First array. param: {*[]} b Second array. param: {number} fromIndex Index from which to start comparison. return: {boolean} Whether arrays are shallowly equal. |
rememo(selector, getDependants) X-Ref |
Returns a memoized selector function. The getDependants function argument is called before the memoized selector and is expected to return an immutable reference or array of references on which the selector depends for computing its own return value. The memoize cache is preserved only as long as those dependant references remain the same. If getDependants returns a different reference(s), the cache is cleared and the selector value regenerated. param: {S} selector Selector function. param: {GetDependants=} getDependants Dependant getter returning an array of |
getCache(dependants) X-Ref |
Returns the cache for a given dependants array. When possible, a WeakMap will be used to create a unique cache for each set of dependants. This is feasible due to the nature of WeakMap in allowing garbage collection to occur on entries where the key object is no longer referenced. Since WeakMap requires the key to be an object, this is only possible when the dependant is object-like. The root cache is created as a hierarchy where each top-level key is the first entry in a dependants set, the value a WeakMap where each key is the next dependant, and so on. This continues so long as the dependants are object-like. If no dependants are object- like, then the cache is shared across all invocations. param: {*[]} dependants Selector dependants. return: {Cache} Cache object. |
clear() X-Ref |
Resets root memoization cache. |
callSelector() X-Ref |
The augmented selector call, considering first whether dependants have changed before passing it to underlying memoize function. param: {*} source Source object for derivation. param: {...*} extraArgs Additional arguments to pass to selector. return: {*} Selector result. |
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. |
isPublishSidebarOpened(state) X-Ref |
Returns true if the publish sidebar is opened. param: {Object} state Global application state return: {boolean} Whether the publish sidebar is open. |
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. |
TextEditor() X-Ref |
Internal dependencies |
VisualEditor({styles}) X-Ref |
No description |
KeyboardShortcuts() X-Ref |
Internal dependencies |
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 |
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. |
getPostTrashedURL(postId, postType) X-Ref |
Returns the Post's Trashed URL. param: {number} postId Post ID. param: {string} postType Post Type. return: {string} Post trashed URL. |
Generated : Thu Mar 28 08:20:01 2024 | Cross-referenced by PHPXref |