| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Source view] [Print] [Project Stats]
Checks if the block is experimental based on the metadata loaded from block.json.
| File Size: | 64680 lines (2146 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| matcher(match) X-Ref |
| No description |
| __webpack_require__(moduleId) X-Ref |
| No description |
| initBlock(block) X-Ref |
| Function to register an individual block. param: {Object} block The block to be registered. return: {WPBlockType | undefined} The block, if it has been successfully registered; |
| ArchivesEdit({attributes,setAttributes}) X-Ref |
| No description |
| r(e) X-Ref |
| No description |
| getAvatarSizes(sizes) X-Ref |
| No description |
| useDefaultAvatar() X-Ref |
| No description |
| useCommentAvatar({commentId}) X-Ref |
| No description |
| useUserAvatar({userId,postId,postType}) X-Ref |
| No description |
| UserControl({value,onChange}) X-Ref |
| No description |
| Edit(props) 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: {((...args: Parameters<F>) => ReturnType<F>) & MemizeMemoizedFunction} Memoized function. |
| memoized() X-Ref |
| No description |
| getClassNames(html, existingClassNames, allowResponsive = true) 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. |
| 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. |
| useUploadMediaFromBlobURL(args = {}) X-Ref |
| Handles uploading a media file from a blob URL on mount. param: {Object} args Upload media arguments. param: {string} args.url Blob URL. param: {?Array} args.allowedTypes Array of allowed media types. param: {Function} args.onChange Function called when the media is uploaded. param: {Function} args.onError Function called when an error happens. |
| useToolsPanelDropdownMenuProps() X-Ref |
| No description |
| Caption({attributeKey = 'caption',attributes,setAttributes,isSelected,insertBlocksAfter,placeholder = (0,external_wp_i18n_namespaceObject.__) X-Ref |
| No description |
| AudioEdit({attributes,className,setAttributes,onReplace,isSelected: isSingleSelected,insertBlocksAfter}) 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({attributes}) X-Ref |
| No description |
| 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. |
| migrateAlign(attributes) X-Ref |
| No description |
| getUpdatedLinkAttributes({rel = '',url = '',opensInNewTab,nofollow}) X-Ref |
| Updates the link attributes. param: {Object} attributes The current block attributes. param: {string} attributes.rel The current link rel attribute. param: {string} attributes.url The current link url. param: {boolean} attributes.opensInNewTab Whether the link should open in a new window. param: {boolean} attributes.nofollow Whether the link should be marked as nofollow. |
| removeAnchorTag(value) X-Ref |
| Removes anchor tags from a string. param: {string} value The value to remove anchor tags from. return: {string} The value with anchor tags removed. |
| useEnter(props) X-Ref |
| No description |
| onKeyDown(event) X-Ref |
| No description |
| WidthPanel({selectedWidth,setAttributes}) X-Ref |
| No description |
| handleChange(newWidth) X-Ref |
| No description |
| ButtonEdit(props) X-Ref |
| No description |
| onKeyDown(event) X-Ref |
| No description |
| startEditing(event) X-Ref |
| No description |
| unlink() X-Ref |
| No description |
| save_save({attributes,className}) X-Ref |
| WordPress dependencies |
| getTransformedMetadata(metadata, newBlockName, bindingsCallback) X-Ref |
| Transform the metadata attribute with only the values and bindings specified by each transform. Returns `undefined` if the input metadata is falsy. param: {Object} metadata Original metadata attribute from the block that is being transformed. param: {Object} newBlockName Name of the final block after the transformation. param: {Function} bindingsCallback Optional callback to transform the `bindings` property object. return: {Object|undefined} New metadata object only with the relevant properties. |
| ButtonsEdit({attributes,className}) X-Ref |
| No description |
| buttons_save_save({attributes,className}) X-Ref |
| WordPress dependencies |
| CalendarEdit({attributes}) X-Ref |
| No description |
| CategoriesEdit({attributes: {displayAsDropdown,showHierarchy,showPostCounts,showOnlyTopLevel,showEmpty,label,showLabel,taxonomy: taxonomySlug},setAttributes,className}) X-Ref |
| No description |
| ModalAuxiliaryActions({onClick,isModalFullScreen}) X-Ref |
| No description |
| ClassicEdit(props) X-Ref |
| No description |
| ModalEdit(props) X-Ref |
| No description |
| isTmceEmpty(editor) X-Ref |
| No description |
| FreeformEdit(props) X-Ref |
| No description |
| edit_ClassicEdit({clientId,attributes: {content},setAttributes,onReplace}) 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({attributes}) X-Ref |
| WordPress dependencies |
| CodeEdit({attributes,setAttributes,onRemove,insertBlocksAfter,mergeBlocks}) X-Ref |
| No description |
| 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({attributes}) X-Ref |
| Internal dependencies |
| ColumnInspectorControls({width,setAttributes}) X-Ref |
| No description |
| ColumnEdit({attributes: {verticalAlignment,width,templateLock,allowedBlocks},setAttributes,clientId}) X-Ref |
| No description |
| column_save_save({attributes}) 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 | undefined} 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, totalBlockCount = blocks.length) 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, totalBlockCount = blocks.length) 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, totalBlockCount = blocks.length) 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, withParsing = true) 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 '%'. |
| edit_ColumnInspectorControls({clientId,setAttributes,isStackedOnMobile}) X-Ref |
| No description |
| updateColumns(previousColumns, newColumns) X-Ref |
| Updates the column count, including necessary revisions to child Column blocks to grant required or redistribute available space. param: {number} previousColumns Previous column count. param: {number} newColumns New column count. |
| ColumnsEditContainer({attributes,setAttributes,clientId}) X-Ref |
| No description |
| updateAlignment(newVerticalAlignment) X-Ref |
| Update all child Column blocks with a new vertical alignment setting based on whatever alignment is passed in. This allows change to parent to overide anything set on a individual column basis. param: {string} newVerticalAlignment The vertical alignment setting. |
| Placeholder({clientId,name,setAttributes}) X-Ref |
| No description |
| columns_save_save({attributes}) X-Ref |
| WordPress dependencies |
| CommentsInspectorControls({attributes: {tagName},setAttributes}) X-Ref |
| No description |
| PostCommentsPlaceholder({postType,postId}) X-Ref |
| No description |
| CommentsLegacy({attributes,setAttributes,context: {postType,postId}}) X-Ref |
| No description |
| CommentsEdit(props) X-Ref |
| No description |
| comments_save_save({attributes: {tagName: Tag,legacy}}) X-Ref |
| WordPress dependencies |
| edit_Edit({attributes,context: {commentId},setAttributes,isSelected}) X-Ref |
| No description |
| comment_author_name_edit_Edit({attributes: {isLink,linkTarget,textAlign},context: {commentId},setAttributes}) X-Ref |
| No description |
| comment_content_edit_Edit({setAttributes,attributes: {textAlign},context: {commentId}}) X-Ref |
| No description |
| comment_date_edit_Edit({attributes: {format,isLink},context: {commentId},setAttributes}) X-Ref |
| No description |
| comment_edit_link_edit_Edit({attributes: {linkTarget,textAlign},setAttributes}) X-Ref |
| No description |
| comment_reply_link_edit_Edit({setAttributes,attributes: {textAlign}}) X-Ref |
| No description |
| CommentTemplateInnerBlocks({comment,activeCommentId,setActiveCommentId,firstCommentId,blocks}) 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: {Element} Inner blocks of the Comment Template |
| CommentTemplateEdit({clientId,context: {postId}}) X-Ref |
| No description |
| CommentTemplateSave() X-Ref |
| WordPress dependencies |
| CommentsPaginationPreviousEdit({attributes: {label},setAttributes,context: {'comments/paginationArrow': paginationArrow}}) X-Ref |
| No description |
| CommentsPaginationArrowControls({value,onChange}) X-Ref |
| No description |
| QueryPaginationEdit({attributes: {paginationArrow},setAttributes,clientId}) X-Ref |
| No description |
| comments_pagination_save_save() X-Ref |
| WordPress dependencies |
| CommentsPaginationNextEdit({attributes: {label},setAttributes,context: {'comments/paginationArrow': paginationArrow}}) X-Ref |
| No description |
| CommentsPaginationNumbersEdit() X-Ref |
| No description |
| comments_title_edit_Edit({attributes: {textAlign,showPostTitle,showCommentsCount,level,levelOptions},setAttributes,context: {postType,postId}}) X-Ref |
| No description |
| mediaPosition({x,y} = DEFAULT_FOCAL_POINT) X-Ref |
| No description |
| dimRatioToClass(ratio) X-Ref |
| No description |
| attributesFromMedia(media) 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. |
| backgroundImageStyles(url) X-Ref |
| No description |
| 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 |
| migrateTag(attributes) X-Ref |
| No description |
| CoverHeightInput({onChange,onUnitChange,unit = 'px',value = ''}) X-Ref |
| No description |
| CoverInspectorControls({attributes,setAttributes,clientId,setOverlayColor,coverRef,currentSettings,updateDimRatio}) X-Ref |
| No description |
| CoverBlockControls({attributes,setAttributes,onSelectMedia,currentSettings,toggleUseFeaturedImage,onClearMedia}) X-Ref |
| No description |
| CoverPlaceholder({disableMediaButtons = false,children,onSelectMedia,onError,style,toggleUseFeaturedImage}) X-Ref |
| Internal dependencies |
| ResizableCoverPopover({className,height,minHeight,onResize,onResizeStart,onResizeStop,showHandle,size,width,...props}) X-Ref |
| No description |
| names(e,f) X-Ref |
| No description |
| toHex(num) X-Ref |
| No description |
| arrayToHex(arr) X-Ref |
| No description |
| isDark(color) X-Ref |
| No description |
| prepareIgnoredColor(color) X-Ref |
| No description |
| isRGBArray(value) X-Ref |
| No description |
| isIgnoredColor(data, index, ignoredColor) X-Ref |
| No description |
| isIgnoredColorAsNumbers(data, index, ignoredColor) X-Ref |
| No description |
| isIgnoredRGBColor(data, index, ignoredColor) X-Ref |
| No description |
| isIgnoredRGBAColor(data, index, ignoredColor) X-Ref |
| No description |
| inRange(colorComponent, ignoredColorComponent, value) X-Ref |
| No description |
| isIgnoredRGBAColorWithThreshold(data, index, ignoredColor) X-Ref |
| No description |
| dominantAlgorithm(arr, len, options) X-Ref |
| No description |
| simpleAlgorithm(arr, len, options) X-Ref |
| No description |
| sqrtAlgorithm(arr, len, options) X-Ref |
| No description |
| getDefaultColor(options) X-Ref |
| No description |
| getOption(options, name, defaultValue) X-Ref |
| No description |
| isSvg(filename) X-Ref |
| No description |
| getOriginalSize(resource) X-Ref |
| No description |
| getSrc(resource) X-Ref |
| No description |
| isInstanceOfHTMLImageElement(resource) X-Ref |
| No description |
| isInstanceOfOffscreenCanvas(resource) X-Ref |
| No description |
| isInstanceOfHTMLVideoElement(resource) X-Ref |
| No description |
| isInstanceOfHTMLCanvasElement(resource) X-Ref |
| No description |
| isInstanceOfImageBitmap(resource) X-Ref |
| No description |
| prepareSizeAndPosition(originalSize, options) X-Ref |
| No description |
| makeCanvas() X-Ref |
| No description |
| getError(message) X-Ref |
| No description |
| outputError(error, silent) X-Ref |
| No description |
| FastAverageColor() X-Ref |
| No description |
| compositeSourceOver(source, dest) X-Ref |
| Performs a Porter Duff composite source over operation on two rgba colors. param: {RgbaColor} source Source color. param: {RgbaColor} dest Destination color. return: {RgbaColor} Composite color. |
| retrieveFastAverageColor() X-Ref |
| Retrieves the FastAverageColor singleton. return: {FastAverageColor} The FastAverageColor singleton. |
| compositeIsDark(dimRatio, overlayColor, backgroundColor) X-Ref |
| Computes if the color combination of the overlay and background color is dark. param: {number} dimRatio Opacity of the overlay between 0 and 100. param: {string} overlayColor CSS color string for the overlay. param: {string} backgroundColor CSS color string for the background. return: {boolean} true if the color combination composite result is dark. |
| getInnerBlocksTemplate(attributes) X-Ref |
| No description |
| CoverEdit({attributes,clientId,isSelected,overlayColor,setAttributes,setOverlayColor,toggleSelection,context: {postId,postType}}) X-Ref |
| Is the URL a temporary blob URL? A blob URL is one that is used temporarily while the media (image or video) is being uploaded and will not have an id allocated yet. param: {number} id The id of the media. param: {string} url The url of the media. return: {boolean} Is the URL a Blob URL. |
| cover_save_save({attributes}) X-Ref |
| No description |
| DetailsEdit({attributes,setAttributes,clientId}) X-Ref |
| No description |
| details_save_save({attributes}) X-Ref |
| No description |
| getResponsiveHelp(checked) X-Ref |
| No description |
| WpEmbedPreview({html}) X-Ref |
| No description |
| resizeWPembeds({data: {secret,message,value} = {}}) 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. |
| EmbedPreview({preview,previewable,url,type,isSelected,className,icon,label,insertBlocksAfter,attributes,setAttributes}) X-Ref |
| No description |
| embed_save_save({attributes}) X-Ref |
| No description |
| getTitle(providerName) X-Ref |
| No description |
| FileBlockInspector({hrefs,openInNewWindow,showDownloadButton,changeLinkDestinationOption,changeOpenInNewWindow,changeShowDownloadButton,displayPreview,changeDisplayPreview,previewHeight,changePreviewHeight}) X-Ref |
| No description |
| ClipboardToolbarButton({text,disabled}) X-Ref |
| No description |
| FileEdit({attributes,isSelected,setAttributes,clientId}) X-Ref |
| No description |
| onSelectFile(newMedia) X-Ref |
| No description |
| onUploadError(message) X-Ref |
| No description |
| changeLinkDestinationOption(newHref) X-Ref |
| No description |
| changeOpenInNewWindow(newValue) X-Ref |
| No description |
| changeShowDownloadButton(newValue) X-Ref |
| No description |
| changeDisplayPreview(newValue) X-Ref |
| No description |
| handleOnResizeStop(event, direction, elt, delta) X-Ref |
| No description |
| changePreviewHeight(newValue) X-Ref |
| No description |
| file_save_save({attributes}) X-Ref |
| No description |
| form_save_save({attributes}) X-Ref |
| WordPress dependencies |
| InputFieldBlock({attributes,setAttributes,className}) X-Ref |
| No description |
| form_input_save_save({attributes}) X-Ref |
| No description |
| form_submit_button_save_save() X-Ref |
| WordPress dependencies |
| form_submission_notification_save_save({attributes}) X-Ref |
| External dependencies |
| 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. |
| defaultColumnsNumber(imageCount) X-Ref |
| No description |
| utils_getHrefAndDestination(image, galleryDestination, imageDestination) X-Ref |
| Determines new href and linkDestination values for an Image block from the supplied Gallery link destination, or falls back to the Image blocks link. param: {Object} image Gallery image. param: {string} galleryDestination Gallery's selected link destination. param: {Object} imageDestination Image blocks attributes. return: {Object} New attributes to assign to image block. |
| evalAspectRatio(value) X-Ref |
| Evaluates a CSS aspect-ratio property value as a number. Degenerate or invalid ratios behave as 'auto'. And 'auto' ratios return NaN. param: {string} value CSS aspect-ratio property value. return: {number} Numerical aspect ratio or NaN if invalid. |
| removeNewTabRel(currentRel) X-Ref |
| No description |
| getUpdatedLinkTargetSettings(value, {rel}) 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. |
| isValidFileType(file) X-Ref |
| Checks if the file has a valid file type. param: {File} file - The file to check. return: {boolean} - Returns true if the file has a valid file type, otherwise false. |
| Gallery(props) X-Ref |
| No description |
| useImageSizes(images, isSelected, getSettings) X-Ref |
| Calculates the image sizes that are available for the current gallery images in order to populate the 'Resolution' 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 |
| 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({blockGap,clientId}) 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 |
| toggleRandomOrder() X-Ref |
| No description |
| toggleOpenInNewTab(openInNewTab) X-Ref |
| No description |
| updateImagesSize(newSizeSlug) X-Ref |
| No description |
| saveWithInnerBlocks({attributes}) 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. |
| useShouldShowPlaceHolder({attributes = {style: undefined,backgroundColor: undefined,textColor: undefined,fontSize: undefined},usedLayoutType = '',hasInnerBlocks = false}) X-Ref |
| A custom hook to tell the Group block whether to show the variation placeholder. param: {Object} props Arguments to pass to hook. param: {Object} [props.attributes] The block's attributes. param: {string} [props.usedLayoutType] The block's current layout type. param: {boolean} [props.hasInnerBlocks] Whether the block has inner blocks. return: {[boolean, Function]} A state value and setter function. |
| GroupPlaceHolder({name,onSelect}) X-Ref |
| Display group variations if none is selected. param: {Object} props Component props. param: {string} props.name The block's name. param: {Function} props.onSelect Function to set block's attributes. return: {JSX.Element} The placeholder. |
| GroupEditControls({tagName,onSelectTagName}) X-Ref |
| No description |
| GroupEdit({attributes,name,setAttributes,clientId}) X-Ref |
| No description |
| group_save_save({attributes: {tagName: Tag}}) X-Ref |
| WordPress dependencies |
| HeadingEdit({attributes,setAttributes,mergeBlocks,onReplace,style,clientId}) X-Ref |
| No description |
| heading_save_save({attributes}) 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({attributes,setAttributes,context}) X-Ref |
| No description |
| home_link_save_save() X-Ref |
| WordPress dependencies |
| HTMLEditPreview({content,isSelected}) X-Ref |
| No description |
| HTMLEdit({attributes,setAttributes,isSelected}) X-Ref |
| No description |
| switchToPreview() X-Ref |
| No description |
| switchToHTML() X-Ref |
| No description |
| html_save_save({attributes}) X-Ref |
| WordPress dependencies |
| image_Image({temporaryURL,attributes,setAttributes,isSingleSelected,insertBlocksAfter,onReplace,onSelectImage,onSelectURL,onUploadError,context,clientId,blockEditingMode,parentLayoutType,maxContentWidth}) X-Ref |
| No description |
| onResizeStart() X-Ref |
| No description |
| onResizeStop() X-Ref |
| No description |
| onImageError() X-Ref |
| No description |
| onImageLoad(event) X-Ref |
| No description |
| onSetHref(props) X-Ref |
| No description |
| onSetLightbox(enable) X-Ref |
| No description |
| resetLightbox() 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 |
| switchToCover() X-Ref |
| No description |
| useMaxWidthObserver() X-Ref |
| No description |
| hasSize(image, size) X-Ref |
| Checks if WP generated the specified image size. Size generation is skipped when the image is smaller than the said size. param: {Object} image param: {string} size return: {boolean} Whether or not it has default image size. |
| ImageEdit({attributes,setAttributes,isSelected: isSingleSelected,className,insertBlocksAfter,onReplace,context,clientId,__unstableParentLayout: parentLayout}) X-Ref |
| No description |
| onUploadError(message) X-Ref |
| No description |
| onSelectImagesList(images) X-Ref |
| No description |
| onSelectImage(media) X-Ref |
| No description |
| onSelectURL(newURL) X-Ref |
| No description |
| image_save_save({attributes}) X-Ref |
| No description |
| stripFirstImage(attributes, {shortcode}) X-Ref |
| WordPress dependencies |
| getFirstAnchorAttributeFormHTML(html, attributeName) X-Ref |
| No description |
| LatestComments({attributes,setAttributes}) X-Ref |
| Maximum number of comments a user can show using this block. |
| getFeaturedImageDetails(post, size) X-Ref |
| No description |
| LatestPostsEdit({attributes,setAttributes}) X-Ref |
| No description |
| createListBlockFromDOMElement(listElement) X-Ref |
| No description |
| migrateToListV2(attributes) X-Ref |
| No description |
| migrateTypeToInlineStyle(attributes) X-Ref |
| No description |
| TagName(props, ref) X-Ref |
| WordPress dependencies |
| useMigrateOnLoad(attributes, clientId) X-Ref |
| At the moment, deprecations don't handle create blocks from attributes (like when using CPT templates). For this reason, this hook is necessary to avoid breaking templates using the old list block format. param: {Object} attributes Block attributes. param: {string} clientId Block client ID. |
| useOutdentList(clientId) X-Ref |
| No description |
| IndentUI({clientId}) X-Ref |
| No description |
| list_edit_Edit({attributes,setAttributes,clientId,style}) X-Ref |
| No description |
| list_save_save({attributes}) X-Ref |
| WordPress dependencies |
| getListContentSchema({phrasingContentSchema}) X-Ref |
| Internal dependencies |
| getListContentFlat(blocks) X-Ref |
| No description |
| useIndentListItem(clientId) X-Ref |
| No description |
| useOutdentListItem() X-Ref |
| No description |
| getParentListItemId(id) X-Ref |
| No description |
| use_enter_useEnter(props) X-Ref |
| Internal dependencies |
| onKeyDown(event) X-Ref |
| No description |
| useSpace(clientId) X-Ref |
| Internal dependencies |
| onKeyDown(event) X-Ref |
| No description |
| useMerge(clientId, onMerge) X-Ref |
| Internal dependencies |
| getTrailingId(id) X-Ref |
| No description |
| getParentListItemId(id) X-Ref |
| No description |
| _getNextId(id) X-Ref |
| Return the next list item with respect to the given list item. If none, return the next list item of the parent list item if it exists. param: {string} id A list item client ID. return: {string?} The client ID of the next list item. |
| getNextId(id) X-Ref |
| Given a client ID, return the client ID of the list item on the next line, regardless of indentation level. param: {string} id The client ID of the current list item. return: {string?} The client ID of the next list item. |
| mergeWithNested(clientIdA, clientIdB) X-Ref |
| No description |
| edit_IndentUI({clientId}) X-Ref |
| No description |
| ListItemEdit({attributes,setAttributes,clientId,mergeBlocks}) X-Ref |
| No description |
| list_item_save_save({attributes}) X-Ref |
| No description |
| LoginOutEdit({attributes,setAttributes}) X-Ref |
| No description |
| imageFillStyles(url, focalPoint) X-Ref |
| No description |
| ToolbarEditButton({mediaId,mediaUrl,onSelectMedia,toggleUseFeaturedImage,useFeaturedImage}) X-Ref |
| No description |
| PlaceholderContainer({className,mediaUrl,onSelectMedia,toggleUseFeaturedImage}) X-Ref |
| No description |
| MediaContainer(props, ref) X-Ref |
| No description |
| getImageSourceUrlBySizeSlug(image, slug) X-Ref |
| No description |
| edit_attributesFromMedia({attributes: {linkDestination,href},setAttributes}) X-Ref |
| No description |
| MediaTextEdit({attributes,isSelected,setAttributes,context: {postId,postType}}) X-Ref |
| No description |
| media_text_save_save({attributes}) X-Ref |
| No description |
| MissingEdit({attributes,clientId}) X-Ref |
| No description |
| convertToHTML() X-Ref |
| No description |
| missing_save_save({attributes}) X-Ref |
| WordPress dependencies |
| MoreEdit({attributes: {customText,noTeaser},insertBlocksAfter,setAttributes}) X-Ref |
| No description |
| more_save_save({attributes: {customText,noTeaser}}) X-Ref |
| WordPress dependencies |
| 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 |
| useNavigationMenu(ref) X-Ref |
| Internal dependencies |
| selectExistingMenu(select, ref) X-Ref |
| No description |
| 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. |
| buildMenuLabel(title, id, status) X-Ref |
| No description |
| NavigationMenuSelector({currentMenuId,onSelectNavigationMenu,onSelectClassicMenu,onCreateNew,actionLabel,createNavigationMenuIsSuccess,createNavigationMenuIsError}) X-Ref |
| No description |
| NavigationPlaceholder({isSelected,currentMenuId,clientId,canUserCreateNavigationMenus = false,isResolvingCanUserCreateNavigationMenus,onSelectNavigationMenu,onSelectClassicMenu,onCreateEmpty}) X-Ref |
| No description |
| OverlayMenuIcon({icon}) X-Ref |
| No description |
| ResponsiveWrapper({children,id,isOpen,isResponsive,onToggle,isHiddenByDefault,overlayBackgroundColor,overlayTextColor,hasIcon,icon}) X-Ref |
| No description |
| NavigationInnerBlocks({clientId,hasCustomPlaceholder,orientation,templateLock}) X-Ref |
| No description |
| NavigationMenuNameControl() X-Ref |
| No description |
| areBlocksDirty(originalBlocks, blocks) X-Ref |
| No description |
| UnsavedInnerBlocks({blocks,createNavigationMenu,hasSelection}) X-Ref |
| No description |
| NavigationMenuDeleteControl({onDelete}) X-Ref |
| No description |
| useNavigationNotice({name,message = ''} = {}) X-Ref |
| No description |
| OverlayMenuPreview({setAttributes,hasIcon,icon}) 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, level = 0) X-Ref |
| A recursive function that maps menu item nodes to blocks. param: {WPNavMenuItem[]} menuItems An array of WPNavMenuItem items. param: {number} level An integer representing the nesting level. return: {Object} Object containing innerBlocks and mapping. |
| menuItemToBlockAttributes({title: menuItemTitleField,xfn,classes,attr_title,object,object_id,description,url,type: menuItemTypeField,target}, blockType, level) X-Ref |
| Convert block attributes to menu item. param: {WPNavMenuItem} menuItem the menu item to be converted to block attributes. param: {string} blockType The block type. param: {number} level An integer representing the nesting level. return: {Object} the block attributes converted from the WPNavMenuItem item. |
| createDataTree(dataset, id = 'id', relation = 'parent') 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(createNavigationMenu, {throwOnError = false} = {}) 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 |
| useInnerBlocks(clientId) X-Ref |
| No description |
| getComputedStyle(node) X-Ref |
| External dependencies |
| detectColors(colorsDetectionElement, setColor, setBackground) X-Ref |
| No description |
| 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 |
| getNavigationChildBlockProps(innerBlocksColors) X-Ref |
| No description |
| DeletedNavigationWarning({onCreateNew,isNotice = false}) X-Ref |
| No description |
| AddSubmenuItem({block,onClose,expandedState,expand,setInsertedBlock}) X-Ref |
| No description |
| LeafMoreMenu(props) 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. |
| LinkUIBlockInserter({clientId,onBack,onSelectBlock}) X-Ref |
| No description |
| UnforwardedLinkUI(props, ref) X-Ref |
| No description |
| AdditionalBlockContent({block,insertedBlock,setInsertedBlock}) X-Ref |
| No description |
| AccessibleDescription({id,children}) X-Ref |
| WordPress dependencies |
| AccessibleMenuDescription({id}) X-Ref |
| Internal dependencies |
| useResponsiveMenu(navRef) X-Ref |
| No description |
| ColorTools({textColor,setTextColor,backgroundColor,setBackgroundColor,overlayTextColor,setOverlayTextColor,overlayBackgroundColor,setOverlayBackgroundColor,clientId,navRef}) X-Ref |
| No description |
| Navigation({attributes,setAttributes,clientId,isSelected,className,backgroundColor,setBackgroundColor,textColor,setTextColor,overlayBackgroundColor,setOverlayBackgroundColor,overlayTextColor,setOverlayTextColor,hasSubmenuIndicatorSetting = true,customPlaceholder: CustomPlaceholder = null,__unstableLayoutClassNames: layoutClassNames}) X-Ref |
| No description |
| navigation_save_save({attributes}) X-Ref |
| WordPress dependencies |
| handleDragStart(event) X-Ref |
| No description |
| handleDragEnd() X-Ref |
| No description |
| handleDragEnter(event) X-Ref |
| No description |
| getMissingText(type) X-Ref |
| No description |
| Controls({attributes,setAttributes,setIsLabelFieldFocused}) X-Ref |
| No description |
| NavigationLinkEdit({attributes,isSelected,setAttributes,insertBlocksAfter,mergeBlocks,onReplace,context,clientId}) X-Ref |
| No description |
| 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 |
| WordPress dependencies |
| enhanceNavigationLinkVariations(settings, name) X-Ref |
| No description |
| handleDragStart(event) X-Ref |
| No description |
| handleDragEnd() X-Ref |
| No description |
| handleDragEnter(event) X-Ref |
| No description |
| NavigationSubmenuEdit({attributes,isSelected,setAttributes,mergeBlocks,onReplace,context,clientId}) X-Ref |
| Navigation Link Block Attributes |
| 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 |
| No description |
| nextpage_save_save() X-Ref |
| WordPress dependencies |
| useParsePatternDependencies() X-Ref |
| Hook used by PatternEdit to parse block patterns. It returns a function that takes a pattern and returns nothing but throws an error if the pattern is recursive. return: {Function} A function to parse block patterns. |
| parsePatternDependencies(deps, {name,blocks}) X-Ref |
| Parse a given pattern and traverse its contents to detect any subsequent patterns on which it may depend. Such occurrences will be added to an internal dependency graph. If a circular dependency is detected, an error will be thrown. EXPORTED FOR TESTING PURPOSES ONLY. param: {Map<string, Set<string>>} deps Map of pattern dependencies. param: {Object} pattern Pattern. param: {string} pattern.name Pattern name. param: {Array} pattern.blocks Pattern's block list. |
| registerDependency(deps, a, b) X-Ref |
| Declare that pattern `a` depends on pattern `b`. If a circular dependency is detected, an error will be thrown. EXPORTED FOR TESTING PURPOSES ONLY. param: {Map<string, Set<string>>} deps Map of pattern dependencies. param: {string} a Slug for pattern A. param: {string} b Slug for pattern B. |
| hasCycle(deps, slug, visitedNodes = new Set() X-Ref |
| Determine if a given pattern has circular dependencies on other patterns. This will be determined by running a depth-first search on the current state of the graph represented by `patternDependencies`. param: {Map<string, Set<string>>} deps Map of pattern dependencies. param: {string} slug Pattern slug. param: {Set<string>} [visitedNodes] Set to track visited nodes in the graph. param: {Set<string>} [currentPath] Set to track and backtrack graph paths. return: {boolean} Whether any cycle was found. |
| injectThemeAttributeInBlockTemplateContent(block) X-Ref |
| No description |
| createNavigationLinks(pages = []) X-Ref |
| Converts an array of pages into a nested array of navigation link blocks. param: {Array} pages An array of pages. return: {Array} A nested array of navigation link blocks. |
| findNavigationLinkById(navigationLinks, id) X-Ref |
| Finds a navigation link block by id, recursively. It might be possible to make this a more generic helper function. param: {Array} navigationLinks An array of navigation link blocks. param: {number} id The id of the navigation link to find. return: {Object|null} The navigation link block with the given id. |
| convertToNavigationLinks(pages = [], parentPageID = null) X-Ref |
| No description |
| useConvertToNavigationLinks({clientId,pages,parentClientId,parentPageID}) X-Ref |
| No description |
| ConvertToLinksModal({onClick,onClose,disabled}) X-Ref |
| No description |
| BlockContent({blockProps,innerBlocksProps,hasResolvedPages,blockList,pages,parentPageID}) X-Ref |
| No description |
| PageListEdit({context,clientId,attributes,setAttributes}) X-Ref |
| No description |
| useFrontPageId() X-Ref |
| No description |
| PageListItemEdit({context,attributes}) X-Ref |
| No description |
| useOnEnter(props) X-Ref |
| No description |
| onKeyDown(event) X-Ref |
| No description |
| ParagraphRTLControl({direction,setDirection}) X-Ref |
| No description |
| hasDropCapDisabled(align) X-Ref |
| No description |
| DropCapControl({clientId,attributes,setAttributes}) X-Ref |
| No description |
| ParagraphBlock({attributes,mergeBlocks,onReplace,onRemove,setAttributes,clientId}) X-Ref |
| No description |
| paragraph_save_save({attributes}) X-Ref |
| No description |
| PostAuthorEdit({isSelected,context: {postType,postId,queryId},attributes,setAttributes}) X-Ref |
| No description |
| PostAuthorNameEdit({context: {postType,postId},attributes: {textAlign,isLink,linkTarget},setAttributes}) X-Ref |
| No description |
| PostAuthorBiographyEdit({context: {postType,postId},attributes: {textAlign},setAttributes}) X-Ref |
| No description |
| post_comment_edit_Edit({attributes: {commentId},setAttributes}) X-Ref |
| No description |
| post_comment_save_save() X-Ref |
| WordPress dependencies |
| PostCommentsCountEdit({attributes,context,setAttributes}) X-Ref |
| No description |
| PostCommentsFormEdit({attributes,context,setAttributes}) X-Ref |
| No description |
| PostCommentsLinkEdit({context,attributes,setAttributes}) X-Ref |
| No description |
| ReadOnlyContent({parentLayout,layoutClassNames,userCanEdit,postType,postId}) X-Ref |
| No description |
| EditableContent({context = {}}) X-Ref |
| No description |
| Content(props) X-Ref |
| No description |
| edit_Placeholder({layoutClassNames}) X-Ref |
| No description |
| RecursionError() X-Ref |
| No description |
| PostContentEdit({context,__unstableLayoutClassNames: layoutClassNames,__unstableParentLayout: parentLayout}) X-Ref |
| No description |
| PostDateEdit({attributes: {textAlign,format,isLink,displayType},context: {postId,postType: postTypeSlug,queryId},setAttributes}) X-Ref |
| No description |
| is12HourFormat(format) X-Ref |
| No description |
| PostExcerptEditor({attributes: {textAlign,moreText,showMoreOnNewLine,excerptLength},setAttributes,isSelected,context: {postId,postType,queryId}}) X-Ref |
| No description |
| utils_dimRatioToClass(ratio) X-Ref |
| Generates the opacity/dim class based on given number. param: {number} ratio Dim/opacity number. return: {string} Generated class. |
| getMediaSourceUrlBySizeSlug(media, slug) X-Ref |
| No description |
| PostFeaturedImageEdit({clientId,attributes,setAttributes,context: {postId,postType: postTypeSlug,queryId}}) X-Ref |
| No description |
| PostNavigationLinkEdit({context: {postType},attributes: {type,label,showTitle,textAlign,linkLabel,arrow,taxonomy},setAttributes}) X-Ref |
| No description |
| PostTemplateInnerBlocks({classList}) X-Ref |
| No description |
| PostTemplateBlockPreview({blocks,blockContextId,classList,isHidden,setActiveBlockContextId}) X-Ref |
| No description |
| PostTemplateEdit({setAttributes,clientId,context: {query: {perPage,offset = 0,postType,order,orderBy,author,search,exclude,sticky,inherit,taxQuery,parents,pages,format,...restQueryArgs} = {},templateSlug,previewPostType},attributes: {layout},__unstableLayoutClassNames}) X-Ref |
| No description |
| PostTemplateSave() X-Ref |
| WordPress dependencies |
| usePostTerms({postId,term}) X-Ref |
| No description |
| PostTermsEdit({attributes,clientId,context,isSelected,setAttributes,insertBlocksAfter}) X-Ref |
| No description |
| enhanceVariations(settings, name) X-Ref |
| No description |
| PostTimeToReadEdit({attributes,setAttributes,context}) X-Ref |
| No description |
| PostTitleEdit({attributes: {level,levelOptions,textAlign,isLink,rel,linkTarget},setAttributes,context: {postType,postId,queryId},insertBlocksAfter}) X-Ref |
| No description |
| PreformattedEdit({attributes,mergeBlocks,setAttributes,onRemove,insertBlocksAfter,style}) X-Ref |
| No description |
| preformatted_save_save({attributes}) X-Ref |
| WordPress dependencies |
| parseBorderColor(styleString) X-Ref |
| No description |
| multilineToInline(value) X-Ref |
| No description |
| PullQuoteEdit({attributes,setAttributes,isSelected,insertBlocksAfter}) X-Ref |
| No description |
| pullquote_save_save({attributes}) X-Ref |
| No description |
| useIsPostTypeHierarchical(postType) X-Ref |
| Hook that returns whether a specific post type is hierarchical. param: {string} postType The post type to check. return: {boolean} Whether a specific post type is hierarchical. |
| useAllowedControls(attributes) X-Ref |
| Hook that returns the query properties' names defined by the active block variation, to determine which block's filters to show. param: {Object} attributes Block attributes. return: {string[]} An array of the query attributes. |
| isControlAllowed(allowedControls, key) X-Ref |
| No description |
| useBlockNameForPatterns(clientId, attributes) X-Ref |
| Helper hook that determines if there is an active variation of the block and if there are available specific patterns for this variation. If there are, these patterns are going to be the only ones suggested to the user in setup and replace flow, without including the default ones for Query Loop. If there are no such patterns, the default ones for Query Loop are going to be suggested. param: {string} clientId The block's client ID. param: {Object} attributes The block's attributes. return: {string} The block name to be used in the patterns suggestions. |
| useScopedBlockVariations(attributes) X-Ref |
| Helper hook that determines if there is an active variation of the block and if there are available specific scoped `block` variations connected with this variation. If there are, these variations are going to be the only ones suggested to the user in setup flow when clicking to `start blank`, without including the default ones for Query Loop. If there are no such scoped `block` variations, the default ones for Query Loop are going to be suggested. The way we determine such variations is with the convention that they have the `namespace` attribute defined as an array. This array should contain the names(`name` property) of any variations they want to be connected to. For example, if we have a `Query Loop` scoped `inserter` variation with the name `products`, we can connect a scoped `block` variation by setting its `namespace` attribute to `['products']`. If the user selects this variation, the `namespace` attribute will be overridden by the main `inserter` variation. param: {Object} attributes The block's attributes. return: {WPBlockVariation[]} The block variations to be suggested in setup flow, when clicking to `start blank`. |
| EnhancedPaginationControl({enhancedPagination,setAttributes,clientId}) X-Ref |
| No description |
| QueryToolbar({openPatternSelectionModal,name,clientId}) X-Ref |
| No description |
| OrderControl({order,orderBy,onChange}) X-Ref |
| No description |
| AuthorControl({value,onChange}) X-Ref |
| No description |
| ParentControl({parents,postType,onChange}) X-Ref |
| No description |
| TaxonomyControls({onChange,query}) X-Ref |
| No description |
| TaxonomyItem({taxonomy,termIds,onChange}) X-Ref |
| Renders a `FormTokenField` for a given taxonomy. param: {Object} props The props for the component. param: {Object} props.taxonomy The taxonomy object. param: {number[]} props.termIds An array with the block's term ids for the given taxonomy. param: {Function} props.onChange Callback `onChange` function. return: {JSX.Element} The rendered component. |
| formatNamesToValues(names, formats) X-Ref |
| No description |
| FormatControls({onChange,query: {format}}) X-Ref |
| No description |
| StickyControl({value,onChange}) X-Ref |
| No description |
| QueryInspectorControls(props) X-Ref |
| No description |
| EnhancedPaginationModal({clientId,attributes: {enhancedPagination},setAttributes}) X-Ref |
| No description |
| QueryContent({attributes,setAttributes,openPatternSelectionModal,name,clientId,context}) X-Ref |
| No description |
| QueryPlaceholder({attributes,clientId,name,openPatternSelectionModal}) X-Ref |
| No description |
| QueryVariationPicker({clientId,attributes,icon,label}) X-Ref |
| No description |
| normalizeSearchInput(input = '') X-Ref |
| Sanitizes the search input string. param: {string} input The search input to normalize. return: {string} The normalized search input. |
| getPatternSearchRank(pattern, searchValue) X-Ref |
| Get the search rank for a given pattern and a specific search term. param: {Object} pattern Pattern to rank param: {string} searchValue Search term return: {number} A pattern search rank |
| searchPatterns(patterns = [], searchValue = '') X-Ref |
| Filters an pattern list given a search term. param: {Array} patterns Item list param: {string} searchValue Search input. return: {Array} Filtered pattern list. |
| PatternSelectionModal({clientId,attributes,setIsPatternSelectionModalOpen}) X-Ref |
| No description |
| query_save_save({attributes: {tagName: Tag = 'div'}}) X-Ref |
| WordPress dependencies |
| QueryNoResultsEdit() X-Ref |
| No description |
| query_no_results_save_save() X-Ref |
| WordPress dependencies |
| QueryPaginationArrowControls({value,onChange}) X-Ref |
| No description |
| QueryPaginationLabelControl({value,onChange}) X-Ref |
| No description |
| edit_QueryPaginationEdit({attributes: {paginationArrow,showLabel},setAttributes,clientId}) X-Ref |
| No description |
| query_pagination_save_save() X-Ref |
| WordPress dependencies |
| QueryPaginationNextEdit({attributes: {label},setAttributes,context: {paginationArrow,showLabel}}) X-Ref |
| No description |
| QueryPaginationNumbersEdit({attributes,setAttributes}) X-Ref |
| No description |
| QueryPaginationPreviousEdit({attributes: {label},setAttributes,context: {paginationArrow,showLabel}}) X-Ref |
| No description |
| useArchiveLabel() X-Ref |
| WordPress dependencies |
| QueryTitleEdit({attributes: {type,level,levelOptions,textAlign,showPrefix,showSearchTerm},setAttributes}) X-Ref |
| No description |
| QuoteEdit({attributes,setAttributes,insertBlocksAfter,clientId,className,style,isSelected}) X-Ref |
| No description |
| quote_save_save({attributes}) X-Ref |
| No description |
| setBlockEditMode(setEditMode, blocks, mode) X-Ref |
| No description |
| RecursionWarning() X-Ref |
| No description |
| ReusableBlockEditRecursionWrapper(props) X-Ref |
| No description |
| ReusableBlockControl({recordId,canOverrideBlocks,hasContent,handleEditOriginal,resetContent}) X-Ref |
| No description |
| ReusableBlockEdit({name,attributes: {ref,content},__unstableParentLayout: parentLayout,clientId: patternClientId,setAttributes}) X-Ref |
| No description |
| ReadMore({attributes: {content,linkTarget},setAttributes,insertBlocksAfter}) X-Ref |
| No description |
| RSSEdit({attributes,setAttributes}) 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({className,attributes,setAttributes,toggleSelection,isSelected,clientId}) X-Ref |
| No description |
| useDeprecatedOpacity(opacity, currentColor, setAttributes) X-Ref |
| WordPress dependencies |
| SeparatorEdit({attributes,setAttributes}) X-Ref |
| No description |
| separatorSave({attributes}) X-Ref |
| WordPress dependencies |
| ShortcodeEdit({attributes,setAttributes}) X-Ref |
| No description |
| shortcode_save_save({attributes}) X-Ref |
| WordPress dependencies |
| onResizeStart() X-Ref |
| No description |
| onResizeStop() X-Ref |
| No description |
| SiteLogoReplaceFlow({mediaURL,onRemoveLogo,...mediaReplaceProps}) X-Ref |
| No description |
| LogoEdit({attributes,className,setAttributes,isSelected}) X-Ref |
| No description |
| SiteTaglineEdit({attributes,setAttributes,insertBlocksAfter}) X-Ref |
| No description |
| setTagline(newTagline) X-Ref |
| No description |
| SiteTitleEdit({attributes,setAttributes,insertBlocksAfter}) X-Ref |
| No description |
| setTitle(newTitle) X-Ref |
| No description |
| SocialLinksEdit(props) X-Ref |
| No description |
| social_links_save_save(props) X-Ref |
| WordPress dependencies |
| DimensionInput({label,onChange,isResizing,value = ''}) X-Ref |
| No description |
| SpacerControls({setAttributes,orientation,height,width,isResizing}) X-Ref |
| No description |
| spacer_save_save({attributes}) X-Ref |
| WordPress dependencies |
| createTable({rowCount,columnCount}) 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 | undefined} 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, {sectionName,rowIndex,columnCount}) 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, {sectionName,rowIndex}) 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, {columnIndex}) 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, {columnIndex}) 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 existence 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({name,...props}) X-Ref |
| No description |
| TableEdit({attributes,setAttributes,insertBlocksAfter,isSelected: isSingleSelected}) 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 | undefined} 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(delta = 0) 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({attributes}) X-Ref |
| No description |
| normalizeRowColSpan(rowColSpan) X-Ref |
| Normalize the rowspan/colspan value. Returns undefined if the parameter is not a positive number or the default value (1) for rowspan/colspan. param: {number|undefined} rowColSpan rowspan/colspan value. return: {string|undefined} normalized rowspan/colspan value. |
| TableOfContentsList({nestedHeadingList,disableLinkActivation,onClick}) X-Ref |
| Internal dependencies |
| linearToNestedHeadingList(headingList) X-Ref |
| Takes a flat list of heading parameters and nests them based on each header's immediate parent's level. param: headingList The flat list of headings to nest. return: The nested list of headings. |
| getLatestHeadings(select, clientId) X-Ref |
| No description |
| observeCallback(select, dispatch, clientId) X-Ref |
| No description |
| useObserveHeadings(clientId) X-Ref |
| No description |
| TableOfContentsEdit({attributes: {headings = [],onlyIncludeCurrentPage},clientId,setAttributes}) X-Ref |
| No description |
| table_of_contents_save_save({attributes: {headings = []}}) X-Ref |
| No description |
| TagCloudEdit({attributes,setAttributes}) X-Ref |
| No description |
| __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. |
| upperCaseFirst(input) X-Ref |
| Upper case the first character of an input string. |
| capitalCaseTransform(input) X-Ref |
| No description |
| capitalCase(input, options) X-Ref |
| No description |
| dotCase(input, options) X-Ref |
| No description |
| paramCase(input, options) 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({areaLabel,onClose,onSubmit}) X-Ref |
| No description |
| TemplatePartPlaceholder({area,clientId,templatePartId,onOpenSelectionModal,setAttributes}) X-Ref |
| No description |
| mapTemplatePartToBlockPattern(templatePart) X-Ref |
| This maps the properties of a template part to those of a block pattern. param: {Object} templatePart return: {Object} The template part in the shape of block pattern. |
| TemplatePartSelectionModal({setAttributes,onClose,templatePartId = null,area,clientId}) X-Ref |
| No description |
| transformWidgetToBlock(widget) X-Ref |
| Converts a widget entity record into a block. param: {Object} widget The widget entity record. return: {Object} a block (converted from the entity record). |
| switchLegacyWidgetType(block) X-Ref |
| Switch Legacy Widget to the first matching transformation block. param: {Object} block Legacy Widget block object return: {Object|undefined} a block |
| transformInnerBlocks(innerBlocks = []) X-Ref |
| No description |
| TemplatePartImportControls({area,setAttributes}) X-Ref |
| No description |
| TemplatePartAdvancedControls({tagName,setAttributes,isEntityAvailable,templatePartId,defaultWrapper,hasInnerBlocks}) X-Ref |
| No description |
| useRenderAppender(hasInnerBlocks) X-Ref |
| No description |
| useLayout(layout) X-Ref |
| No description |
| NonEditableTemplatePartPreview({postId: id,layout,tagName: TagName,blockProps}) X-Ref |
| No description |
| EditableTemplatePartInnerBlocks({postId: id,hasInnerBlocks,layout,tagName: TagName,blockProps}) X-Ref |
| No description |
| TemplatePartInnerBlocks({postId: id,hasInnerBlocks,layout,tagName: TagName,blockProps}) X-Ref |
| No description |
| ReplaceButton({isEntityAvailable,area,templatePartId,isTemplatePartSelectionOpen,setIsTemplatePartSelectionOpen}) X-Ref |
| No description |
| TemplatesList({area,clientId,isEntityAvailable,onSelect}) X-Ref |
| No description |
| TemplatePartEdit({attributes,setAttributes,clientId}) X-Ref |
| No description |
| getTemplatePartIcon(iconName) X-Ref |
| No description |
| enhanceTemplatePartVariations(settings, name) X-Ref |
| No description |
| TermDescriptionEdit({attributes,setAttributes,mergedStyle}) X-Ref |
| No description |
| TextColumnsEdit({attributes,setAttributes}) X-Ref |
| No description |
| text_columns_save_save({attributes}) X-Ref |
| WordPress dependencies |
| VerseEdit({attributes,setAttributes,mergeBlocks,onRemove,insertBlocksAfter,style}) X-Ref |
| No description |
| verse_save_save({attributes}) X-Ref |
| WordPress dependencies |
| Tracks({tracks = []}) X-Ref |
| No description |
| TrackList({tracks,onEditPress}) X-Ref |
| No description |
| SingleTrackEditor({track,onChange,onClose,onRemove}) X-Ref |
| No description |
| TracksEditor({tracks = [],onChange}) X-Ref |
| No description |
| VideoEdit({isSelected: isSingleSelected,attributes,className,setAttributes,insertBlocksAfter,onReplace}) 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({attributes}) X-Ref |
| No description |
| FootnotesEdit({context: {postType,postId}}) 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_v4(options, buf, offset) X-Ref |
| No description |
| onClick() X-Ref |
| No description |
| BlockKeyboardShortcuts() X-Ref |
| No description |
| Generated : Tue Dec 24 08:20:01 2024 | Cross-referenced by PHPXref |