PHPXRef 0.7.1 : WordPress : Detail view of block-library.js

The new gallery block format is not compatible with the use_BalanceTags option
in WP versions <= 5.8 https://core.trac.wordpress.org/ticket/54130. The
window.wp.galleryBlockV2Enabled flag is set in lib/compat.php. This method
can be removed when minimum supported WP version >=5.9.

defaultColumnsNumberV1(attributes) X-Ref

Original function to determine default number of columns from a block's
attributes.

Used in deprecations: v1-6, for versions of the gallery block that didn't use inner blocks.

param: {Object} attributes Block attributes.
return: {number} Default number of columns for the gallery.

getHrefAndDestination(image, destination) X-Ref

Original function to determine new href and linkDestination values for an image block from the
supplied Gallery link destination.

Used in deprecations: v1-6.

param: {Object} image Gallery image.
param: {string} destination Gallery's selected link destination.
return: {Object} New attributes to assign to image block.

runV2Migration(attributes) X-Ref

No description

getImageBlock(image, sizeSlug, linkTo) X-Ref

Gets an Image block from gallery image data

Used to migrate Galleries to nested Image InnerBlocks.

param: {Object} image    Image properties.
param: {string} sizeSlug Gallery sizeSlug attribute.
param: {string} linkTo   Gallery linkTo attribute.
return: {Object}         Image block.

utils_getHrefAndDestination(image, destination) X-Ref

Determines new href and linkDestination values for an image block from the
supplied Gallery link destination.

param: {Object} image Gallery image.
param: {string} destination Gallery's selected link destination.
return: {Object} New attributes to assign to image block.

removeNewTabRel(currentRel) X-Ref

Internal dependencies

getUpdatedLinkTargetSettings(value, _ref) X-Ref

Helper to get the link target settings to be stored.

param: {boolean} value          The new link target value.
param: {Object}  attributes     Block attributes.
param: {Object}  attributes.rel Image block's rel attribute.
return: {Object} Updated link target settings.

getImageSizeAttributes(image, size) X-Ref

Determines new Image block attributes size selection.

param: {Object} image Media file object for gallery image.
param: {string} size Selected size slug to apply.

onFocusCaption() X-Ref

No description

removeCaptionFocus() X-Ref

No description

RichTextVisibilityHelper(_ref) X-Ref

No description

useImageSizes(images, isSelected, getSettings) X-Ref

Calculates the image sizes that are avaible for the current gallery images in order to
populate the 'Image size' selector.

param: {Array} images Basic image block data taken from current gallery innerBlock
param: {boolean} isSelected Is the block currently selected in the editor.
param: {Function} getSettings Block editor store selector.
return: {Array} An array of image size options.

getImageSizing() X-Ref

No description

useShortCodeTransform(shortCodeTransforms) X-Ref

Shortcode transforms don't currently have a tranform method and so can't use a selector to
retrieve the data for each image being transformer, so this selector handle this post transformation.

param: {Array} shortCodeTransforms An array of image data passed from the shortcode transform.
return: {Array} An array of extended image data objects for each of the shortcode transform images.

useGetNewImages(images, imageData) X-Ref

Keeps track of images already in the gallery to allow new innerBlocks to be identified. This
is required so default gallery attributes can be applied without overwriting any custom
attributes applied to existing images.

param: {Array} images Basic image block data taken from current gallery innerBlock
param: {Array} imageData The related image data for each of the current gallery images.
return: {Array} An array of any new images that have been added to the gallery.

getNewImages() X-Ref

No description

useGetMedia(innerBlockImages) X-Ref

Retrieves the extended media info for each gallery image from the store. This is used to
determine which image size options are available for the current gallery.

param: {Array} innerBlockImages An array of the innerBlock images currently in the gallery.
return: {Array} An array of media info options for each gallery image.

GapStyles(_ref) X-Ref

WordPress dependencies

GalleryEdit(props) X-Ref

No description

buildImageAttributes(imageAttributes) X-Ref

Determines the image attributes that should be applied to an image block
after the gallery updates.

The gallery will receive the full collection of images when a new image
is added. As a result we need to reapply the image's original settings if
it already existed in the gallery. If the image is in fact new, we need
to apply the gallery's current settings to the image.

param: {Object} imageAttributes Media object for the actual image.
return: {Object} Attributes to set on the new image block.

isValidFileType(file) X-Ref

No description

updateImages(selectedImages) X-Ref

No description

onUploadError(message) X-Ref

No description

setLinkTo(value) X-Ref

No description

setColumnsNumber(value) X-Ref

No description

toggleImageCrop() X-Ref

No description

getImageCropHelp(checked) X-Ref

No description

toggleOpenInNewTab(openInNewTab) X-Ref

No description

updateImagesSize(newSizeSlug) X-Ref

No description

Class: GalleryImage - X-Ref

gallery_RichTextVisibilityHelper(_ref) X-Ref

No description

edit_GalleryEdit(props) X-Ref

No description

onFocusGalleryCaption() X-Ref

No description

setAttributes(newAttrs) X-Ref

No description

onSelectImage(index) X-Ref

No description

onDeselectImage() X-Ref

No description

onMove(oldIndex, newIndex) X-Ref

No description

onMoveForward(oldIndex) X-Ref

No description

onMoveBackward(oldIndex) X-Ref

No description

onRemoveImage(index) X-Ref

No description

selectCaption(newImage) X-Ref

No description

onSelectImages(newImages) X-Ref

No description

onUploadError(message) X-Ref

No description

setLinkTo(value) X-Ref

No description

setColumnsNumber(value) X-Ref

No description

toggleImageCrop() X-Ref

No description

getImageCropHelp(checked) X-Ref

No description

setImageAttributes(index, newAttributes) X-Ref

No description

getImagesSizeOptions() X-Ref

No description

updateImagesSize(newSizeSlug) X-Ref

No description

GalleryEditWrapper(props) X-Ref

No description

saveV1(_ref) X-Ref

No description

saveWithInnerBlocks(_ref) X-Ref

No description

updateThirdPartyTransformToGallery(block) X-Ref

Third party block plugins don't have an easy way to detect if the
innerBlocks version of the Gallery is running when they run a
3rdPartyBlock -> GalleryBlock transform so this tranform filter
will handle this. Once the innerBlocks version is the default
in a core release, this could be deprecated and removed after
plugin authors have been given time to update transforms.

param: {Block} block The transformed block.
return: {Block} The transformed block.

updateThirdPartyTransformFromGallery(toBlock, fromBlocks) X-Ref

Third party block plugins don't have an easy way to detect if the
innerBlocks version of the Gallery is running when they run a
GalleryBlock -> 3rdPartyBlock transform so this transform filter
will handle this. Once the innerBlocks version is the default
in a core release, this could be deprecated and removed after
plugin authors have been given time to update transforms.

param: {Block}      toBlock    The block to transform to.
param: {Block[]}    fromBlocks The blocks to transform from.
return: {Block}                 The transformed block.

GroupEdit(_ref) X-Ref

No description

group_save_save(_ref) X-Ref

WordPress dependencies

HeadingEdit(_ref) X-Ref

No description

heading_save_save(_ref) X-Ref

WordPress dependencies

getLevelFromHeadingNodeName(nodeName) X-Ref

Given a node name string for a heading node, returns its numeric level.

param: {string} nodeName Heading node name.
return: {number} Heading level.

HomeEdit(_ref) X-Ref

No description

home_link_save_save() X-Ref

WordPress dependencies

HTMLEdit(_ref) X-Ref

No description

switchToPreview() X-Ref

No description

switchToHTML() X-Ref

No description

html_save_save(_ref) X-Ref

WordPress dependencies

useClientWidth(ref, dependencies) X-Ref

WordPress dependencies

calculateClientWidth() X-Ref

No description

Image(_ref) X-Ref

Module constants

onResizeStart() X-Ref

No description

onResizeStop() X-Ref

No description

onImageError() X-Ref

No description

onSetHref(props) X-Ref

No description

onSetTitle(value) X-Ref

No description

updateAlt(newAlt) X-Ref

No description

updateImage(newSizeSlug) X-Ref

No description

uploadExternal() X-Ref

No description

updateAlignment(nextAlign) X-Ref

No description

switchToCover() X-Ref

No description

hasDefaultSize(image, defaultSize) X-Ref

Checks if WP generated default image size. Size generation is skipped
when the image is smaller than the said size.

param: {Object} image
param: {string} defaultSize
return: {boolean} Whether or not it has default image size.

isMediaDestroyed(id) X-Ref

Checks if a media attachment object has been "destroyed",
that is, removed from the media library. The core Media Library
adds a `destroyed` property to a deleted attachment object in the media collection.

param: {number} id The attachment id.
return: {boolean} Whether the image has been destroyed.

ImageEdit(_ref) X-Ref

No description

onCloseModal() X-Ref

No description

onImageError() X-Ref

No description

onUploadError(message) X-Ref

No description

onSelectImage(media) X-Ref

No description

onSelectURL(newURL) X-Ref

No description

updateAlignment(nextAlign) X-Ref

No description

image_save_save(_ref) X-Ref

WordPress dependencies

stripFirstImage(attributes, _ref) X-Ref

No description

getFirstAnchorAttributeFormHTML(html, attributeName) X-Ref

No description

LatestComments(_ref) X-Ref

Maximum number of comments a user can show using this block.

getFeaturedImageDetails(post, size) X-Ref

No description

LatestPostsEdit(_ref) X-Ref

No description

ListEdit(_ref) X-Ref

No description

list_save_save(_ref) X-Ref

WordPress dependencies

getListContentSchema(_ref) X-Ref

No description

LoginOutEdit(_ref) X-Ref

No description

imageFillStyles(url, focalPoint) X-Ref

Constants

ToolbarEditButton(_ref2) X-Ref

No description

PlaceholderContainer(_ref3) X-Ref

No description

MediaContainer(props, ref) X-Ref

No description

getImageSourceUrlBySizeSlug(image, slug) X-Ref

No description

edit_attributesFromMedia(_ref) X-Ref

No description

MediaTextEdit(_ref2) X-Ref

No description

media_text_save_save(_ref) X-Ref

No description

MissingBlockWarning(_ref) X-Ref

No description

missing_save_save(_ref) X-Ref

WordPress dependencies

MoreEdit(_ref) X-Ref

No description

more_save_save(_ref) X-Ref

WordPress dependencies

useNavigationMenu(ref) X-Ref

WordPress dependencies

useNavigationEntities(menuId) X-Ref

Manages fetching and resolution state for all entities required
for the Navigation block.

param: {number} menuId the menu for which to retrieve menuItem data.
return: { NavigationEntitiesData } the entity data.

Icon(_ref) X-Ref

Return an SVG icon.

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

NavigationMenuSelector(_ref, forwardedRef) X-Ref

No description

NavigationPlaceholder(_ref) X-Ref

No description

OverlayMenuIcon() X-Ref

WordPress dependencies

ResponsiveWrapper(_ref) X-Ref

Internal dependencies

NavigationInnerBlocks(_ref) X-Ref

No description

NavigationMenuNameControl() X-Ref

No description

createTemplatePartId(theme, slug) X-Ref

Generates a template part Id based on slug and theme inputs.

param: {string} theme the template part's theme.
param: {string} slug the template part's slug
return: {string|null} the template part's Id.

useTemplatePartAreaLabel(clientId) X-Ref

No description

useGenerateDefaultNavigationTitle(clientId) X-Ref

No description

useCreateNavigationMenu(clientId) X-Ref

No description

UnsavedInnerBlocks(_ref) X-Ref

No description

NavigationMenuDeleteControl(_ref) X-Ref

No description

useNavigationNotice() X-Ref

No description

menuItemsToBlocks(menuItems) X-Ref

Convert a flat menu item structure to a nested blocks structure.

param: {Object[]} menuItems An array of menu items.
return: {WPBlock[]} An array of blocks.

mapMenuItemsToBlocks(menuItems) X-Ref

A recursive function that maps menu item nodes to blocks.

param: {WPNavMenuItem[]} menuItems An array of WPNavMenuItem items.
return: {Object} Object containing innerBlocks and mapping.

menuItemToBlockAttributes(_ref) X-Ref

Convert block attributes to menu item.

param: {WPNavMenuItem} menuItem the menu item to be converted to block attributes.
return: {Object} the block attributes converted from the WPNavMenuItem item.

createDataTree(dataset) X-Ref

Creates a nested, hierarchical tree representation from unstructured data that
has an inherent relationship defined between individual items.

For example, by default, each element in the dataset should have an `id` and
`parent` property where the `parent` property indicates a relationship between
the current item and another item with a matching `id` properties.

This is useful for building linked lists of data from flat data structures.

param: {Array}  dataset  linked data to be rearranged into a hierarchical tree based on relational fields.
param: {string} id       the property which uniquely identifies each entry within the array.
param: {*}      relation the property which identifies how the current item is related to other items in the data (if at all).
return: {Array} a nested array of parent/child relationships

useConvertClassicToBlockMenu(clientId) X-Ref

No description

getComputedStyle(node) X-Ref

No description

detectColors(colorsDetectionElement, setColor, setBackground) X-Ref

No description

Navigation(_ref) X-Ref

No description

handleUpdateMenu(menuId) X-Ref

No description

navigation_save_save(_ref) X-Ref

WordPress dependencies

handleDragStart(event) X-Ref

No description

handleDragEnd() X-Ref

No description

handleDragEnter(event) X-Ref

No description

getSuggestionsQuery(type, kind) X-Ref

Given the Link block's type attribute, return the query params to give to
/wp/v2/search.

param: {string} type Link block's type attribute.
param: {string} kind Link block's entity of kind (post-type|taxonomy)
return: {{ type?: string, subtype?: string }} Search query params.

getColors(context, isSubMenu) X-Ref

Determine the colors for a menu.

Order of priority is:
1: Overlay custom colors (if submenu)
2: Overlay theme colors (if submenu)
3: Custom colors
4: Theme colors
5: Global styles

param: {Object} context
param: {boolean} isSubMenu

navStripHTML(html) X-Ref

Removes HTML from a given string.
Note the does not provide XSS protection or otherwise attempt
to filter strings with malicious intent.

See also: https://github.com/WordPress/gutenberg/pull/35539

param: {string} html the string from which HTML should be removed.
return: {string} the "cleaned" string.

LinkControlTransforms(_ref) X-Ref

Add transforms to Link Control

NavigationLinkEdit(_ref2) X-Ref

No description

transformToSubmenu() X-Ref

Transform to submenu block.

selectLabelText() X-Ref

Focus the Link label text and select it.

removeLink() X-Ref

Removes the current link if set.

onKeyDown(event) X-Ref

No description

navigation_link_save_save() X-Ref

WordPress dependencies

getIcon(variationName) X-Ref

No description

enhanceNavigationLinkVariations(settings, name) X-Ref

No description

handleDragStart(event) X-Ref

No description

handleDragEnd() X-Ref

No description

handleDragEnter(event) X-Ref

No description

edit_getSuggestionsQuery(type, kind) X-Ref

edit_getColors(context, isSubMenu) X-Ref

NavigationSubmenuEdit(_ref) X-Ref

No description

selectLabelText() X-Ref

Focus the Link label text and select it.

onKeyDown(event) X-Ref

No description

transformToLink() X-Ref

No description

navigation_submenu_save_save() X-Ref

WordPress dependencies

NextPageEdit() X-Ref

WordPress dependencies

nextpage_save_save() X-Ref

WordPress dependencies

ConvertToLinksModal(_ref3) X-Ref

No description

PageListEdit(_ref) X-Ref

No description

useFrontPageId() X-Ref

No description

usePageData() X-Ref

No description

ParagraphRTLControl(_ref) X-Ref

No description

ParagraphBlock(_ref2) X-Ref

No description

paragraph_save_save(_ref) X-Ref

WordPress dependencies

PostAuthorEdit(_ref) X-Ref

No description

PostAuthorBiographyEdit(_ref) X-Ref

No description

PostCommentsEdit(_ref) X-Ref

No description

PostCommentsFormEdit(_ref) X-Ref

No description

useCanEditEntity(kind, name, recordId) X-Ref

Returns whether the current user can edit the given entity.

param: {string} kind Entity kind.
param: {string} name Entity name.
param: {string} recordId Record's id.

ReadOnlyContent(_ref) X-Ref

No description

EditableContent(_ref2) X-Ref

No description

Content(props) X-Ref

No description

edit_Placeholder() X-Ref

No description

RecursionError() X-Ref

No description

PostContentEdit(_ref3) X-Ref

No description

PostDateEdit(_ref) X-Ref

No description

is12HourFormat(format) X-Ref

No description

PostExcerptEditor(_ref) X-Ref

Internal dependencies

getMediaSourceUrlBySizeSlug(media, slug) X-Ref

No description

PostFeaturedImageDisplay(_ref) X-Ref

No description

PostFeaturedImageEdit(props) X-Ref

No description

PostNavigationLinkEdit(_ref) X-Ref

No description

PostTemplateInnerBlocks() X-Ref

No description

PostTemplateBlockPreview(_ref) X-Ref

No description

PostTemplateEdit(_ref2) X-Ref

No description

PostTemplateSave() X-Ref

WordPress dependencies

usePostTerms(_ref) X-Ref

WordPress dependencies

PostTermsEdit(_ref) X-Ref

Internal dependencies

PostTitleEdit(_ref) X-Ref

No description

PreformattedEdit(_ref) X-Ref

WordPress dependencies

preformatted_save_save(_ref) X-Ref

WordPress dependencies

parseBorderColor(styleString) X-Ref

No description

PullQuoteEdit(_ref) X-Ref

No description

pullquote_save_save(_ref) X-Ref

WordPress dependencies

QueryToolbar(_ref) X-Ref

No description

OrderControl(_ref) X-Ref

No description

AuthorControl(_ref) X-Ref

No description

TaxonomyControls(_ref) X-Ref

No description

QueryInspectorControls(_ref) X-Ref

No description

QueryPlaceholder(_ref) X-Ref

No description

QueryContent(_ref) X-Ref

No description

QueryPatternSetup(_ref2) X-Ref

No description

QuerySave(_ref) X-Ref

WordPress dependencies

QueryNoResultsEdit() X-Ref

No description

QueryNoResultsSave() X-Ref

WordPress dependencies

QueryPaginationArrowControls(_ref) X-Ref

WordPress dependencies

edit_QueryPaginationEdit(_ref) X-Ref

No description

query_pagination_save_save() X-Ref

WordPress dependencies

QueryPaginationNextEdit(_ref) X-Ref

No description

QueryPaginationNumbersEdit() X-Ref

No description

QueryPaginationPreviousEdit(_ref) X-Ref

No description

QueryTitleEdit(_ref) X-Ref

No description

QuoteEdit(_ref) X-Ref

No description

quote_save_save(_ref) X-Ref

WordPress dependencies

ReusableBlockEdit(_ref) X-Ref

No description

ReadMore(_ref) X-Ref

No description

RSSEdit(_ref) X-Ref

No description

toggleAttribute(propName) X-Ref

No description

onSubmitURL(event) X-Ref

No description

utils_isPercentageUnit(unit) X-Ref

Returns a boolean whether passed unit is percentage

param: {string} unit Block width unit.
return: {boolean} Whether unit is '%'.

SearchEdit(_ref) X-Ref

No description

useDeprecatedOpacity(opacity, currentColor, setAttributes) X-Ref

WordPress dependencies

SeparatorEdit(_ref) X-Ref

Internal dependencies

separatorSave(_ref) X-Ref

WordPress dependencies

ShortcodeEdit(_ref) X-Ref

No description

shortcode_save_save(_ref) X-Ref

WordPress dependencies

onResizeStart() X-Ref

No description

onResizeStop() X-Ref

No description

LogoEdit(_ref2) X-Ref

No description

SiteTaglineEdit(_ref) X-Ref

No description

LevelIcon(_ref) X-Ref

WordPress dependencies

LevelControl(_ref) X-Ref

Internal dependencies

SiteTitleEdit(_ref) X-Ref

Internal dependencies

SocialLinksEdit(props) X-Ref

No description

social_links_save_save(props) X-Ref

WordPress dependencies

DimensionInput(_ref) X-Ref

No description

SpacerControls(_ref3) X-Ref

No description

spacer_save_save(_ref) X-Ref

WordPress dependencies

createTable(_ref) X-Ref

Creates a table state.

param: {Object} options
param: {number} options.rowCount Row count for the table to create.
param: {number} options.columnCount Column count for the table to create.
return: {Object} New table state.

getFirstRow(state) X-Ref

Returns the first row in the table.

param: {Object} state Current table state.
return: {Object} The first table row.

getCellAttribute(state, cellLocation, attributeName) X-Ref

Gets an attribute for a cell.

param: {Object} state Current table state.
param: {Object} cellLocation The location of the cell
param: {string} attributeName The name of the attribute to get the value of.
return: {*} The attribute value.

updateSelectedCell(state, selection, updateCell) X-Ref

Returns updated cell attributes after applying the `updateCell` function to the selection.

param: {Object} state The block attributes.
param: {Object} selection The selection of cells to update.
param: {Function} updateCell A function to update the selected cell attributes.
return: {Object} New table state including the updated cells.

isCellSelected(cellLocation, selection) X-Ref

Returns whether the cell at `cellLocation` is included in the selection `selection`.

param: {Object} cellLocation An object containing cell location properties.
param: {Object} selection An object containing selection properties.
return: {boolean} True if the cell is selected, false otherwise.

insertRow(state, _ref2) X-Ref

Inserts a row in the table state.

param: {Object} state Current table state.
param: {Object} options
param: {string} options.sectionName Section in which to insert the row.
param: {number} options.rowIndex Row index at which to insert the row.
param: {number} options.columnCount Column count for the table to create.
return: {Object} New table state.

deleteRow(state, _ref3) X-Ref

Deletes a row from the table state.

param: {Object} state Current table state.
param: {Object} options
param: {string} options.sectionName Section in which to delete the row.
param: {number} options.rowIndex Row index to delete.
return: {Object} New table state.

insertColumn(state, _ref4) X-Ref

Inserts a column in the table state.

param: {Object} state Current table state.
param: {Object} options
param: {number} options.columnIndex Column index at which to insert the column.
return: {Object} New table state.

deleteColumn(state, _ref5) X-Ref

Deletes a column from the table state.

param: {Object} state Current table state.
param: {Object} options
param: {number} options.columnIndex Column index to delete.
return: {Object} New table state.

toggleSection(state, sectionName) X-Ref

Toggles the existance of a section.

param: {Object} state Current table state.
param: {string} sectionName Name of the section to toggle.
return: {Object} New table state.

isEmptyTableSection(section) X-Ref

Determines whether a table section is empty.

param: {Object} section Table section state.
return: {boolean} True if the table section is empty, false otherwise.

isEmptyRow(row) X-Ref

Determines whether a table row is empty.

param: {Object} row Table row state.
return: {boolean} True if the table section is empty, false otherwise.

TSection(_ref) X-Ref

No description

TableEdit(_ref2) X-Ref

No description

onChangeInitialColumnCount(count) X-Ref

Updates the initial column count used for table creation.

param: {number} count New initial column count.

onChangeInitialRowCount(count) X-Ref

Updates the initial row count used for table creation.

param: {number} count New initial row count.

onCreateTable(event) X-Ref

Creates a table based on dimensions in local state.

param: {Object} event Form submit event.

onChangeFixedLayout() X-Ref

Toggles whether the table has a fixed layout or not.

onChange(content) X-Ref

Changes the content of the currently selected cell.

param: {Array} content A RichText content value.

onChangeColumnAlignment(align) X-Ref

Align text within the a column.

param: {string} align The new alignment to apply to the column.

getCellAlignment() X-Ref

Get the alignment of the currently selected cell.

return: {string} The new alignment to apply to the column.

onToggleHeaderSection() X-Ref

Add or remove a `head` table section.

onToggleFooterSection() X-Ref

Add or remove a `foot` table section.

onInsertRow(delta) X-Ref

Inserts a row at the currently selected row index, plus `delta`.

param: {number} delta Offset for selected row index at which to insert.

onInsertRowBefore() X-Ref

Inserts a row before the currently selected row.

onInsertRowAfter() X-Ref

Inserts a row after the currently selected row.

onDeleteRow() X-Ref

Deletes the currently selected row.

onInsertColumn() X-Ref

Inserts a column at the currently selected column index, plus `delta`.

param: {number} delta Offset for selected column index at which to insert.

onInsertColumnBefore() X-Ref

Inserts a column before the currently selected column.

onInsertColumnAfter() X-Ref

Inserts a column after the currently selected column.

onDeleteColumn() X-Ref

Deletes the currently selected column.

table_save_save(_ref) X-Ref

WordPress dependencies

TagCloudEdit(_ref) X-Ref

No description

useAlternativeTemplateParts(area, excludedId) X-Ref

Retrieves the available template parts for the given area.

param: {string} area Template part area.
param: {string} excludedId Template part ID to exclude.
return: {{ templateParts: Array, isResolving: boolean }} array of template parts.

useAlternativeBlockPatterns(area, clientId) X-Ref

Retrieves the available block patterns for the given area.

param: {string} area Template part area.
param: {string} clientId Block Client ID. (The container of the block can impact allowed blocks).
return: {Array} array of block patterns.

useCreateTemplatePartFromBlocks(area, setAttributes) X-Ref

No description

useTemplatePartArea(area) X-Ref

Retrieves the template part area object.

param: {string} area Template part area identifier.
return: {{icon: Object, label: string, tagName: string}} Template Part area.

TitleModal(_ref) X-Ref

No description

TemplatePartPlaceholder(_ref) X-Ref

No description

TemplatePartSelectionModal(_ref) X-Ref

No description

TemplatePartAdvancedControls(_ref) X-Ref

No description

TemplatePartInnerBlocks(_ref) X-Ref

No description

TemplatePartEdit(_ref) X-Ref

No description

getTemplatePartIcon(iconName) X-Ref

No description

enhanceTemplatePartVariations(settings, name) X-Ref

No description

TermDescriptionEdit(_ref) X-Ref

No description

TextColumnsEdit(_ref) X-Ref

No description

text_columns_save_save(_ref) X-Ref

WordPress dependencies

VerseEdit(_ref) X-Ref

No description

verse_save_save(_ref) X-Ref

WordPress dependencies

TrackList(_ref) X-Ref

No description

SingleTrackEditor(_ref2) X-Ref

No description

TracksEditor(_ref3) X-Ref

No description

Tracks(_ref) X-Ref

No description

VideoEdit(_ref) X-Ref

No description

onSelectVideo(media) X-Ref

No description

onSelectURL(newSrc) X-Ref

No description

onUploadError(message) X-Ref

No description

onSelectPoster(image) X-Ref

No description

onRemovePoster() X-Ref

No description

video_save_save(_ref) X-Ref

Internal dependencies

Functions

Functions that are not part of a class:

StorageObject() X-Ref

No description

_parseArray(resultSet, array) X-Ref

No description

_parseNumber(resultSet, num) X-Ref

No description

_parseObject(resultSet, object) X-Ref

No description

_parseString(resultSet, str) X-Ref

No description

_parse(resultSet, arg) X-Ref

No description

_classNames() X-Ref

No description

classNames() X-Ref

No description

_classCallCheck(instance, Constructor) X-Ref

No description

_defineProperties(target, props) X-Ref

No description

_createClass(Constructor, protoProps, staticProps) X-Ref

No description

_slicedToArray(arr, i) X-Ref

No description

_arrayWithHoles(arr) X-Ref

No description

_iterableToArrayLimit(arr, i) X-Ref

No description

_nonIterableRest() X-Ref

No description

FastAverageColor() X-Ref

No description

memize( fn, options ) X-Ref

Accepts a function to be memoized, and returns a new memoized function, with
optional options.

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

memoized( ) X-Ref

No description

__webpack_require__(moduleId) X-Ref

No description

ArchivesEdit(_ref) X-Ref

No description

_extends() X-Ref

No description

getAvatarSizes(sizes) X-Ref

No description

useDefaultAvatar() X-Ref

No description

useCommentAvatar(_ref) X-Ref

No description

useUserAvatar(_ref2) X-Ref

No description

UserControl(_ref) X-Ref

No description

Edit(props) X-Ref

No description

getClassNames(html, existingClassNames) X-Ref

Returns class names with any relevant responsive aspect ratio names.

param: {string}  html               The preview HTML that possibly contains an iframe with width and height set.
param: {string}  existingClassNames Any existing class names.
param: {boolean} allowResponsive    If the responsive class names should be added, or removed.
return: {string} Deduped class names.

fallback(url, onReplace) X-Ref

Fallback behaviour for unembeddable URLs.
Creates a paragraph block containing a link to the URL, and calls `onReplace`.

param: {string} url The URL that could not be embedded.
param: {Function} onReplace Function to call with the created fallback block.

AudioEdit(_ref) X-Ref

No description

toggleAttribute(attribute) X-Ref

No description

onSelectURL(newSrc) X-Ref

No description

onUploadError(message) X-Ref

No description

getAutoplayHelp(checked) X-Ref

No description

onSelectAudio(media) X-Ref

No description

save(_ref) X-Ref

WordPress dependencies

migrate_font_family(attributes) X-Ref

Migrates the current style.typography.fontFamily attribute,
whose value was "var:preset|font-family|helvetica-arial",
to the style.fontFamily attribute, whose value will be "helvetica-arial".

param: {Object} attributes The current attributes
return: {Object} The updated attributes.

WidthPanel(_ref) X-Ref

No description

handleChange(newWidth) X-Ref

No description

ButtonEdit(props) X-Ref

No description

onToggleOpenInNewTab(value) X-Ref

No description

setButtonText(newText) X-Ref

No description

onKeyDown(event) X-Ref

No description

startEditing(event) X-Ref

No description

unlink() X-Ref

No description

save_save(_ref) X-Ref

WordPress dependencies

ButtonsEdit(_ref) X-Ref

No description

buttons_save_save() X-Ref

WordPress dependencies

CalendarEdit(_ref) X-Ref

No description

CategoriesEdit(_ref) X-Ref

No description

isTmceEmpty(editor) X-Ref

No description

ClassicEdit(_ref) X-Ref

No description

onSetup(editor) X-Ref

No description

initialize() X-Ref

No description

onReadyStateChange() X-Ref

No description

focus() X-Ref

No description

onToolbarKeyDown(event) X-Ref

No description

freeform_save_save(_ref) X-Ref

WordPress dependencies

CodeEdit(_ref) X-Ref

WordPress dependencies

utils_escape(content) X-Ref

Escapes ampersands, shortcodes, and links.

param: {string} content The content of a code block.
return: {string} The given content with some characters escaped.

escapeOpeningSquareBrackets(content) X-Ref

Returns the given content with all opening shortcode characters converted
into their HTML entity counterpart (i.e. [ => [). For instance, a
shortcode like [embed] becomes [embed]

This function replicates the escaping of HTML tags, where a tag like
<strong> becomes <strong>.

param: {string} content The content of a code block.
return: {string} The given content with its opening shortcode characters

escapeProtocolInIsolatedUrls(content) X-Ref

Converts the first two forward slashes of any isolated URL into their HTML
counterparts (i.e. // => //). For instance, https://youtube.com/watch?x
becomes https://youtube.com/watch?x.

An isolated URL is a URL that sits in its own line, surrounded only by spacing
characters.

See https://github.com/WordPress/wordpress-develop/blob/5.1.1/src/wp-includes/class-wp-embed.php#L403

param: {string} content The content of a code block.
return: {string} The given content with its ampersands converted into

code_save_save(_ref) X-Ref

Internal dependencies

ColumnEdit(_ref) X-Ref

No description

column_save_save(_ref) X-Ref

WordPress dependencies

getDeprecatedLayoutColumn(originalContent) X-Ref

Given an HTML string for a deprecated columns inner block, returns the
column index to which the migrated inner block should be assigned. Returns
undefined if the inner block was not assigned to a column.

param: {string} originalContent Deprecated Columns inner block HTML.
return: {?number} Column to which inner block is to be assigned.

getEffectiveColumnWidth(block, totalBlockCount) X-Ref

Returns an effective width for a given block. An effective width is equal to
its attribute value if set, or a computed value assuming equal distribution.

param: {WPBlock} block Block object.
param: {number} totalBlockCount Total number of blocks in Columns.
return: {number} Effective column width.

getTotalColumnsWidth(blocks) X-Ref

Returns the total width occupied by the given set of column blocks.

param: {WPBlock[]} blocks Block objects.
param: {?number} totalBlockCount Total number of blocks in Columns.
return: {number} Total width occupied by blocks.

getColumnWidths(blocks) X-Ref

Returns an object of `clientId` → `width` of effective column widths.

param: {WPBlock[]} blocks Block objects.
param: {?number} totalBlockCount Total number of blocks in Columns.
return: {Object<string,number>} Column widths.

getRedistributedColumnWidths(blocks, availableWidth) X-Ref

Returns an object of `clientId` → `width` of column widths as redistributed
proportional to their current widths, constrained or expanded to fit within
the given available width.

param: {WPBlock[]} blocks          Block objects.
param: {number}    availableWidth  Maximum width to fit within.
param: {?number}   totalBlockCount Total number of blocks in Columns.
return: {Object<string,number>} Redistributed column widths.

hasExplicitPercentColumnWidths(blocks) X-Ref

Returns true if column blocks within the provided set are assigned with
explicit widths, or false otherwise.

param: {WPBlock[]} blocks Block objects.
return: {boolean} Whether columns have explicit widths.

getMappedColumnWidths(blocks, widths) X-Ref

Returns a copy of the given set of blocks with new widths assigned from the
provided object of redistributed column widths.

param: {WPBlock[]} blocks Block objects.
param: {Object<string,number>} widths Redistributed column widths.
return: {WPBlock[]} blocks Mapped block objects.

getWidths(blocks) X-Ref

Returns an array with columns widths values, parsed or no depends on `withParsing` flag.

param: {WPBlock[]} blocks Block objects.
param: {?boolean} withParsing Whether value has to be parsed.
return: {Array<number,string>} Column widths.

getWidthWithUnit(width, unit) X-Ref

Returns a column width with unit.

param: {string} width Column width.
param: {string} unit Column width unit.
return: {string} Column width with unit.

isPercentageUnit(unit) X-Ref

Returns a boolean whether passed unit is percentage

param: {string} unit Column width unit.
return: {boolean} Whether unit is '%'.

ColumnsEditContainer(_ref) X-Ref

No description

Placeholder(_ref2) X-Ref

No description

columns_save_save(_ref) X-Ref

WordPress dependencies

edit_Edit(_ref) X-Ref

Renders the `core/comment-author-name` block on the editor.

param: {Object} props                       React props.
param: {Object} props.setAttributes         Callback for updating block attributes.
param: {Object} props.attributes            Block attributes.
param: {string} props.attributes.isLink     Whether the author name should be linked.
param: {string} props.attributes.linkTarget Target of the link.
param: {string} props.attributes.textAlign  Text alignment.
param: {Object} props.context               Inherited context.
param: {string} props.context.commentId     The comment ID.
return: {JSX.Element} React element.

comment_content_edit_Edit(_ref) X-Ref

Renders the `core/comment-content` block on the editor.

param: {Object} props                      React props.
param: {Object} props.setAttributes        Callback for updating block attributes.
param: {Object} props.attributes           Block attributes.
param: {string} props.attributes.textAlign The `textAlign` attribute.
param: {Object} props.context              Inherited context.
param: {string} props.context.commentId    The comment ID.
return: {JSX.Element} React element.

comment_date_edit_Edit(_ref) X-Ref

Renders the `core/comment-date` block on the editor.

param: {Object} props                   React props.
param: {Object} props.setAttributes     Callback for updating block attributes.
param: {Object} props.attributes        Block attributes.
param: {string} props.attributes.format Format of the date.
param: {string} props.attributes.isLink Whether the author name should be linked.
param: {Object} props.context           Inherited context.
param: {string} props.context.commentId The comment ID.
return: {JSX.Element} React element.

comment_edit_link_edit_Edit(_ref) X-Ref

No description

comment_reply_link_edit_Edit(_ref) X-Ref

Renders the `core/comment-reply-link` block on the editor.

param: {Object} props                      React props.
param: {Object} props.setAttributes        Callback for updating block attributes.
param: {Object} props.attributes           Block attributes.
param: {string} props.attributes.textAlign The `textAlign` attribute.
return: {JSX.Element} React element.

CommentTemplateInnerBlocks(_ref2) X-Ref

Component which renders the inner blocks of the Comment Template.

param: {Object} props                      Component props.
param: {Array}  [props.comment]            - A comment object.
param: {Array}  [props.activeCommentId]    - The ID of the comment that is currently active.
param: {Array}  [props.setActiveCommentId] - The setter for activeCommentId.
param: {Array}  [props.firstCommentId]     - ID of the first comment in the array.
param: {Array}  [props.blocks]             - Array of blocks returned from
return: {WPElement}                         Inner blocks of the Comment Template

CommentTemplateEdit(_ref6) X-Ref

No description

CommentTemplateSave() X-Ref

WordPress dependencies

CommentsPaginationPreviousEdit(_ref) X-Ref

No description

CommentsInspectorControls(_ref) X-Ref

No description

CommentsQueryLoopEdit(_ref) X-Ref

No description

CommentsQueryLoopSave(_ref) X-Ref

WordPress dependencies

CommentsPaginationArrowControls(_ref) X-Ref

WordPress dependencies

QueryPaginationEdit(_ref) X-Ref

No description

comments_pagination_save_save() X-Ref

WordPress dependencies

CommentsPaginationNextEdit(_ref) X-Ref

No description

CommentsPaginationNumbersEdit() X-Ref

No description

HeadingLevelIcon(_ref) X-Ref

Heading level icon.

param: {WPHeadingLevelIconProps} props Component props.
return: {?WPComponent} The icon.

HeadingLevelDropdown(_ref) X-Ref

Dropdown for selecting a heading level (1 through 6).

param: {WPHeadingLevelDropdownProps} props Component props.
return: {WPComponent} The toolbar.

comments_title_edit_Edit(_ref) X-Ref

Internal dependencies

backgroundImageStyles(url) X-Ref

No description

dimRatioToClass(ratio) X-Ref

No description

attributesFromMedia(setAttributes, dimRatio) X-Ref

No description

isContentPositionCenter(contentPosition) X-Ref

Checks of the contentPosition is the center (default) position.

param: {string} contentPosition The current content position.
return: {boolean} Whether the contentPosition is center.

getPositionClassName(contentPosition) X-Ref

Retrieves the className for the current contentPosition.
The default position (center) will not have a className.

param: {string} contentPosition The current content position.
return: {string} The className assigned to the contentPosition.

dimRatioToClassV1(ratio) X-Ref

Original function to determine the background opacity classname

Used in deprecations: v1-7.

param: {number} ratio ratio to use for opacity.
return: {string} background opacity class .

migrateDimRatio(attributes) X-Ref

No description

names(e,f) X-Ref

No description

getInnerBlocksTemplate(attributes) X-Ref

No description

retrieveFastAverageColor() X-Ref

No description

CoverHeightInput(_ref) X-Ref

No description

ResizableCover(_ref2) X-Ref

No description

useCoverIsDark(url) X-Ref

useCoverIsDark is a hook that returns a boolean variable specifying if the cover
background is dark or not.

param: {?string} url          Url of the media background.
param: {?number} dimRatio     Transparency of the overlay color. If an image and
param: {?string} overlayColor String containing the overlay color value if one exists.
param: {?Object} elementRef   If a media background is set, elementRef should contain a reference to a
return: {boolean} True if the cover background is considered "dark" and false otherwise.

mediaPosition(_ref3) X-Ref

No description

CoverPlaceholder(_ref4) X-Ref

No description

CoverEdit(_ref5) X-Ref

No description

cover_save_save(_ref) X-Ref

Internal dependencies

getResponsiveHelp(checked) X-Ref

No description

WpEmbedPreview(_ref) X-Ref

No description

resizeWPembeds(_ref3) X-Ref

Checks for WordPress embed events signaling the height change when
iframe content loads or iframe's window is resized. The event is
sent from WordPress core via the window.postMessage API.

References:
window.postMessage:
https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage
WordPress core embed-template on load:
https://github.com/WordPress/WordPress/blob/HEAD/wp-includes/js/wp-embed-template.js#L143
WordPress core embed-template on resize:
https://github.com/WordPress/WordPress/blob/HEAD/wp-includes/js/wp-embed-template.js#L187

param: {MessageEvent} event Message event.

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

PHP Cross Reference of WordPress

/wp-includes/js/dist/ -> block-library.js (summary)

Defines 2 classes

Defines 275 functions