diff --git a/docs/reference-guides/data/data-core-block-editor.md b/docs/reference-guides/data/data-core-block-editor.md
index fc01e5cd49f65..c7c71e86845ff 100644
--- a/docs/reference-guides/data/data-core-block-editor.md
+++ b/docs/reference-guides/data/data-core-block-editor.md
@@ -6,7 +6,7 @@ Namespace: `core/block-editor`.
-# **areInnerBlocksControlled**
+### areInnerBlocksControlled
Checks if a given block has controlled inner blocks.
@@ -19,7 +19,7 @@ _Returns_
- `boolean`: True if the block has controlled inner blocks.
-# **canInsertBlocks**
+### canInsertBlocks
Determines if the given blocks are allowed to be inserted into the block
list.
@@ -34,7 +34,7 @@ _Returns_
- `boolean`: Whether the given blocks are allowed to be inserted.
-# **canInsertBlockType**
+### canInsertBlockType
Determines if the given block type is allowed to be inserted into the block list.
@@ -48,7 +48,7 @@ _Returns_
- `boolean`: Whether the given block type is allowed to be inserted.
-# **didAutomaticChange**
+### didAutomaticChange
Returns true if the last change was an automatic change, false otherwise.
@@ -60,7 +60,7 @@ _Returns_
- `boolean`: Whether the last change was automatic.
-# **getAdjacentBlockClientId**
+### getAdjacentBlockClientId
Returns the client ID of the block adjacent one at the given reference
startClientId and modifier directionality. Defaults start startClientId to
@@ -77,7 +77,7 @@ _Returns_
- `?string`: Return the client ID of the block, or null if none exists.
-# **getBlock**
+### getBlock
Returns a block given its client ID. This is a parsed copy of the block,
containing its `blockName`, `clientId`, and current `attributes` state. This
@@ -103,7 +103,7 @@ _Returns_
- `Object`: Parsed block object.
-# **getBlockAttributes**
+### getBlockAttributes
Returns a block's attributes given its client ID, or null if no block exists with
the client ID.
@@ -117,7 +117,7 @@ _Returns_
- `Object?`: Block attributes.
-# **getBlockCount**
+### getBlockCount
Returns the number of blocks currently present in the post.
@@ -130,7 +130,7 @@ _Returns_
- `number`: Number of blocks in the post.
-# **getBlockHierarchyRootClientId**
+### getBlockHierarchyRootClientId
Given a block client ID, returns the root of the hierarchy from which the block is nested, return the block itself for root level blocks.
@@ -143,7 +143,7 @@ _Returns_
- `string`: Root client ID
-# **getBlockIndex**
+### getBlockIndex
Returns the index at which the block corresponding to the specified client
ID occurs within the block order, or `-1` if the block does not exist.
@@ -158,7 +158,7 @@ _Returns_
- `number`: Index at which block exists in order.
-# **getBlockInsertionPoint**
+### getBlockInsertionPoint
Returns the insertion point, the index at which the new inserted block would
be placed. Defaults to the last index.
@@ -171,7 +171,7 @@ _Returns_
- `Object`: Insertion point object with `rootClientId`, `index`.
-# **getBlockListSettings**
+### getBlockListSettings
Returns the Block List settings of a block, if any exist.
@@ -184,7 +184,7 @@ _Returns_
- `?Object`: Block settings of the block if set.
-# **getBlockMode**
+### getBlockMode
Returns the block's editing mode, defaulting to "visual" if not explicitly
assigned.
@@ -198,7 +198,7 @@ _Returns_
- `Object`: Block editing mode.
-# **getBlockName**
+### getBlockName
Returns a block's name given its client ID, or null if no block exists with
the client ID.
@@ -212,7 +212,7 @@ _Returns_
- `string`: Block name.
-# **getBlockOrder**
+### getBlockOrder
Returns an array containing all block client IDs in the editor in the order
they appear. Optionally accepts a root client ID of the block list for which
@@ -227,7 +227,7 @@ _Returns_
- `Array`: Ordered client IDs of editor blocks.
-# **getBlockParents**
+### getBlockParents
Given a block client ID, returns the list of all its parents from top to bottom.
@@ -241,7 +241,7 @@ _Returns_
- `Array`: ClientIDs of the parent blocks.
-# **getBlockParentsByBlockName**
+### getBlockParentsByBlockName
Given a block client ID and a block name, returns the list of all its parents
from top to bottom, filtered by the given name(s). For example, if passed
@@ -260,7 +260,7 @@ _Returns_
- `Array`: ClientIDs of the parent blocks.
-# **getBlockRootClientId**
+### getBlockRootClientId
Given a block client ID, returns the root block from which the block is
nested, an empty string for top-level blocks, or null if the block does not
@@ -275,7 +275,7 @@ _Returns_
- `?string`: Root client ID, if exists
-# **getBlocks**
+### getBlocks
Returns all block objects for the current post being edited as an array in
the order they appear in the post. Note that this will exclude child blocks
@@ -296,7 +296,7 @@ _Returns_
- `Object[]`: Post blocks.
-# **getBlocksByClientId**
+### getBlocksByClientId
Given an array of block client IDs, returns the corresponding array of block
objects.
@@ -310,7 +310,7 @@ _Returns_
- `WPBlock[]`: Block objects.
-# **getBlockSelectionEnd**
+### getBlockSelectionEnd
Returns the current block selection end. This value may be null, and it
may represent either a singular block selection or multi-selection end.
@@ -324,7 +324,7 @@ _Returns_
- `?string`: Client ID of block selection end.
-# **getBlockSelectionStart**
+### getBlockSelectionStart
Returns the current block selection start. This value may be null, and it
may represent either a singular block selection or multi-selection start.
@@ -338,7 +338,7 @@ _Returns_
- `?string`: Client ID of block selection start.
-# **getBlockTransformItems**
+### getBlockTransformItems
Determines the items that appear in the available block transforms list.
@@ -372,7 +372,7 @@ _Properties_
- _isDisabled_ `boolean`: Whether or not the user should be prevented from inserting this item.
- _frecency_ `number`: Heuristic that combines frequency and recency.
-# **getClientIdsOfDescendants**
+### getClientIdsOfDescendants
Returns an array containing the clientIds of all descendants
of the blocks given.
@@ -386,7 +386,7 @@ _Returns_
- `Array`: ids of descendants.
-# **getClientIdsWithDescendants**
+### getClientIdsWithDescendants
Returns an array containing the clientIds of the top-level blocks
and their descendants of any depth (for nested blocks).
@@ -399,7 +399,7 @@ _Returns_
- `Array`: ids of top-level and descendant blocks.
-# **getDraggedBlockClientIds**
+### getDraggedBlockClientIds
Returns the client ids of any blocks being directly dragged.
@@ -413,7 +413,7 @@ _Returns_
- `string[]`: Array of dragged block client ids.
-# **getFirstMultiSelectedBlockClientId**
+### getFirstMultiSelectedBlockClientId
Returns the client ID of the first block in the multi-selection set, or null
if there is no multi-selection.
@@ -426,7 +426,7 @@ _Returns_
- `?string`: First block client ID in the multi-selection set.
-# **getGlobalBlockCount**
+### getGlobalBlockCount
Returns the total number of blocks, or the total number of blocks with a specific name in a post.
The number returned includes nested blocks.
@@ -440,7 +440,7 @@ _Returns_
- `number`: Number of blocks in the post, or number of blocks with name equal to blockName.
-# **getInserterItems**
+### getInserterItems
Determines the items that appear in the inserter. Includes both static
items (e.g. a regular block type) and dynamic items (e.g. a reusable block).
@@ -478,7 +478,7 @@ _Properties_
- _isDisabled_ `boolean`: Whether or not the user should be prevented from inserting this item.
- _frecency_ `number`: Heuristic that combines frequency and recency.
-# **getLastMultiSelectedBlockClientId**
+### getLastMultiSelectedBlockClientId
Returns the client ID of the last block in the multi-selection set, or null
if there is no multi-selection.
@@ -491,7 +491,7 @@ _Returns_
- `?string`: Last block client ID in the multi-selection set.
-# **getLowestCommonAncestorWithSelectedBlock**
+### getLowestCommonAncestorWithSelectedBlock
Given a block client ID, returns the lowest common ancestor with selected client ID.
@@ -504,7 +504,7 @@ _Returns_
- `string`: Common ancestor client ID or undefined
-# **getMultiSelectedBlockClientIds**
+### getMultiSelectedBlockClientIds
Returns the current multi-selection set of block client IDs, or an empty
array if there is no multi-selection.
@@ -517,7 +517,7 @@ _Returns_
- `Array`: Multi-selected block client IDs.
-# **getMultiSelectedBlocks**
+### getMultiSelectedBlocks
Returns the current multi-selection set of blocks, or an empty array if
there is no multi-selection.
@@ -530,7 +530,7 @@ _Returns_
- `Array`: Multi-selected block objects.
-# **getMultiSelectedBlocksEndClientId**
+### getMultiSelectedBlocksEndClientId
Returns the client ID of the block which ends the multi-selection set, or
null if there is no multi-selection.
@@ -549,7 +549,7 @@ _Returns_
- `?string`: Client ID of block ending multi-selection.
-# **getMultiSelectedBlocksStartClientId**
+### getMultiSelectedBlocksStartClientId
Returns the client ID of the block which begins the multi-selection set, or
null if there is no multi-selection.
@@ -568,7 +568,7 @@ _Returns_
- `?string`: Client ID of block beginning multi-selection.
-# **getNextBlockClientId**
+### getNextBlockClientId
Returns the next block's client ID from the given reference start ID.
Defaults start to the selected block. Returns null if there is no next
@@ -583,7 +583,7 @@ _Returns_
- `?string`: Adjacent block's client ID, or null if none exists.
-# **getPreviousBlockClientId**
+### getPreviousBlockClientId
Returns the previous block's client ID from the given reference start ID.
Defaults start to the selected block. Returns null if there is no previous
@@ -598,7 +598,7 @@ _Returns_
- `?string`: Adjacent block's client ID, or null if none exists.
-# **getSelectedBlock**
+### getSelectedBlock
Returns the currently selected block, or null if there is no selected block.
@@ -610,7 +610,7 @@ _Returns_
- `?Object`: Selected block.
-# **getSelectedBlockClientId**
+### getSelectedBlockClientId
Returns the currently selected block client ID, or null if there is no
selected block.
@@ -623,7 +623,7 @@ _Returns_
- `?string`: Selected block client ID.
-# **getSelectedBlockClientIds**
+### getSelectedBlockClientIds
Returns the current selection set of block client IDs (multiselection or single selection).
@@ -635,7 +635,7 @@ _Returns_
- `Array`: Multi-selected block client IDs.
-# **getSelectedBlockCount**
+### getSelectedBlockCount
Returns the number of blocks currently selected in the post.
@@ -647,7 +647,7 @@ _Returns_
- `number`: Number of blocks selected in the post.
-# **getSelectedBlocksInitialCaretPosition**
+### getSelectedBlocksInitialCaretPosition
Returns the initial caret position for the selected block.
This position is to used to position the caret properly when the selected block changes.
@@ -661,7 +661,7 @@ _Returns_
- `0|-1|null`: Initial position.
-# **getSelectionEnd**
+### getSelectionEnd
Returns the current selection end block client ID, attribute key and text
offset.
@@ -674,7 +674,7 @@ _Returns_
- `WPBlockSelection`: Selection end information.
-# **getSelectionStart**
+### getSelectionStart
Returns the current selection start block client ID, attribute key and text
offset.
@@ -687,7 +687,7 @@ _Returns_
- `WPBlockSelection`: Selection start information.
-# **getSettings**
+### getSettings
Returns the editor settings.
@@ -699,7 +699,7 @@ _Returns_
- `Object`: The editor settings object.
-# **getTemplate**
+### getTemplate
Returns the defined block template
@@ -711,7 +711,7 @@ _Returns_
- `?Array`: Block Template.
-# **getTemplateLock**
+### getTemplateLock
Returns the defined block template lock. Optionally accepts a root block
client ID as context, otherwise defaulting to the global context.
@@ -725,7 +725,7 @@ _Returns_
- `?string`: Block Template Lock
-# **hasBlockMovingClientId**
+### hasBlockMovingClientId
Returns whether block moving mode is enabled.
@@ -737,7 +737,7 @@ _Returns_
- `string`: Client Id of moving block.
-# **hasInserterItems**
+### hasInserterItems
Determines whether there are items to show in the inserter.
@@ -750,7 +750,7 @@ _Returns_
- `boolean`: Items that appear in inserter.
-# **hasMultiSelection**
+### hasMultiSelection
Returns true if a multi-selection has been made, or false otherwise.
@@ -762,7 +762,7 @@ _Returns_
- `boolean`: Whether multi-selection has been made.
-# **hasSelectedBlock**
+### hasSelectedBlock
Returns true if there is a single selected block, or false otherwise.
@@ -774,7 +774,7 @@ _Returns_
- `boolean`: Whether a single block is selected.
-# **hasSelectedInnerBlock**
+### hasSelectedInnerBlock
Returns true if one of the block's inner blocks is selected.
@@ -788,7 +788,7 @@ _Returns_
- `boolean`: Whether the block as an inner block selected
-# **isAncestorBeingDragged**
+### isAncestorBeingDragged
Returns whether a parent/ancestor of the block is being dragged.
@@ -801,7 +801,7 @@ _Returns_
- `boolean`: Whether the block's ancestor is being dragged.
-# **isAncestorMultiSelected**
+### isAncestorMultiSelected
Returns true if an ancestor of the block is multi-selected, or false
otherwise.
@@ -815,7 +815,7 @@ _Returns_
- `boolean`: Whether an ancestor of the block is in multi-selection set.
-# **isBlockBeingDragged**
+### isBlockBeingDragged
Returns whether the block is being dragged.
@@ -832,7 +832,7 @@ _Returns_
- `boolean`: Whether the block is being dragged.
-# **isBlockHighlighted**
+### isBlockHighlighted
Returns true if the current highlighted block matches the block clientId.
@@ -845,7 +845,7 @@ _Returns_
- `boolean`: Whether the block is currently highlighted.
-# **isBlockInsertionPointVisible**
+### isBlockInsertionPointVisible
Returns true if we should show the block insertion point.
@@ -857,7 +857,7 @@ _Returns_
- `?boolean`: Whether the insertion point is visible or not.
-# **isBlockMultiSelected**
+### isBlockMultiSelected
Returns true if the client ID occurs within the block multi-selection, or
false otherwise.
@@ -871,7 +871,7 @@ _Returns_
- `boolean`: Whether block is in multi-selection set.
-# **isBlockSelected**
+### isBlockSelected
Returns true if the block corresponding to the specified client ID is
currently selected and no multi-selection exists, or false otherwise.
@@ -885,7 +885,7 @@ _Returns_
- `boolean`: Whether block is selected and multi-selection exists.
-# **isBlockValid**
+### isBlockValid
Returns whether a block is valid or not.
@@ -898,7 +898,7 @@ _Returns_
- `boolean`: Is Valid.
-# **isBlockWithinSelection**
+### isBlockWithinSelection
Returns true if the block corresponding to the specified client ID is
currently selected but isn't the last of the selected blocks. Here "last"
@@ -914,7 +914,7 @@ _Returns_
- `boolean`: Whether block is selected and not the last in the selection.
-# **isCaretWithinFormattedText**
+### isCaretWithinFormattedText
Returns true if the caret is within formatted text, or false otherwise.
@@ -926,7 +926,7 @@ _Returns_
- `boolean`: Whether the caret is within formatted text.
-# **isDraggingBlocks**
+### isDraggingBlocks
Returns true if the user is dragging blocks, or false otherwise.
@@ -938,7 +938,7 @@ _Returns_
- `boolean`: Whether user is dragging blocks.
-# **isFirstMultiSelectedBlock**
+### isFirstMultiSelectedBlock
Returns true if a multi-selection exists, and the block corresponding to the
specified client ID is the first block of the multi-selection set, or false
@@ -953,7 +953,7 @@ _Returns_
- `boolean`: Whether block is first in multi-selection.
-# **isLastBlockChangePersistent**
+### isLastBlockChangePersistent
Returns true if the most recent block change is be considered persistent, or
false otherwise. A persistent change is one committed by BlockEditorProvider
@@ -967,7 +967,7 @@ _Returns_
- `boolean`: Whether the most recent block change was persistent.
-# **isMultiSelecting**
+### isMultiSelecting
Whether in the process of multi-selecting or not. This flag is only true
while the multi-selection is being selected (by mouse move), and is false
@@ -985,7 +985,7 @@ _Returns_
- `boolean`: True if multi-selecting, false if not.
-# **isNavigationMode**
+### isNavigationMode
Returns whether the navigation mode is enabled.
@@ -997,7 +997,7 @@ _Returns_
- `boolean`: Is navigation mode enabled.
-# **isSelectionEnabled**
+### isSelectionEnabled
Selector that returns if multi-selection is enabled or not.
@@ -1009,7 +1009,7 @@ _Returns_
- `boolean`: True if it should be possible to multi-select blocks, false if multi-selection is disabled.
-# **isTyping**
+### isTyping
Returns true if the user is typing, or false otherwise.
@@ -1021,7 +1021,7 @@ _Returns_
- `boolean`: Whether user is typing.
-# **isValidTemplate**
+### isValidTemplate
Returns whether the blocks matches the template or not.
@@ -1033,7 +1033,7 @@ _Returns_
- `?boolean`: Whether the template is valid or not.
-# **wasBlockJustInserted**
+### wasBlockJustInserted
Tells if the block with the passed clientId was just inserted.
@@ -1053,7 +1053,7 @@ _Returns_
-# **clearSelectedBlock**
+### clearSelectedBlock
Returns an action object used in signalling that the block selection is cleared.
@@ -1061,7 +1061,7 @@ _Returns_
- `Object`: Action object.
-# **duplicateBlocks**
+### duplicateBlocks
Generator that triggers an action used to duplicate a list of blocks.
@@ -1070,7 +1070,7 @@ _Parameters_
- _clientIds_ `string[]`:
- _updateSelection_ `boolean`:
-# **enterFormattedText**
+### enterFormattedText
Returns an action object used in signalling that the caret has entered formatted text.
@@ -1078,7 +1078,7 @@ _Returns_
- `Object`: Action object.
-# **exitFormattedText**
+### exitFormattedText
Returns an action object used in signalling that the user caret has exited formatted text.
@@ -1086,7 +1086,7 @@ _Returns_
- `Object`: Action object.
-# **flashBlock**
+### flashBlock
Yields action objects used in signalling that the block corresponding to the
given clientId should appear to "flash" by rhythmically highlighting it.
@@ -1095,7 +1095,7 @@ _Parameters_
- _clientId_ `string`: Target block client ID.
-# **hideInsertionPoint**
+### hideInsertionPoint
Returns an action object hiding the insertion point.
@@ -1103,7 +1103,7 @@ _Returns_
- `Object`: Action object.
-# **insertAfterBlock**
+### insertAfterBlock
Generator used to insert an empty block before a given block.
@@ -1111,7 +1111,7 @@ _Parameters_
- _clientId_ `string`:
-# **insertBeforeBlock**
+### insertBeforeBlock
Generator used to insert an empty block after a given block.
@@ -1119,7 +1119,7 @@ _Parameters_
- _clientId_ `string`:
-# **insertBlock**
+### insertBlock
Returns an action object used in signalling that a single block should be
inserted, optionally at a specific index respective a root block list.
@@ -1136,7 +1136,7 @@ _Returns_
- `Object`: Action object.
-# **insertBlocks**
+### insertBlocks
Returns an action object used in signalling that an array of blocks should
be inserted, optionally at a specific index respective a root block list.
@@ -1154,7 +1154,7 @@ _Returns_
- `Object`: Action object.
-# **insertDefaultBlock**
+### insertDefaultBlock
Returns an action object used in signalling that a new block of the default
type should be added to the block list.
@@ -1169,7 +1169,7 @@ _Returns_
- `Object`: Action object
-# **mergeBlocks**
+### mergeBlocks
Returns an action object used in signalling that two blocks should be merged
@@ -1178,11 +1178,11 @@ _Parameters_
- _firstBlockClientId_ `string`: Client ID of the first block to merge.
- _secondBlockClientId_ `string`: Client ID of the second block to merge.
-# **moveBlocksDown**
+### moveBlocksDown
Undocumented declaration.
-# **moveBlocksToPosition**
+### moveBlocksToPosition
Returns an action object signalling that the given blocks should be moved to
a new position.
@@ -1194,11 +1194,11 @@ _Parameters_
- _toRootClientId_ `?string`: Root client ID destination.
- _index_ `number`: The index to move the blocks to.
-# **moveBlocksUp**
+### moveBlocksUp
Undocumented declaration.
-# **moveBlockToPosition**
+### moveBlockToPosition
Returns an action object signalling that the given block should be moved to a
new position.
@@ -1210,7 +1210,7 @@ _Parameters_
- _toRootClientId_ `?string`: Root client ID destination.
- _index_ `number`: The index to move the block to.
-# **multiSelect**
+### multiSelect
Returns an action object used in signalling that block multi-selection changed.
@@ -1219,7 +1219,7 @@ _Parameters_
- _start_ `string`: First block of the multi selection.
- _end_ `string`: Last block of the multiselection.
-# **receiveBlocks**
+### receiveBlocks
Returns an action object used in signalling that blocks have been received.
Unlike resetBlocks, these should be appended to the existing known set, not
@@ -1233,7 +1233,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlock**
+### removeBlock
Returns an action object used in signalling that the block with the
specified client ID is to be removed.
@@ -1247,7 +1247,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlocks**
+### removeBlocks
Yields action objects used in signalling that the blocks corresponding to
the set of specified client IDs are to be removed.
@@ -1257,7 +1257,7 @@ _Parameters_
- _clientIds_ `string|string[]`: Client IDs of blocks to remove.
- _selectPrevious_ `boolean`: True if the previous block should be selected when a block is removed.
-# **replaceBlock**
+### replaceBlock
Returns an action object signalling that a single block should be replaced
with one or more replacement blocks.
@@ -1271,7 +1271,7 @@ _Returns_
- `Object`: Action object.
-# **replaceBlocks**
+### replaceBlocks
Returns an action object signalling that a blocks should be replaced with
one or more replacement blocks.
@@ -1284,7 +1284,7 @@ _Parameters_
- _initialPosition_ `0|-1|null`: Index of caret after in the selected block after the operation.
- _meta_ `?Object`: Optional Meta values to be passed to the action object.
-# **replaceInnerBlocks**
+### replaceInnerBlocks
Returns an action object used in signalling that the inner blocks with the
specified client ID should be replaced.
@@ -1300,7 +1300,7 @@ _Returns_
- `Object`: Action object.
-# **resetBlocks**
+### resetBlocks
Returns an action object used in signalling that blocks state should be
reset to the specified array of blocks, taking precedence over any other
@@ -1310,7 +1310,7 @@ _Parameters_
- _blocks_ `Array`: Array of blocks.
-# **resetSelection**
+### resetSelection
Returns an action object used in signalling that selection state should be
reset to the specified selection.
@@ -1325,7 +1325,7 @@ _Returns_
- `Object`: Action object.
-# **selectBlock**
+### selectBlock
Returns an action object used in signalling that the block with the
specified client ID has been selected, optionally accepting a position
@@ -1341,7 +1341,7 @@ _Returns_
- `Object`: Action object.
-# **selectionChange**
+### selectionChange
Returns an action object used in signalling that the user caret has changed
position.
@@ -1357,7 +1357,7 @@ _Returns_
- `Object`: Action object.
-# **selectNextBlock**
+### selectNextBlock
Yields action objects used in signalling that the block following the given
clientId should be selected.
@@ -1366,7 +1366,7 @@ _Parameters_
- _clientId_ `string`: Block client ID.
-# **selectPreviousBlock**
+### selectPreviousBlock
Yields action objects used in signalling that the block preceding the given
clientId should be selected.
@@ -1375,7 +1375,7 @@ _Parameters_
- _clientId_ `string`: Block client ID.
-# **setBlockMovingClientId**
+### setBlockMovingClientId
Generator that triggers an action used to enable or disable the block moving mode.
@@ -1383,7 +1383,7 @@ _Parameters_
- _hasBlockMovingClientId_ `string|null`: Enable/Disable block moving mode.
-# **setHasControlledInnerBlocks**
+### setHasControlledInnerBlocks
Returns an action object that sets whether the block has controlled innerblocks.
@@ -1392,7 +1392,7 @@ _Parameters_
- _clientId_ `string`: The block's clientId.
- _hasControlledInnerBlocks_ `boolean`: True if the block's inner blocks are controlled.
-# **setNavigationMode**
+### setNavigationMode
Generators that triggers an action used to enable or disable the navigation mode.
@@ -1400,7 +1400,7 @@ _Parameters_
- _isNavigationMode_ `string`: Enable/Disable navigation mode.
-# **setTemplateValidity**
+### setTemplateValidity
Returns an action object resetting the template validity.
@@ -1412,7 +1412,7 @@ _Returns_
- `Object`: Action object.
-# **showInsertionPoint**
+### showInsertionPoint
Returns an action object used in signalling that the insertion point should
be shown.
@@ -1427,7 +1427,7 @@ _Returns_
- `Object`: Action object.
-# **startDraggingBlocks**
+### startDraggingBlocks
Returns an action object used in signalling that the user has begun to drag blocks.
@@ -1439,7 +1439,7 @@ _Returns_
- `Object`: Action object.
-# **startMultiSelect**
+### startMultiSelect
Returns an action object used in signalling that a block multi-selection has started.
@@ -1447,7 +1447,7 @@ _Returns_
- `Object`: Action object.
-# **startTyping**
+### startTyping
Returns an action object used in signalling that the user has begun to type.
@@ -1455,7 +1455,7 @@ _Returns_
- `Object`: Action object.
-# **stopDraggingBlocks**
+### stopDraggingBlocks
Returns an action object used in signalling that the user has stopped dragging blocks.
@@ -1463,7 +1463,7 @@ _Returns_
- `Object`: Action object.
-# **stopMultiSelect**
+### stopMultiSelect
Returns an action object used in signalling that block multi-selection stopped.
@@ -1471,7 +1471,7 @@ _Returns_
- `Object`: Action object.
-# **stopTyping**
+### stopTyping
Returns an action object used in signalling that the user has stopped typing.
@@ -1479,7 +1479,7 @@ _Returns_
- `Object`: Action object.
-# **synchronizeTemplate**
+### synchronizeTemplate
Returns an action object synchronize the template with the list of blocks
@@ -1487,7 +1487,7 @@ _Returns_
- `Object`: Action object.
-# **toggleBlockHighlight**
+### toggleBlockHighlight
Returns an action object that toggles the highlighted block state.
@@ -1496,7 +1496,7 @@ _Parameters_
- _clientId_ `string`: The block's clientId.
- _isHighlighted_ `boolean`: The highlight state.
-# **toggleBlockMode**
+### toggleBlockMode
Returns an action object used to toggle the block editing mode between
visual and HTML modes.
@@ -1509,7 +1509,7 @@ _Returns_
- `Object`: Action object.
-# **toggleSelection**
+### toggleSelection
Returns an action object that enables or disables block selection.
@@ -1521,7 +1521,7 @@ _Returns_
- `Object`: Action object.
-# **updateBlock**
+### updateBlock
Returns an action object used in signalling that the block with the
specified client ID has been updated.
@@ -1535,7 +1535,7 @@ _Returns_
- `Object`: Action object.
-# **updateBlockAttributes**
+### updateBlockAttributes
Returns an action object used in signalling that the multiple blocks'
attributes with the specified client IDs have been updated.
@@ -1550,7 +1550,7 @@ _Returns_
- `Object`: Action object.
-# **updateBlockListSettings**
+### updateBlockListSettings
Returns an action object that changes the nested settings of a given block.
@@ -1563,7 +1563,7 @@ _Returns_
- `Object`: Action object
-# **updateSettings**
+### updateSettings
Returns an action object used in signalling that the block editor settings have been updated.
@@ -1575,7 +1575,7 @@ _Returns_
- `Object`: Action object
-# **validateBlocksToTemplate**
+### validateBlocksToTemplate
Block validity is a function of blocks state (at the point of a
reset) and the template setting. As a compromise to its placement
diff --git a/docs/reference-guides/data/data-core-blocks.md b/docs/reference-guides/data/data-core-blocks.md
index 4aa8f73009e90..4d78203d38465 100644
--- a/docs/reference-guides/data/data-core-blocks.md
+++ b/docs/reference-guides/data/data-core-blocks.md
@@ -6,7 +6,7 @@ Namespace: `core/blocks`.
-# **getActiveBlockVariation**
+### getActiveBlockVariation
Returns the active block variation for a given block based on its attributes.
Variations are determined by their `isActive` property.
@@ -30,7 +30,7 @@ _Returns_
- `(WPBlockVariation|undefined)`: Active block variation.
-# **getBlockStyles**
+### getBlockStyles
Returns block styles by block name.
@@ -43,7 +43,7 @@ _Returns_
- `Array?`: Block Styles.
-# **getBlockSupport**
+### getBlockSupport
Returns the block support value for a feature, if defined.
@@ -58,7 +58,7 @@ _Returns_
- `?*`: Block support value
-# **getBlockType**
+### getBlockType
Returns a block type by name.
@@ -71,7 +71,7 @@ _Returns_
- `Object?`: Block Type.
-# **getBlockTypes**
+### getBlockTypes
Returns all the available block types.
@@ -83,7 +83,7 @@ _Returns_
- `Array`: Block Types.
-# **getBlockVariations**
+### getBlockVariations
Returns block variations by block name.
@@ -97,7 +97,7 @@ _Returns_
- `(WPBlockVariation[]|void)`: Block variations.
-# **getCategories**
+### getCategories
Returns all the available categories.
@@ -109,7 +109,7 @@ _Returns_
- `WPBlockCategory[]`: Categories list.
-# **getChildBlockNames**
+### getChildBlockNames
Returns an array with the child blocks of a given block.
@@ -122,7 +122,7 @@ _Returns_
- `Array`: Array of child block names.
-# **getCollections**
+### getCollections
Returns all the available collections.
@@ -134,7 +134,7 @@ _Returns_
- `Object`: Collections list.
-# **getDefaultBlockName**
+### getDefaultBlockName
Returns the name of the default block name.
@@ -146,7 +146,7 @@ _Returns_
- `string?`: Default block name.
-# **getDefaultBlockVariation**
+### getDefaultBlockVariation
Returns the default block variation for the given block type.
When there are multiple variations annotated as the default one,
@@ -163,7 +163,7 @@ _Returns_
- `?WPBlockVariation`: The default block variation.
-# **getFreeformFallbackBlockName**
+### getFreeformFallbackBlockName
Returns the name of the block for handling non-block content.
@@ -175,7 +175,7 @@ _Returns_
- `string?`: Name of the block for handling non-block content.
-# **getGroupingBlockName**
+### getGroupingBlockName
Returns the name of the block for handling unregistered blocks.
@@ -187,7 +187,7 @@ _Returns_
- `string?`: Name of the block for handling unregistered blocks.
-# **getUnregisteredFallbackBlockName**
+### getUnregisteredFallbackBlockName
Returns the name of the block for handling unregistered blocks.
@@ -199,7 +199,7 @@ _Returns_
- `string?`: Name of the block for handling unregistered blocks.
-# **hasBlockSupport**
+### hasBlockSupport
Returns true if the block defines support for a feature, or false otherwise.
@@ -214,7 +214,7 @@ _Returns_
- `boolean`: Whether block supports feature.
-# **hasChildBlocks**
+### hasChildBlocks
Returns a boolean indicating if a block has child blocks or not.
@@ -227,7 +227,7 @@ _Returns_
- `boolean`: True if a block contains child blocks and false otherwise.
-# **hasChildBlocksWithInserterSupport**
+### hasChildBlocksWithInserterSupport
Returns a boolean indicating if a block has at least one child block with inserter support.
@@ -240,7 +240,7 @@ _Returns_
- `boolean`: True if a block contains at least one child blocks with inserter support and false otherwise.
-# **isMatchingSearchTerm**
+### isMatchingSearchTerm
Returns true if the block type by the given name or object value matches a
search term, or false otherwise.
@@ -261,7 +261,7 @@ _Returns_
-# **addBlockCollection**
+### addBlockCollection
Returns an action object used to add block collections
@@ -275,7 +275,7 @@ _Returns_
- `Object`: Action object.
-# **addBlockStyles**
+### addBlockStyles
Returns an action object used in signalling that new block styles have been added.
@@ -288,7 +288,7 @@ _Returns_
- `Object`: Action object.
-# **addBlockTypes**
+### addBlockTypes
Returns an action object used in signalling that block types have been added.
@@ -300,7 +300,7 @@ _Returns_
- `Object`: Action object.
-# **addBlockVariations**
+### addBlockVariations
Returns an action object used in signalling that new block variations have been added.
@@ -313,7 +313,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlockCollection**
+### removeBlockCollection
Returns an action object used to remove block collections
@@ -325,7 +325,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlockStyles**
+### removeBlockStyles
Returns an action object used in signalling that block styles have been removed.
@@ -338,7 +338,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlockTypes**
+### removeBlockTypes
Returns an action object used to remove a registered block type.
@@ -350,7 +350,7 @@ _Returns_
- `Object`: Action object.
-# **removeBlockVariations**
+### removeBlockVariations
Returns an action object used in signalling that block variations have been removed.
@@ -363,7 +363,7 @@ _Returns_
- `Object`: Action object.
-# **setCategories**
+### setCategories
Returns an action object used to set block categories.
@@ -375,7 +375,7 @@ _Returns_
- `Object`: Action object.
-# **setDefaultBlockName**
+### setDefaultBlockName
Returns an action object used to set the default block name.
@@ -387,7 +387,7 @@ _Returns_
- `Object`: Action object.
-# **setFreeformFallbackBlockName**
+### setFreeformFallbackBlockName
Returns an action object used to set the name of the block used as a fallback
for non-block content.
@@ -400,7 +400,7 @@ _Returns_
- `Object`: Action object.
-# **setGroupingBlockName**
+### setGroupingBlockName
Returns an action object used to set the name of the block used
when grouping other blocks
@@ -414,7 +414,7 @@ _Returns_
- `Object`: Action object.
-# **setUnregisteredFallbackBlockName**
+### setUnregisteredFallbackBlockName
Returns an action object used to set the name of the block used as a fallback
for unregistered blocks.
@@ -427,7 +427,7 @@ _Returns_
- `Object`: Action object.
-# **updateCategory**
+### updateCategory
Returns an action object used to update a category.
diff --git a/docs/reference-guides/data/data-core-edit-post.md b/docs/reference-guides/data/data-core-edit-post.md
index 7ef45b337962b..8f150ff19b668 100644
--- a/docs/reference-guides/data/data-core-edit-post.md
+++ b/docs/reference-guides/data/data-core-edit-post.md
@@ -6,7 +6,7 @@ Namespace: `core/edit-post`.
-# **getActiveGeneralSidebarName**
+### getActiveGeneralSidebarName
Returns the current active general sidebar name, or null if there is no
general sidebar active. The active general sidebar is a unique name to
@@ -25,7 +25,7 @@ _Returns_
- `?string`: Active general sidebar name.
-# **getActiveMetaBoxLocations**
+### getActiveMetaBoxLocations
Returns an array of active meta box locations.
@@ -37,7 +37,7 @@ _Returns_
- `string[]`: Active meta box locations.
-# **getAllMetaBoxes**
+### getAllMetaBoxes
Returns the list of all the available meta boxes.
@@ -49,7 +49,7 @@ _Returns_
- `Array`: List of meta boxes.
-# **getEditedPostTemplate**
+### getEditedPostTemplate
Retrieves the template of the currently edited post.
@@ -57,7 +57,7 @@ _Returns_
- `Object?`: Post Template.
-# **getEditorMode**
+### getEditorMode
Returns the current editing mode.
@@ -69,7 +69,7 @@ _Returns_
- `string`: Editing mode.
-# **getMetaBoxesPerLocation**
+### getMetaBoxesPerLocation
Returns the list of all the available meta boxes for a given location.
@@ -82,7 +82,7 @@ _Returns_
- `?Array`: List of meta boxes.
-# **getPreference**
+### getPreference
_Parameters_
@@ -94,7 +94,7 @@ _Returns_
- `*`: Preference Value.
-# **getPreferences**
+### getPreferences
Returns the preferences (these preferences are persisted locally).
@@ -106,7 +106,7 @@ _Returns_
- `Object`: Preferences Object.
-# **hasMetaBoxes**
+### hasMetaBoxes
Returns true if the post is using Meta Boxes
@@ -118,7 +118,7 @@ _Returns_
- `boolean`: Whether there are metaboxes or not.
-# **isEditingTemplate**
+### isEditingTemplate
Returns true if the template editing mode is enabled.
@@ -130,7 +130,7 @@ _Returns_
- `boolean`: Whether we're editing the template.
-# **isEditorPanelEnabled**
+### isEditorPanelEnabled
Returns true if the given panel is enabled, or false otherwise. Panels are
enabled by default.
@@ -144,7 +144,7 @@ _Returns_
- `boolean`: Whether or not the panel is enabled.
-# **isEditorPanelOpened**
+### isEditorPanelOpened
Returns true if the given panel is open, or false otherwise. Panels are
closed by default.
@@ -158,7 +158,7 @@ _Returns_
- `boolean`: Whether or not the panel is open.
-# **isEditorPanelRemoved**
+### isEditorPanelRemoved
Returns true if the given panel was programmatically removed, or false otherwise.
All panels are not removed by default.
@@ -172,7 +172,7 @@ _Returns_
- `boolean`: Whether or not the panel is removed.
-# **isEditorSidebarOpened**
+### isEditorSidebarOpened
Returns true if the editor sidebar is opened.
@@ -184,7 +184,7 @@ _Returns_
- `boolean`: Whether the editor sidebar is opened.
-# **isFeatureActive**
+### isFeatureActive
Returns whether the given feature is enabled or not.
@@ -197,7 +197,7 @@ _Returns_
- `boolean`: Is active.
-# **isInserterOpened**
+### isInserterOpened
Returns true if the inserter is opened.
@@ -209,7 +209,7 @@ _Returns_
- `boolean`: Whether the inserter is opened.
-# **isListViewOpened**
+### isListViewOpened
Returns true if the list view is opened.
@@ -221,7 +221,7 @@ _Returns_
- `boolean`: Whether the list view is opened.
-# **isMetaBoxLocationActive**
+### isMetaBoxLocationActive
Returns true if there is an active meta box in the given location, or false
otherwise.
@@ -235,7 +235,7 @@ _Returns_
- `boolean`: Whether the meta box location is active.
-# **isMetaBoxLocationVisible**
+### isMetaBoxLocationVisible
Returns true if a metabox location is active and visible
@@ -248,7 +248,7 @@ _Returns_
- `boolean`: Whether the meta box location is active and visible.
-# **isModalActive**
+### isModalActive
Returns true if a modal is active, or false otherwise.
@@ -261,7 +261,7 @@ _Returns_
- `boolean`: Whether the modal is active.
-# **isPluginItemPinned**
+### isPluginItemPinned
Returns true if the plugin item is pinned to the header.
When the value is not set it defaults to true.
@@ -275,7 +275,7 @@ _Returns_
- `boolean`: Whether the plugin item is pinned.
-# **isPluginSidebarOpened**
+### isPluginSidebarOpened
Returns true if the plugin sidebar is opened.
@@ -287,7 +287,7 @@ _Returns_
- `boolean`: Whether the plugin sidebar is opened.
-# **isPublishSidebarOpened**
+### isPublishSidebarOpened
Returns true if the publish sidebar is opened.
@@ -299,7 +299,7 @@ _Returns_
- `boolean`: Whether the publish sidebar is open.
-# **isSavingMetaBoxes**
+### isSavingMetaBoxes
Returns true if the Meta Boxes are being saved.
@@ -317,11 +317,11 @@ _Returns_
-# **closeGeneralSidebar**
+### closeGeneralSidebar
Returns an action object signalling that the user closed the sidebar.
-# **closeModal**
+### closeModal
Returns an action object signalling that the user closed a modal.
@@ -329,7 +329,7 @@ _Returns_
- `Object`: Action object.
-# **closePublishSidebar**
+### closePublishSidebar
Returns an action object used in signalling that the user closed the
publish sidebar.
@@ -338,7 +338,7 @@ _Returns_
- `Object`: Action object.
-# **hideBlockTypes**
+### hideBlockTypes
Returns an action object used in signalling that block types by the given
name(s) should be hidden.
@@ -351,7 +351,7 @@ _Returns_
- `Object`: Action object.
-# **metaBoxUpdatesFailure**
+### metaBoxUpdatesFailure
Returns an action object used to signal a failed meta box update.
@@ -359,7 +359,7 @@ _Returns_
- `Object`: Action object.
-# **metaBoxUpdatesSuccess**
+### metaBoxUpdatesSuccess
Returns an action object used to signal a successful meta box update.
@@ -367,7 +367,7 @@ _Returns_
- `Object`: Action object.
-# **openGeneralSidebar**
+### openGeneralSidebar
Returns an action object used in signalling that the user opened an editor sidebar.
@@ -375,7 +375,7 @@ _Parameters_
- _name_ `?string`: Sidebar name to be opened.
-# **openModal**
+### openModal
Returns an action object used in signalling that the user opened a modal.
@@ -387,7 +387,7 @@ _Returns_
- `Object`: Action object.
-# **openPublishSidebar**
+### openPublishSidebar
Returns an action object used in signalling that the user opened the publish
sidebar.
@@ -396,7 +396,7 @@ _Returns_
- `Object`: Action object
-# **removeEditorPanel**
+### removeEditorPanel
Returns an action object used to remove a panel from the editor.
@@ -408,11 +408,11 @@ _Returns_
- `Object`: Action object.
-# **requestMetaBoxUpdates**
+### requestMetaBoxUpdates
Returns an action object used to request meta box update.
-# **setAvailableMetaBoxesPerLocation**
+### setAvailableMetaBoxesPerLocation
Returns an action object used in signaling
what Meta boxes are available in which location.
@@ -421,7 +421,7 @@ _Parameters_
- _metaBoxesPerLocation_ `Object`: Meta boxes per location.
-# **setIsEditingTemplate**
+### setIsEditingTemplate
Returns an action object used to switch to template editing.
@@ -433,7 +433,7 @@ _Returns_
- `Object`: Action object.
-# **setIsInserterOpened**
+### setIsInserterOpened
Returns an action object used to open/close the inserter.
@@ -447,7 +447,7 @@ _Returns_
- `Object`: Action object.
-# **setIsListViewOpened**
+### setIsListViewOpened
Returns an action object used to open/close the list view.
@@ -459,7 +459,7 @@ _Returns_
- `Object`: Action object.
-# **showBlockTypes**
+### showBlockTypes
Returns an action object used in signalling that block types by the given
name(s) should be shown.
@@ -472,11 +472,11 @@ _Returns_
- `Object`: Action object.
-# **switchEditorMode**
+### switchEditorMode
Undocumented declaration.
-# **toggleEditorPanelEnabled**
+### toggleEditorPanelEnabled
Returns an action object used to enable or disable a panel in the editor.
@@ -488,7 +488,7 @@ _Returns_
- `Object`: Action object.
-# **toggleEditorPanelOpened**
+### toggleEditorPanelOpened
Returns an action object used to open or close a panel in the editor.
@@ -500,7 +500,7 @@ _Returns_
- `Object`: Action object.
-# **toggleFeature**
+### toggleFeature
Returns an action object used to toggle a feature flag.
@@ -512,7 +512,7 @@ _Returns_
- `Object`: Action object.
-# **togglePinnedPluginItem**
+### togglePinnedPluginItem
Returns an action object used to toggle a plugin name flag.
@@ -524,7 +524,7 @@ _Returns_
- `Object`: Action object.
-# **togglePublishSidebar**
+### togglePublishSidebar
Returns an action object used in signalling that the user toggles the publish sidebar.
@@ -532,7 +532,7 @@ _Returns_
- `Object`: Action object
-# **updatePreferredStyleVariations**
+### updatePreferredStyleVariations
Returns an action object used in signaling that a style should be auto-applied when a block is created.
diff --git a/docs/reference-guides/data/data-core-editor.md b/docs/reference-guides/data/data-core-editor.md
index a3decea1e286c..027dcb4441f36 100644
--- a/docs/reference-guides/data/data-core-editor.md
+++ b/docs/reference-guides/data/data-core-editor.md
@@ -6,13 +6,13 @@ Namespace: `core/editor`.
-# **canInsertBlockType**
+### canInsertBlockType
_Related_
- canInsertBlockType in core/block-editor store.
-# **canUserUseUnfilteredHTML**
+### canUserUseUnfilteredHTML
Returns whether or not the user has the unfiltered_html capability.
@@ -24,7 +24,7 @@ _Returns_
- `boolean`: Whether the user can or can't post unfiltered HTML.
-# **didPostSaveRequestFail**
+### didPostSaveRequestFail
Returns true if a previous post save was attempted but failed, or false
otherwise.
@@ -37,7 +37,7 @@ _Returns_
- `boolean`: Whether the post save failed.
-# **didPostSaveRequestSucceed**
+### didPostSaveRequestSucceed
Returns true if a previous post save was attempted successfully, or false
otherwise.
@@ -50,7 +50,7 @@ _Returns_
- `boolean`: Whether the post was saved successfully.
-# **getActivePostLock**
+### getActivePostLock
Returns the active post lock.
@@ -62,13 +62,13 @@ _Returns_
- `Object`: The lock object.
-# **getAdjacentBlockClientId**
+### getAdjacentBlockClientId
_Related_
- getAdjacentBlockClientId in core/block-editor store.
-# **getAutosave**
+### getAutosave
> **Deprecated** since 5.6. Callers should use the `getAutosave( postType, postId, userId )` selector from the '@wordpress/core-data' package.
@@ -84,7 +84,7 @@ _Returns_
- `?Object`: Current autosave, if exists.
-# **getAutosaveAttribute**
+### getAutosaveAttribute
> **Deprecated** since 5.6. Callers should use the `getAutosave( postType, postId, userId )` selector from the '@wordpress/core-data' package and access properties on the returned autosave object using getPostRawValue.
@@ -100,97 +100,97 @@ _Returns_
- `*`: Autosave attribute value.
-# **getBlock**
+### getBlock
_Related_
- getBlock in core/block-editor store.
-# **getBlockAttributes**
+### getBlockAttributes
_Related_
- getBlockAttributes in core/block-editor store.
-# **getBlockCount**
+### getBlockCount
_Related_
- getBlockCount in core/block-editor store.
-# **getBlockHierarchyRootClientId**
+### getBlockHierarchyRootClientId
_Related_
- getBlockHierarchyRootClientId in core/block-editor store.
-# **getBlockIndex**
+### getBlockIndex
_Related_
- getBlockIndex in core/block-editor store.
-# **getBlockInsertionPoint**
+### getBlockInsertionPoint
_Related_
- getBlockInsertionPoint in core/block-editor store.
-# **getBlockListSettings**
+### getBlockListSettings
_Related_
- getBlockListSettings in core/block-editor store.
-# **getBlockMode**
+### getBlockMode
_Related_
- getBlockMode in core/block-editor store.
-# **getBlockName**
+### getBlockName
_Related_
- getBlockName in core/block-editor store.
-# **getBlockOrder**
+### getBlockOrder
_Related_
- getBlockOrder in core/block-editor store.
-# **getBlockRootClientId**
+### getBlockRootClientId
_Related_
- getBlockRootClientId in core/block-editor store.
-# **getBlocks**
+### getBlocks
_Related_
- getBlocks in core/block-editor store.
-# **getBlocksByClientId**
+### getBlocksByClientId
_Related_
- getBlocksByClientId in core/block-editor store.
-# **getBlockSelectionEnd**
+### getBlockSelectionEnd
_Related_
- getBlockSelectionEnd in core/block-editor store.
-# **getBlockSelectionStart**
+### getBlockSelectionStart
_Related_
- getBlockSelectionStart in core/block-editor store.
-# **getBlocksForSerialization**
+### getBlocksForSerialization
> **Deprecated** since Gutenberg 6.2.0.
@@ -205,19 +205,19 @@ _Returns_
- `WPBlock[]`: Filtered set of blocks for save.
-# **getClientIdsOfDescendants**
+### getClientIdsOfDescendants
_Related_
- getClientIdsOfDescendants in core/block-editor store.
-# **getClientIdsWithDescendants**
+### getClientIdsWithDescendants
_Related_
- getClientIdsWithDescendants in core/block-editor store.
-# **getCurrentPost**
+### getCurrentPost
Returns the post currently being edited in its last known saved state, not
including unsaved edits. Returns an object containing relevant default post
@@ -231,7 +231,7 @@ _Returns_
- `Object`: Post object.
-# **getCurrentPostAttribute**
+### getCurrentPostAttribute
Returns an attribute value of the saved post.
@@ -244,7 +244,7 @@ _Returns_
- `*`: Post attribute value.
-# **getCurrentPostId**
+### getCurrentPostId
Returns the ID of the post currently being edited, or null if the post has
not yet been saved.
@@ -257,7 +257,7 @@ _Returns_
- `?number`: ID of current post.
-# **getCurrentPostLastRevisionId**
+### getCurrentPostLastRevisionId
Returns the last revision ID of the post currently being edited,
or null if the post has no revisions.
@@ -270,7 +270,7 @@ _Returns_
- `?number`: ID of the last revision.
-# **getCurrentPostRevisionsCount**
+### getCurrentPostRevisionsCount
Returns the number of revisions of the post currently being edited.
@@ -282,7 +282,7 @@ _Returns_
- `number`: Number of revisions.
-# **getCurrentPostType**
+### getCurrentPostType
Returns the post type of the post currently being edited.
@@ -294,7 +294,7 @@ _Returns_
- `string`: Post type.
-# **getEditedPostAttribute**
+### getEditedPostAttribute
Returns a single attribute of the post being edited, preferring the unsaved
edit if one exists, but falling back to the attribute for the last known
@@ -309,7 +309,7 @@ _Returns_
- `*`: Post attribute value.
-# **getEditedPostContent**
+### getEditedPostContent
Returns the content of the post being edited.
@@ -321,7 +321,7 @@ _Returns_
- `string`: Post content.
-# **getEditedPostPreviewLink**
+### getEditedPostPreviewLink
Returns the post preview link
@@ -333,7 +333,7 @@ _Returns_
- `string?`: Preview Link.
-# **getEditedPostSlug**
+### getEditedPostSlug
Returns the slug for the post being edited, preferring a manually edited
value if one exists, then a sanitized version of the current post title, and
@@ -347,7 +347,7 @@ _Returns_
- `string`: The current slug to be displayed in the editor
-# **getEditedPostVisibility**
+### getEditedPostVisibility
Returns the current visibility of the post being edited, preferring the
unsaved value if different than the saved post. The return value is one of
@@ -361,7 +361,7 @@ _Returns_
- `string`: Post visibility.
-# **getEditorBlocks**
+### getEditorBlocks
Return the current block list.
@@ -373,7 +373,7 @@ _Returns_
- `Array`: Block list.
-# **getEditorSelection**
+### getEditorSelection
Returns the current selection.
@@ -385,7 +385,7 @@ _Returns_
- `WPBlockSelection`: The selection end.
-# **getEditorSelectionEnd**
+### getEditorSelectionEnd
> **Deprecated** since Gutenberg 10.0.0.
@@ -399,7 +399,7 @@ _Returns_
- `WPBlockSelection`: The selection end.
-# **getEditorSelectionStart**
+### getEditorSelectionStart
> **Deprecated** since Gutenberg 10.0.0.
@@ -413,7 +413,7 @@ _Returns_
- `WPBlockSelection`: The selection start.
-# **getEditorSettings**
+### getEditorSettings
Returns the post editor settings.
@@ -425,61 +425,61 @@ _Returns_
- `Object`: The editor settings object.
-# **getFirstMultiSelectedBlockClientId**
+### getFirstMultiSelectedBlockClientId
_Related_
- getFirstMultiSelectedBlockClientId in core/block-editor store.
-# **getGlobalBlockCount**
+### getGlobalBlockCount
_Related_
- getGlobalBlockCount in core/block-editor store.
-# **getInserterItems**
+### getInserterItems
_Related_
- getInserterItems in core/block-editor store.
-# **getLastMultiSelectedBlockClientId**
+### getLastMultiSelectedBlockClientId
_Related_
- getLastMultiSelectedBlockClientId in core/block-editor store.
-# **getMultiSelectedBlockClientIds**
+### getMultiSelectedBlockClientIds
_Related_
- getMultiSelectedBlockClientIds in core/block-editor store.
-# **getMultiSelectedBlocks**
+### getMultiSelectedBlocks
_Related_
- getMultiSelectedBlocks in core/block-editor store.
-# **getMultiSelectedBlocksEndClientId**
+### getMultiSelectedBlocksEndClientId
_Related_
- getMultiSelectedBlocksEndClientId in core/block-editor store.
-# **getMultiSelectedBlocksStartClientId**
+### getMultiSelectedBlocksStartClientId
_Related_
- getMultiSelectedBlocksStartClientId in core/block-editor store.
-# **getNextBlockClientId**
+### getNextBlockClientId
_Related_
- getNextBlockClientId in core/block-editor store.
-# **getPermalink**
+### getPermalink
Returns the permalink for the post.
@@ -491,7 +491,7 @@ _Returns_
- `?string`: The permalink, or null if the post is not viewable.
-# **getPermalinkParts**
+### getPermalinkParts
Returns the permalink for a post, split into it's three parts: the prefix,
the postName, and the suffix.
@@ -504,7 +504,7 @@ _Returns_
- `Object`: An object containing the prefix, postName, and suffix for the permalink, or null if the post is not viewable.
-# **getPostEdits**
+### getPostEdits
Returns any post values which have been changed in the editor but not yet
been saved.
@@ -517,7 +517,7 @@ _Returns_
- `Object`: Object of key value pairs comprising unsaved edits.
-# **getPostLockUser**
+### getPostLockUser
Returns details about the post lock user.
@@ -529,7 +529,7 @@ _Returns_
- `Object`: A user object.
-# **getPostTypeLabel**
+### getPostTypeLabel
Returns a post type label depending on the current post.
@@ -541,13 +541,13 @@ _Returns_
- `string|undefined`: The post type label if available, otherwise undefined.
-# **getPreviousBlockClientId**
+### getPreviousBlockClientId
_Related_
- getPreviousBlockClientId in core/block-editor store.
-# **getReferenceByDistinctEdits**
+### getReferenceByDistinctEdits
> **Deprecated** since Gutenberg 6.5.0.
@@ -570,38 +570,38 @@ _Returns_
- `*`: A value whose reference will change only when an edit occurs.
-# **getSelectedBlock**
+### getSelectedBlock
_Related_
- getSelectedBlock in core/block-editor store.
-# **getSelectedBlockClientId**
+### getSelectedBlockClientId
_Related_
- getSelectedBlockClientId in core/block-editor store.
-# **getSelectedBlockCount**
+### getSelectedBlockCount
_Related_
- getSelectedBlockCount in core/block-editor store.
-# **getSelectedBlocksInitialCaretPosition**
+### getSelectedBlocksInitialCaretPosition
_Related_
- getSelectedBlocksInitialCaretPosition in core/block-editor store.
-# **getStateBeforeOptimisticTransaction**
+### getStateBeforeOptimisticTransaction
> **Deprecated** since Gutenberg 9.7.0.
Returns state object prior to a specified optimist transaction ID, or `null`
if the transaction corresponding to the given ID cannot be found.
-# **getSuggestedPostFormat**
+### getSuggestedPostFormat
Returns a suggested post format for the current post, inferred only if there
is a single block within the post and it is of a type known to match a
@@ -615,19 +615,19 @@ _Returns_
- `?string`: Suggested post format.
-# **getTemplate**
+### getTemplate
_Related_
- getTemplate in core/block-editor store.
-# **getTemplateLock**
+### getTemplateLock
_Related_
- getTemplateLock in core/block-editor store.
-# **hasAutosave**
+### hasAutosave
> **Deprecated** since 5.6. Callers should use the `getAutosave( postType, postId, userId )` selector from the '@wordpress/core-data' package and check for a truthy value.
@@ -641,7 +641,7 @@ _Returns_
- `boolean`: Whether there is an existing autosave.
-# **hasChangedContent**
+### hasChangedContent
Returns true if content includes unsaved changes, or false otherwise.
@@ -653,7 +653,7 @@ _Returns_
- `boolean`: Whether content includes unsaved changes.
-# **hasEditorRedo**
+### hasEditorRedo
Returns true if any future editor history snapshots exist, or false
otherwise.
@@ -666,7 +666,7 @@ _Returns_
- `boolean`: Whether redo history exists.
-# **hasEditorUndo**
+### hasEditorUndo
Returns true if any past editor history snapshots exist, or false otherwise.
@@ -678,19 +678,19 @@ _Returns_
- `boolean`: Whether undo history exists.
-# **hasInserterItems**
+### hasInserterItems
_Related_
- hasInserterItems in core/block-editor store.
-# **hasMultiSelection**
+### hasMultiSelection
_Related_
- hasMultiSelection in core/block-editor store.
-# **hasNonPostEntityChanges**
+### hasNonPostEntityChanges
Returns true if there are unsaved edits for entities other than
the editor's post, and false otherwise.
@@ -703,32 +703,32 @@ _Returns_
- `boolean`: Whether there are edits or not.
-# **hasSelectedBlock**
+### hasSelectedBlock
_Related_
- hasSelectedBlock in core/block-editor store.
-# **hasSelectedInnerBlock**
+### hasSelectedInnerBlock
_Related_
- hasSelectedInnerBlock in core/block-editor store.
-# **inSomeHistory**
+### inSomeHistory
> **Deprecated** since Gutenberg 9.7.0.
Returns true if an optimistic transaction is pending commit, for which the
before state satisfies the given predicate function.
-# **isAncestorMultiSelected**
+### isAncestorMultiSelected
_Related_
- isAncestorMultiSelected in core/block-editor store.
-# **isAutosavingPost**
+### isAutosavingPost
Returns true if the post is autosaving, or false otherwise.
@@ -740,43 +740,43 @@ _Returns_
- `boolean`: Whether the post is autosaving.
-# **isBlockInsertionPointVisible**
+### isBlockInsertionPointVisible
_Related_
- isBlockInsertionPointVisible in core/block-editor store.
-# **isBlockMultiSelected**
+### isBlockMultiSelected
_Related_
- isBlockMultiSelected in core/block-editor store.
-# **isBlockSelected**
+### isBlockSelected
_Related_
- isBlockSelected in core/block-editor store.
-# **isBlockValid**
+### isBlockValid
_Related_
- isBlockValid in core/block-editor store.
-# **isBlockWithinSelection**
+### isBlockWithinSelection
_Related_
- isBlockWithinSelection in core/block-editor store.
-# **isCaretWithinFormattedText**
+### isCaretWithinFormattedText
_Related_
- isCaretWithinFormattedText in core/block-editor store.
-# **isCleanNewPost**
+### isCleanNewPost
Returns true if there are no unsaved values for the current edit session and
if the currently edited post is new (has never been saved before).
@@ -789,7 +789,7 @@ _Returns_
- `boolean`: Whether new post and unsaved values exist.
-# **isCurrentPostPending**
+### isCurrentPostPending
Returns true if post is pending review.
@@ -801,7 +801,7 @@ _Returns_
- `boolean`: Whether current post is pending review.
-# **isCurrentPostPublished**
+### isCurrentPostPublished
Return true if the current post has already been published.
@@ -814,7 +814,7 @@ _Returns_
- `boolean`: Whether the post has been published.
-# **isCurrentPostScheduled**
+### isCurrentPostScheduled
Returns true if post is already scheduled.
@@ -826,7 +826,7 @@ _Returns_
- `boolean`: Whether current post is scheduled to be posted.
-# **isEditedPostAutosaveable**
+### isEditedPostAutosaveable
Returns true if the post can be autosaved, or false otherwise.
@@ -839,7 +839,7 @@ _Returns_
- `boolean`: Whether the post can be autosaved.
-# **isEditedPostBeingScheduled**
+### isEditedPostBeingScheduled
Return true if the post being edited is being scheduled. Preferring the
unsaved status values.
@@ -852,7 +852,7 @@ _Returns_
- `boolean`: Whether the post has been published.
-# **isEditedPostDateFloating**
+### isEditedPostDateFloating
Returns whether the current post should be considered to have a "floating"
date (i.e. that it would publish "Immediately" rather than at a set time).
@@ -870,7 +870,7 @@ _Returns_
- `boolean`: Whether the edited post has a floating date value.
-# **isEditedPostDirty**
+### isEditedPostDirty
Returns true if there are unsaved values for the current edit session, or
false if the editing state matches the saved or new post.
@@ -883,7 +883,7 @@ _Returns_
- `boolean`: Whether unsaved values exist.
-# **isEditedPostEmpty**
+### isEditedPostEmpty
Returns true if the edited post has content. A post has content if it has at
least one saveable block or otherwise has a non-empty content property
@@ -897,7 +897,7 @@ _Returns_
- `boolean`: Whether post has content.
-# **isEditedPostNew**
+### isEditedPostNew
Returns true if the currently edited post is yet to be saved, or false if
the post has been saved.
@@ -910,7 +910,7 @@ _Returns_
- `boolean`: Whether the post is new.
-# **isEditedPostPublishable**
+### isEditedPostPublishable
Return true if the post being edited can be published.
@@ -922,7 +922,7 @@ _Returns_
- `boolean`: Whether the post can been published.
-# **isEditedPostSaveable**
+### isEditedPostSaveable
Returns true if the post can be saved, or false otherwise. A post must
contain a title, an excerpt, or non-empty content to be valid for save.
@@ -935,19 +935,19 @@ _Returns_
- `boolean`: Whether the post can be saved.
-# **isFirstMultiSelectedBlock**
+### isFirstMultiSelectedBlock
_Related_
- isFirstMultiSelectedBlock in core/block-editor store.
-# **isMultiSelecting**
+### isMultiSelecting
_Related_
- isMultiSelecting in core/block-editor store.
-# **isPermalinkEditable**
+### isPermalinkEditable
Returns whether the permalink is editable or not.
@@ -959,7 +959,7 @@ _Returns_
- `boolean`: Whether or not the permalink is editable.
-# **isPostAutosavingLocked**
+### isPostAutosavingLocked
Returns whether post autosaving is locked.
@@ -971,7 +971,7 @@ _Returns_
- `boolean`: Is locked.
-# **isPostLocked**
+### isPostLocked
Returns whether the post is locked.
@@ -983,7 +983,7 @@ _Returns_
- `boolean`: Is locked.
-# **isPostLockTakeover**
+### isPostLockTakeover
Returns whether the edition of the post has been taken over.
@@ -995,7 +995,7 @@ _Returns_
- `boolean`: Is post lock takeover.
-# **isPostSavingLocked**
+### isPostSavingLocked
Returns whether post saving is locked.
@@ -1007,7 +1007,7 @@ _Returns_
- `boolean`: Is locked.
-# **isPreviewingPost**
+### isPreviewingPost
Returns true if the post is being previewed, or false otherwise.
@@ -1019,7 +1019,7 @@ _Returns_
- `boolean`: Whether the post is being previewed.
-# **isPublishingPost**
+### isPublishingPost
Returns true if the post is being published, or false otherwise.
@@ -1031,7 +1031,7 @@ _Returns_
- `boolean`: Whether post is being published.
-# **isPublishSidebarEnabled**
+### isPublishSidebarEnabled
Returns whether the pre-publish panel should be shown
or skipped when the user clicks the "publish" button.
@@ -1044,7 +1044,7 @@ _Returns_
- `boolean`: Whether the pre-publish panel should be shown or not.
-# **isSavingNonPostEntityChanges**
+### isSavingNonPostEntityChanges
Returns true if non-post entities are currently being saved, or false otherwise.
@@ -1056,7 +1056,7 @@ _Returns_
- `boolean`: Whether non-post entities are being saved.
-# **isSavingPost**
+### isSavingPost
Returns true if the post is currently being saved, or false otherwise.
@@ -1068,19 +1068,19 @@ _Returns_
- `boolean`: Whether post is being saved.
-# **isSelectionEnabled**
+### isSelectionEnabled
_Related_
- isSelectionEnabled in core/block-editor store.
-# **isTyping**
+### isTyping
_Related_
- isTyping in core/block-editor store.
-# **isValidTemplate**
+### isValidTemplate
_Related_
@@ -1092,7 +1092,7 @@ _Related_
-# **autosave**
+### autosave
Action generator used in signalling that the post should autosave. This
includes server-side autosaving (default) and client-side (a.k.a. local)
@@ -1103,13 +1103,13 @@ _Parameters_
- _options_ `Object?`: Extra flags to identify the autosave.
-# **clearSelectedBlock**
+### clearSelectedBlock
_Related_
- clearSelectedBlock in core/block-editor store.
-# **createUndoLevel**
+### createUndoLevel
Returns an action object used in signalling that undo history record should
be created.
@@ -1118,7 +1118,7 @@ _Returns_
- `Object`: Action object.
-# **disablePublishSidebar**
+### disablePublishSidebar
Returns an action object used in signalling that the user has disabled the
publish sidebar.
@@ -1127,7 +1127,7 @@ _Returns_
- `Object`: Action object
-# **editPost**
+### editPost
Returns an action object used in signalling that attributes of the post have
been edited.
@@ -1137,7 +1137,7 @@ _Parameters_
- _edits_ `Object`: Post attributes to edit.
- _options_ `Object`: Options for the edit.
-# **enablePublishSidebar**
+### enablePublishSidebar
Returns an action object used in signalling that the user has enabled the
publish sidebar.
@@ -1146,43 +1146,43 @@ _Returns_
- `Object`: Action object
-# **enterFormattedText**
+### enterFormattedText
_Related_
- enterFormattedText in core/block-editor store.
-# **exitFormattedText**
+### exitFormattedText
_Related_
- exitFormattedText in core/block-editor store.
-# **hideInsertionPoint**
+### hideInsertionPoint
_Related_
- hideInsertionPoint in core/block-editor store.
-# **insertBlock**
+### insertBlock
_Related_
- insertBlock in core/block-editor store.
-# **insertBlocks**
+### insertBlocks
_Related_
- insertBlocks in core/block-editor store.
-# **insertDefaultBlock**
+### insertDefaultBlock
_Related_
- insertDefaultBlock in core/block-editor store.
-# **lockPostAutosaving**
+### lockPostAutosaving
Returns an action object used to signal that post autosaving is locked.
@@ -1199,7 +1199,7 @@ _Returns_
- `Object`: Action object
-# **lockPostSaving**
+### lockPostSaving
Returns an action object used to signal that post saving is locked.
@@ -1246,76 +1246,76 @@ _Returns_
- `Object`: Action object
-# **mergeBlocks**
+### mergeBlocks
_Related_
- mergeBlocks in core/block-editor store.
-# **moveBlocksDown**
+### moveBlocksDown
_Related_
- moveBlocksDown in core/block-editor store.
-# **moveBlocksUp**
+### moveBlocksUp
_Related_
- moveBlocksUp in core/block-editor store.
-# **moveBlockToPosition**
+### moveBlockToPosition
_Related_
- moveBlockToPosition in core/block-editor store.
-# **multiSelect**
+### multiSelect
_Related_
- multiSelect in core/block-editor store.
-# **receiveBlocks**
+### receiveBlocks
_Related_
- receiveBlocks in core/block-editor store.
-# **redo**
+### redo
Returns an action object used in signalling that undo history should
restore last popped state.
-# **refreshPost**
+### refreshPost
Action generator for handling refreshing the current post.
-# **removeBlock**
+### removeBlock
_Related_
- removeBlock in core/block-editor store.
-# **removeBlocks**
+### removeBlocks
_Related_
- removeBlocks in core/block-editor store.
-# **replaceBlock**
+### replaceBlock
_Related_
- replaceBlock in core/block-editor store.
-# **replaceBlocks**
+### replaceBlocks
_Related_
- replaceBlocks in core/block-editor store.
-# **resetAutosave**
+### resetAutosave
> **Deprecated** since 5.6. Callers should use the `receiveAutosaves( postId, autosave )` selector from the '@wordpress/core-data' package.
@@ -1330,13 +1330,13 @@ _Returns_
- `Object`: Action object.
-# **resetBlocks**
+### resetBlocks
_Related_
- resetBlocks in core/block-editor store.
-# **resetEditorBlocks**
+### resetEditorBlocks
Returns an action object used to signal that the blocks have been updated.
@@ -1345,7 +1345,7 @@ _Parameters_
- _blocks_ `Array`: Block Array.
- _options_ `?Object`: Optional options.
-# **resetPost**
+### resetPost
Returns an action object used in signalling that the latest version of the
post has been received, either by initialization or save.
@@ -1358,7 +1358,7 @@ _Returns_
- `Object`: Action object.
-# **savePost**
+### savePost
Action generator for saving the current post in the editor.
@@ -1366,19 +1366,19 @@ _Parameters_
- _options_ `Object`:
-# **selectBlock**
+### selectBlock
_Related_
- selectBlock in core/block-editor store.
-# **setTemplateValidity**
+### setTemplateValidity
_Related_
- setTemplateValidity in core/block-editor store.
-# **setupEditor**
+### setupEditor
Returns an action generator used in signalling that editor has initialized with
the specified post object and editor settings.
@@ -1389,7 +1389,7 @@ _Parameters_
- _edits_ `Object`: Initial edited attributes object.
- _template_ `Array?`: Block Template.
-# **setupEditorState**
+### setupEditorState
Returns an action object used to setup the editor state when first opening
an editor.
@@ -1402,63 +1402,63 @@ _Returns_
- `Object`: Action object.
-# **showInsertionPoint**
+### showInsertionPoint
_Related_
- showInsertionPoint in core/block-editor store.
-# **startMultiSelect**
+### startMultiSelect
_Related_
- startMultiSelect in core/block-editor store.
-# **startTyping**
+### startTyping
_Related_
- startTyping in core/block-editor store.
-# **stopMultiSelect**
+### stopMultiSelect
_Related_
- stopMultiSelect in core/block-editor store.
-# **stopTyping**
+### stopTyping
_Related_
- stopTyping in core/block-editor store.
-# **synchronizeTemplate**
+### synchronizeTemplate
_Related_
- synchronizeTemplate in core/block-editor store.
-# **toggleBlockMode**
+### toggleBlockMode
_Related_
- toggleBlockMode in core/block-editor store.
-# **toggleSelection**
+### toggleSelection
_Related_
- toggleSelection in core/block-editor store.
-# **trashPost**
+### trashPost
Action generator for trashing the current post in the editor.
-# **undo**
+### undo
Returns an action object used in signalling that undo history should pop.
-# **unlockPostAutosaving**
+### unlockPostAutosaving
Returns an action object used to signal that post autosaving is unlocked.
@@ -1475,7 +1475,7 @@ _Returns_
- `Object`: Action object
-# **unlockPostSaving**
+### unlockPostSaving
Returns an action object used to signal that post saving is unlocked.
@@ -1492,29 +1492,29 @@ _Returns_
- `Object`: Action object
-# **updateBlock**
+### updateBlock
_Related_
- updateBlock in core/block-editor store.
-# **updateBlockAttributes**
+### updateBlockAttributes
_Related_
- updateBlockAttributes in core/block-editor store.
-# **updateBlockListSettings**
+### updateBlockListSettings
_Related_
- updateBlockListSettings in core/block-editor store.
-# **updateEditorSettings**
+### updateEditorSettings
Undocumented declaration.
-# **updatePost**
+### updatePost
> **Deprecated** since Gutenberg 9.7.0.
@@ -1525,7 +1525,7 @@ _Returns_
- `Object`: Action object.
-# **updatePostLock**
+### updatePostLock
Returns an action object used to lock the editor.
diff --git a/docs/reference-guides/data/data-core-keyboard-shortcuts.md b/docs/reference-guides/data/data-core-keyboard-shortcuts.md
index d19af87e9f71b..fe8a0c9b1e4bb 100644
--- a/docs/reference-guides/data/data-core-keyboard-shortcuts.md
+++ b/docs/reference-guides/data/data-core-keyboard-shortcuts.md
@@ -6,11 +6,11 @@ Namespace: `core/keyboard-shortcuts`.
-# **getAllShortcutKeyCombinations**
+### getAllShortcutKeyCombinations
Undocumented declaration.
-# **getAllShortcutRawKeyCombinations**
+### getAllShortcutRawKeyCombinations
Returns the raw representation of all the keyboard combinations of a given shortcut name.
@@ -23,7 +23,7 @@ _Returns_
- `string[]`: Shortcuts.
-# **getCategoryShortcuts**
+### getCategoryShortcuts
Returns the shortcut names list for a given category name.
@@ -36,7 +36,7 @@ _Returns_
- `string[]`: Shortcut names.
-# **getShortcutAliases**
+### getShortcutAliases
Returns the aliases for a given shortcut name.
@@ -49,7 +49,7 @@ _Returns_
- `WPShortcutKeyCombination[]`: Key combinations.
-# **getShortcutDescription**
+### getShortcutDescription
Returns the shortcut description given its name.
@@ -62,7 +62,7 @@ _Returns_
- `string?`: Shortcut description.
-# **getShortcutKeyCombination**
+### getShortcutKeyCombination
Returns the main key combination for a given shortcut name.
@@ -75,7 +75,7 @@ _Returns_
- `WPShortcutKeyCombination?`: Key combination.
-# **getShortcutRepresentation**
+### getShortcutRepresentation
Returns a string representing the main key combination for a given shortcut name.
@@ -95,7 +95,7 @@ _Returns_
-# **registerShortcut**
+### registerShortcut
Returns an action object used to register a new keyboard shortcut.
@@ -107,7 +107,7 @@ _Returns_
- `Object`: action.
-# **unregisterShortcut**
+### unregisterShortcut
Returns an action object used to unregister a keyboard shortcut.
diff --git a/docs/reference-guides/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md
index 9f45e4d4c6153..cf24beadd251d 100644
--- a/docs/reference-guides/data/data-core-notices.md
+++ b/docs/reference-guides/data/data-core-notices.md
@@ -6,7 +6,7 @@ Namespace: `core/notices`.
-# **getNotices**
+### getNotices
Returns all notices as an array, optionally for a given context. Defaults to
the global context.
@@ -26,7 +26,7 @@ _Returns_
-# **createErrorNotice**
+### createErrorNotice
Returns an action object used in signalling that an error notice is to be
created. Refer to `createNotice` for options documentation.
@@ -44,7 +44,7 @@ _Returns_
- `Object`: Action object.
-# **createInfoNotice**
+### createInfoNotice
Returns an action object used in signalling that an info notice is to be
created. Refer to `createNotice` for options documentation.
@@ -62,7 +62,7 @@ _Returns_
- `Object`: Action object.
-# **createNotice**
+### createNotice
Returns an action object used in signalling that a notice is to be created.
@@ -85,7 +85,7 @@ _Returns_
- `Object`: Action object.
-# **createSuccessNotice**
+### createSuccessNotice
Returns an action object used in signalling that a success notice is to be
created. Refer to `createNotice` for options documentation.
@@ -103,7 +103,7 @@ _Returns_
- `Object`: Action object.
-# **createWarningNotice**
+### createWarningNotice
Returns an action object used in signalling that a warning notice is to be
created. Refer to `createNotice` for options documentation.
@@ -121,7 +121,7 @@ _Returns_
- `Object`: Action object.
-# **removeNotice**
+### removeNotice
Returns an action object used in signalling that a notice is to be removed.
diff --git a/docs/reference-guides/data/data-core-nux.md b/docs/reference-guides/data/data-core-nux.md
index 79a5bba662b4f..fb92f8840c959 100644
--- a/docs/reference-guides/data/data-core-nux.md
+++ b/docs/reference-guides/data/data-core-nux.md
@@ -6,7 +6,7 @@ Namespace: `core/nux`.
-# **areTipsEnabled**
+### areTipsEnabled
Returns whether or not tips are globally enabled.
@@ -18,7 +18,7 @@ _Returns_
- `boolean`: Whether tips are globally enabled.
-# **getAssociatedGuide**
+### getAssociatedGuide
Returns an object describing the guide, if any, that the given tip is a part
of.
@@ -32,7 +32,7 @@ _Returns_
- `?NUXGuideInfo`: Information about the associated guide.
-# **isTipVisible**
+### isTipVisible
Determines whether or not the given tip is showing. Tips are hidden if they
are disabled, have been dismissed, or are not the current tip in any
@@ -53,7 +53,7 @@ _Returns_
-# **disableTips**
+### disableTips
Returns an action object that, when dispatched, prevents all tips from
showing again.
@@ -62,7 +62,7 @@ _Returns_
- `Object`: Action object.
-# **dismissTip**
+### dismissTip
Returns an action object that, when dispatched, dismisses the given tip. A
dismissed tip will not show again.
@@ -75,7 +75,7 @@ _Returns_
- `Object`: Action object.
-# **enableTips**
+### enableTips
Returns an action object that, when dispatched, makes all tips show again.
@@ -83,7 +83,7 @@ _Returns_
- `Object`: Action object.
-# **triggerGuide**
+### triggerGuide
Returns an action object that, when dispatched, presents a guide that takes
the user through a series of tips step by step.
diff --git a/docs/reference-guides/data/data-core-viewport.md b/docs/reference-guides/data/data-core-viewport.md
index c2d77bae1ad05..045c2f85c9555 100644
--- a/docs/reference-guides/data/data-core-viewport.md
+++ b/docs/reference-guides/data/data-core-viewport.md
@@ -6,7 +6,7 @@ Namespace: `core/viewport`.
-# **isViewportMatch**
+### isViewportMatch
Returns true if the viewport matches the given query, or false otherwise.
@@ -32,7 +32,7 @@ _Returns_
-# **setIsMatching**
+### setIsMatching
Returns an action object used in signalling that viewport queries have been
updated. Values are specified as an object of breakpoint query keys where
diff --git a/docs/reference-guides/data/data-core.md b/docs/reference-guides/data/data-core.md
index acccf7e3ce954..49bc8c8adecf2 100644
--- a/docs/reference-guides/data/data-core.md
+++ b/docs/reference-guides/data/data-core.md
@@ -6,7 +6,7 @@ Namespace: `core`.
-# **canUser**
+### canUser
Returns whether the current user can perform the given action on the given
REST resource.
@@ -27,7 +27,7 @@ _Returns_
- `boolean|undefined`: Whether or not the user can perform the action, or `undefined` if the OPTIONS request is still being made.
-# **canUserEditEntityRecord**
+### canUserEditEntityRecord
Returns whether the current user can edit the given entity.
@@ -47,7 +47,7 @@ _Returns_
- `boolean|undefined`: Whether or not the user can edit, or `undefined` if the OPTIONS request is still being made.
-# **getAuthors**
+### getAuthors
Returns all available authors.
@@ -60,7 +60,7 @@ _Returns_
- `Array`: Authors list.
-# **getAutosave**
+### getAutosave
Returns the autosave for the post and author.
@@ -75,7 +75,7 @@ _Returns_
- `?Object`: The autosave for the post and author.
-# **getAutosaves**
+### getAutosaves
Returns the latest autosaves for the post.
@@ -92,7 +92,7 @@ _Returns_
- `?Array`: An array of autosaves for the post, or undefined if there is none.
-# **getCurrentTheme**
+### getCurrentTheme
Return the current theme.
@@ -104,7 +104,7 @@ _Returns_
- `Object`: The current theme.
-# **getCurrentUser**
+### getCurrentUser
Returns the current user.
@@ -116,7 +116,7 @@ _Returns_
- `Object`: Current user object.
-# **getEditedEntityRecord**
+### getEditedEntityRecord
Returns the specified entity record, merged with its edits.
@@ -131,7 +131,7 @@ _Returns_
- `Object?`: The entity record, merged with its edits.
-# **getEmbedPreview**
+### getEmbedPreview
Returns the embed preview for the given URL.
@@ -144,7 +144,7 @@ _Returns_
- `*`: Undefined if the preview has not been fetched, otherwise, the preview fetched from the embed preview API.
-# **getEntitiesByKind**
+### getEntitiesByKind
Returns whether the entities for the give kind are loaded.
@@ -157,7 +157,7 @@ _Returns_
- `Array