PHPXRef 0.7.1 : WordPress : Detail view of edit-site.js

Check if a template is removable.

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

RenameMenuItem(_ref) X-Ref

No description

Actions(_ref) X-Ref

No description

CustomizedTooltip(_ref) X-Ref

No description

BaseAddedBy(_ref2) X-Ref

No description

AddedByTheme(_ref3) X-Ref

No description

AddedByPlugin(_ref4) X-Ref

No description

AddedByAuthor(_ref5) X-Ref

No description

AddedBySite() X-Ref

No description

AddedBy(_ref6) X-Ref

No description

Table(_ref) X-Ref

No description

List() X-Ref

No description

getIsListPage(_ref) X-Ref

Returns if the params match the list page route.

param: {Object} params The search params.
param: {string} params.postId The post ID.
param: {string} params.postType The post type.
return: {boolean} Is list page or not.

EditSiteApp(_ref) X-Ref

No description

onPluginAreaError(name) X-Ref

No description

PluginSidebarEditSite(_ref) 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-site' ).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.

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: {WPComponent} The component to be rendered.

reinitializeEditor(target, settings) X-Ref

Reinitializes the editor after the user chooses to reboot the editor after
an unhandled error occurs, replacing previously mounted editor element using
an initial state from prior to the crash.

param: {Element} target DOM node in which editor is rendered.
param: {?Object} settings Editor settings object.

initializeEditor(id, settings) X-Ref

Initializes the site editor screen.

param: {string} id ID of the root element to render the screen in.
param: {Object} settings Editor settings.

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

classNames() X-Ref

No description

dataUrlToBlob(strUrl) X-Ref

No description

saver(url, winMode) 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

__webpack_require__(moduleId) X-Ref

No description

deviceType() X-Ref

No description

settings() X-Ref

Reducer returning the settings.

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

editedPost() X-Ref

Reducer keeping track of the currently edited Post Type,
Post Id and the context provided to fill the content of the block editor.

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

homeTemplateId(state, action) X-Ref

Reducer for information about the site's homepage.

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

navigationPanel() X-Ref

Reducer for information about the navigation panel, such as its active menu
and whether it should be opened or closed.

Note: this reducer interacts with the inserter and list view panels reducers
to make sure that only one of the three panels is open at the same time.

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

blockInserterPanel() X-Ref

Reducer to set the block inserter panel open or closed.

Note: this reducer interacts with the navigation and list view panels reducers
to make sure that only one of the three panels is open at the same time.

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

listViewPanel() X-Ref

Reducer to set the list view panel open or closed.

Note: this reducer interacts with the navigation and inserter panels reducers
to make sure that only one of the three panels is open at the same time.

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

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

ComplementaryAreaToggle(_ref) X-Ref

No description

ActionItemSlot(_ref) X-Ref

No description

ActionItem(_ref3) X-Ref

No description

ComplementaryAreaMoreMenuItem(_ref) X-Ref

No description

PinnedItems(_ref) X-Ref

No description

PinnedItemsSlot(_ref2) X-Ref

No description

ComplementaryAreaSlot(_ref) X-Ref

No description

ComplementaryAreaFill(_ref2) X-Ref

No description

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

No description

ComplementaryArea(_ref3) X-Ref

No description

useHTMLClass(className) X-Ref

No description

InterfaceSkeleton(_ref, ref) X-Ref

No description

MoreMenuDropdown(_ref) X-Ref

No description

PreferencesModal(_ref) X-Ref

WordPress dependencies

Icon(_ref) X-Ref

Return an SVG icon.

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

PreferencesModalTabs(_ref) X-Ref

No description

BaseOption(_ref) X-Ref

WordPress dependencies

isTemplateRevertable(template) X-Ref

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

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

actions_toggleFeature(featureName) X-Ref

Dispatches an action that toggles a feature flag.

param: {string} featureName Feature name.

__experimentalSetPreviewDeviceType(deviceType) X-Ref

Action that changes the width of the editing canvas.

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

setTemplatePart(templatePartId) X-Ref

Action that sets a template part.

param: {string} templatePartId The template part ID.
return: {Object} Action object.

setHomeTemplateId(homeTemplateId) X-Ref

Action that sets the home template ID to the template ID of the page resolved
from a given path.

param: {number} homeTemplateId The template ID for the homepage.

setNavigationPanelActiveMenu(menu) X-Ref

Action that sets the active navigation panel menu.

param: {string} menu Menu prop of active menu.
return: {Object} Action object.

openNavigationPanelToMenu(menu) X-Ref

Opens the navigation panel and sets its active menu at the same time.

param: {string} menu Identifies the menu to open.

setIsNavigationPanelOpened(isOpen) X-Ref

Sets whether the navigation panel should be open.

param: {boolean} isOpen If true, opens the nav panel. If false, closes it. It

setIsInserterOpened(value) X-Ref

Opens or closes the inserter.

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.
return: {Object} Action object.

updateSettings(settings) X-Ref

Returns an action object used to update the settings.

param: {Object} settings New settings.
return: {Object} Action object.

setIsListViewOpened(isOpen) X-Ref

Sets whether the list view panel should be open.

param: {boolean} isOpen If true, opens the list view. If false, closes it.

arrayOf( value ) X-Ref

Returns the first argument as the sole entry in an array.

param: {*} value Value to return.
return: {Array} 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: {Object} 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: {Array} a First array.
param: {Array} 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: {Function} selector Selector function.
param: {Function} getDependants Dependant getter returning an immutable
return: {Function} Memoized selector.

getRootCache() X-Ref

Returns the root cache. If WeakMap is supported, this is assigned to the
root WeakMap cache set, otherwise it is a shared instance of the default
cache object.

return: {(WeakMap|Object)} Root cache object.

getWeakMapCache( 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: {Array} dependants Selector dependants.
return: {Object} 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: {Object} source Source object for derivation.
param: {...*} extraArgs Additional arguments to pass to selector.
return: {*} Selector result.

isTemplateSuperseded(slug, existingSlugs, showOnFront) X-Ref

Internal dependencies

getTemplateLocation(slug) X-Ref

No description

getUnusedTemplates(templates, showOnFront) X-Ref

No description

getTemplatesLocationMap(templates) X-Ref

No description

selectors_isFeatureActive(state, featureName) X-Ref

Returns whether the given feature is enabled or not.

param: {Object} state Global application state.
param: {string} featureName Feature slug.
return: {boolean} Is active.

__experimentalGetPreviewDeviceType(state) X-Ref

Returns the current editing canvas device type.

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

getHomeTemplateId(state) X-Ref

Returns the current home template ID.

param: {Object} state Global application state.
return: {number?} Home template ID.

getCurrentEditedPost(state) X-Ref

No description

getEditedPostType(state) X-Ref

Returns the current edited post type (wp_template or wp_template_part).

param: {Object} state Global application state.
return: {TemplateType?} Template type.

getEditedPostId(state) X-Ref

Returns the ID of the currently edited template or template part.

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

getPage(state) X-Ref

Returns the current page object.

param: {Object} state Global application state.
return: {Object} Page.

getNavigationPanelActiveMenu(state) X-Ref

Returns the active menu in the navigation panel.

param: {Object} state Global application state.
return: {string} Active menu.

isNavigationOpened(state) X-Ref

Returns the current opened/closed state of the navigation panel.

param: {Object} state Global application state.
return: {boolean} True if the navigation panel should be open; false if closed.

isInserterOpened(state) X-Ref

Returns the current opened/closed state of the inserter panel.

param: {Object} state Global application state.
return: {boolean} True if the inserter panel should be open; false if closed.

__experimentalGetInsertionPoint(state) X-Ref

Get the insertion point for the inserter.

param: {Object} state Global application state.
return: {Object} The root client ID, index to insert at and starting filter value.

isListViewOpened(state) X-Ref

Returns the current opened/closed state of the list view panel.

param: {Object} state Global application state.
return: {boolean} True if the list view panel should be open; false if closed.

getEditorMode(state) X-Ref

Returns the current editing mode.

param: {Object} state Global application state.
return: {string} Editing mode.

warning(cond, message) X-Ref

No description

createBrowserHistory(options) X-Ref

Browser history stores the location in regular URLs. This is the standard for
most web apps, but it requires some configuration on the server to ensure you
serve the same app at multiple URLs.

getIndexAndLocation() X-Ref

No description

handlePop() X-Ref

No description

createHref(to) X-Ref

No description

getNextLocation(to, state) X-Ref

No description

getHistoryStateAndUrl(nextLocation, index) X-Ref

No description

allowTx(action, location, retry) X-Ref

No description

applyTx(nextAction) X-Ref

No description

push(to, state) X-Ref

No description

retry() X-Ref

No description

replace(to, state) X-Ref

No description

retry() X-Ref

No description

go(delta) X-Ref

No description

createHashHistory(options) X-Ref

Hash history stores the location in window.location.hash. This makes it ideal
for situations where you don't want to send the location to the server for
some reason, either because you do cannot configure it or the URL space is
reserved for something else.

getIndexAndLocation() X-Ref

No description

handlePop() X-Ref

No description

getBaseHref() X-Ref

No description

createHref(to) X-Ref

No description

getNextLocation(to, state) X-Ref

No description

getHistoryStateAndUrl(nextLocation, index) X-Ref

No description

allowTx(action, location, retry) X-Ref

No description

applyTx(nextAction) X-Ref

No description

push(to, state) X-Ref

No description

retry() X-Ref

No description

replace(to, state) X-Ref

No description

retry() X-Ref

No description

go(delta) X-Ref

No description

createMemoryHistory(options) X-Ref

Memory history stores the current location in memory. It is designed for use
in stateful non-browser environments like tests and React Native.

createHref(to) X-Ref

No description

getNextLocation(to, state) X-Ref

No description

allowTx(action, location, retry) X-Ref

No description

applyTx(nextAction, nextLocation) X-Ref

No description

push(to, state) X-Ref

No description

retry() X-Ref

No description

replace(to, state) X-Ref

No description

retry() X-Ref

No description

go(delta) X-Ref

No description

retry() X-Ref

No description

clamp(n, lowerBound, upperBound) X-Ref

No description

promptBeforeUnload(event) X-Ref

No description

createEvents() X-Ref

No description

createKey() X-Ref

No description

createPath(_ref) X-Ref

Creates a string URL path from the given pathname, search, and hash components.

parsePath(path) X-Ref

Parses a string URL path into its separate pathname, search, and hash components.

push(params, state) X-Ref

No description

replace(params, state) X-Ref

No description

useLocation() X-Ref

No description

useHistory() X-Ref

No description

getLocationWithParams(location) X-Ref

No description

Routes(_ref) X-Ref

No description

KeyCombination(_ref) X-Ref

No description

Shortcut(_ref2) X-Ref

No description

DynamicShortcut(_ref) X-Ref

Internal dependencies

KeyboardShortcutHelpModal(_ref4) X-Ref

No description

EnableFeature(props) X-Ref

No description

EditSitePreferencesModal(_ref) X-Ref

Internal dependencies

SiteExport() X-Ref

No description

WelcomeGuideMenuItem() X-Ref

No description

CopyContentMenuItem() X-Ref

Internal dependencies

onSuccess() X-Ref

No description

ModeSwitcher() X-Ref

No description

MoreMenu() X-Ref

No description

SaveButton(_ref) X-Ref

No description

UndoButton() X-Ref

No description

RedoButton() X-Ref

No description

getBlockDisplayText(block) X-Ref

No description

useSecondaryText() X-Ref

No description

DocumentActions(_ref) X-Ref

param: {Object}   props                Props for the DocumentActions component.
param: {string}   props.entityTitle    The title to display.
param: {string}   props.entityLabel    A label to use for entity-related options.
param: {boolean}  props.isLoaded       Whether the data is available.
param: {Function} props.children       React component to use for the
param: {boolean}  props.showIconLabels Whether buttons display icons or text labels.

useLink() X-Ref

Internal dependencies

onClick(event) X-Ref

No description

Link(_ref) X-Ref

No description

TemplatePartItemMore(_ref) X-Ref

No description

editTemplatePart(event) X-Ref

No description

clearCustomizations() X-Ref

No description

TemplatePartItem(_ref2) X-Ref

No description

TemplateAreas(_ref4) X-Ref

No description

EditTemplateTitle(_ref) X-Ref

No description

TemplateDetails(_ref) X-Ref

No description

Header(_ref) X-Ref

No description

default_sidebar_DefaultSidebar(_ref) X-Ref

WordPress dependencies

IconWithCurrentColor(_ref) X-Ref

WordPress dependencies

GenericNavigationButton(_ref) X-Ref

No description

NavigationButton(props) X-Ref

No description

NavigationBackButton(props) X-Ref

No description

findInPresetsBy(features, blockName, presetPath, presetProperty, presetValueValue) X-Ref

No description

getPresetVariableFromValue(features, blockName, variableStylePath, presetPropertyValue) X-Ref

No description

getValueFromPresetVariable(features, blockName, variable, _ref2) X-Ref

No description

getValueFromCustomVariable(features, blockName, variable, path) X-Ref

No description

getValueFromVariable(features, blockName, variable) X-Ref

No description

useSetting(path, blockName) X-Ref

No description

useStyle(path, blockName) X-Ref

No description

getSupportedGlobalStylesPanels(name) X-Ref

No description

useColorsPerOrigin(name) X-Ref

No description

useGradientsPerOrigin(name) X-Ref

No description

useHasBorderPanel(name) X-Ref

No description

useHasBorderColorControl(name) X-Ref

No description

useHasBorderRadiusControl(name) X-Ref

No description

useHasBorderStyleControl(name) X-Ref

No description

useHasBorderWidthControl(name) X-Ref

No description

BorderPanel(_ref) X-Ref

No description

useHasColorPanel(name) X-Ref

Internal dependencies

useHasDimensionsPanel(name) X-Ref

No description

useHasPadding(name) X-Ref

No description

useHasMargin(name) X-Ref

No description

useHasGap(name) X-Ref

No description

filterValuesBySides(values, sides) X-Ref

No description

splitStyleValue(value) X-Ref

No description

DimensionsPanel(_ref) X-Ref

No description

useHasTypographyPanel(name) X-Ref

Internal dependencies

useHasLineHeightControl(name) X-Ref

No description

useHasAppearanceControl(name) X-Ref

No description

useHasLetterSpacingControl(name) X-Ref

No description

TypographyPanel(_ref) X-Ref

No description

ContextMenu(_ref) X-Ref

No description

generateBoxRules(style, options, path, ruleKey) X-Ref

Internal dependencies

generate(style, options) X-Ref

Generates a stylesheet for a given style object and selector.

param: style Style object.
param: options Options object with settings to adjust how the styles are generated.
return: generated stylesheet.

getCSSRules(style, options) X-Ref

Returns a JSON representation of the generated CSS rules.

param: style Style object.
param: options Options object with settings to adjust how the styles are generated.
return: generated styles.

compileStyleValue(uncompiledValue) X-Ref

No description

getPresetsDeclarations() X-Ref

Transform given preset tree into a set of style declarations.

param: {Object} blockPresets
return: {Array} An array of style declarations.

getPresetsClasses(blockSelector) X-Ref

Transform given preset tree into a set of preset class declarations.

param: {string} blockSelector
param: {Object} blockPresets
return: {string} CSS declarations for the preset classes.

getPresetsSvgFilters() X-Ref

No description

flattenTree() X-Ref

No description

getStylesDeclarations() X-Ref

Transform given style tree into a set of style declarations.

param: {Object} blockStyles Block styles.
return: {Array} An array of style declarations.

toSvgFilters(tree, blockSelectors) X-Ref

No description

useGlobalStylesOutput() X-Ref

No description

ScreenRoot() X-Ref

No description

ScreenHeader(_ref) X-Ref

No description

useSortedBlockTypes() X-Ref

No description

BlockMenuItem(_ref) X-Ref

No description