[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

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

(no description)

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

Defines 31 functions

  hasBlockType()
  isRequestingDownloadableBlocks()
  getDownloadableBlocks()
  getInstalledBlockTypes()
  isInstalling()
  getErrorNotices()
  getErrorNoticeForBlock()
  getPluginUrl()
  fetchDownloadableBlocks()
  receiveDownloadableBlocks()
  addInstalledBlockType()
  removeInstalledBlockType()
  setIsInstalling()
  setErrorNotice()
  clearErrorNotice()
  AutoBlockUninstaller()
  _extends()
  Icon()
  Stars()
  DownloadableBlockIcon()
  getDownloadableBlockLabel()
  DownloadableBlockListItem()
  DownloadableBlocksList()
  DownloadableBlocksInserterPanel()
  DownloadableBlocksNoResults()
  DownloadableBlocksPanel()
  getInstallableBlocks()
  InserterMenuDownloadableBlocksPanel()
  CompactList()
  InstalledBlocksPrePublishPanel()
  InstallButton()

Functions
Functions that are not part of a class:

hasBlockType(blockType)   X-Ref
No description

isRequestingDownloadableBlocks(state, filterValue)   X-Ref
Returns true if application is requesting for downloadable blocks.

return: {boolean} Whether a request is in progress for the blocks list.
param: {Object} state       Global application state.
param: {string} filterValue Search string.

getDownloadableBlocks(state, filterValue)   X-Ref
Returns the available uninstalled blocks.

return: {Array} Downloadable blocks.
param: {Object} state       Global application state.
param: {string} filterValue Search string.

getInstalledBlockTypes(state)   X-Ref
Returns the block types that have been installed on the server in this
session.

return: {Array} Block type items
param: {Object} state Global application state.

isInstalling(state, blockId)   X-Ref
Returns true if a block plugin install is in progress.

return: {boolean} Whether this block is currently being installed.
param: {Object} state   Global application state.
param: {string} blockId Id of the block.

getErrorNotices(state)   X-Ref
Returns all block error notices.

return: {Object} Object with error notices.
param: {Object} state Global application state.

getErrorNoticeForBlock(state, blockId)   X-Ref
Returns the error notice for a given block.

return: {string|boolean} The error text, or false if no error.
param: {Object} state   Global application state.
param: {string} blockId The ID of the block plugin. eg: my-block

getPluginUrl(block)   X-Ref
Get the plugin's direct API link out of a block-directory response.

return: {string} The plugin URL, if exists.
param: {Object} block The block object

fetchDownloadableBlocks(filterValue)   X-Ref
Returns an action object used in signalling that the downloadable blocks
have been requested and are loading.

return: {Object} Action object.
param: {string} filterValue Search string.

receiveDownloadableBlocks(downloadableBlocks, filterValue)   X-Ref
Returns an action object used in signalling that the downloadable blocks
have been updated.

return: {Object} Action object.
param: {Array}  downloadableBlocks Downloadable blocks.
param: {string} filterValue        Search string.

addInstalledBlockType(item)   X-Ref
Returns an action object used to add a block type to the "newly installed"
tracking list.

return: {Object} Action object.
param: {Object} item The block item with the block id and name.

removeInstalledBlockType(item)   X-Ref
Returns an action object used to remove a block type from the "newly installed"
tracking list.

return: {Object} Action object.
param: {string} item The block item with the block id and name.

setIsInstalling(blockId, isInstalling)   X-Ref
Returns an action object used to indicate install in progress.

return: {Object} Action object.
param: {string}  blockId
param: {boolean} isInstalling

setErrorNotice(blockId, message)   X-Ref
Sets an error notice to be displayed to the user for a given block.

return: {Object} Action object.
param: {string}  blockId The ID of the block plugin. eg: my-block
param: {string}  message The message shown in the notice.
param: {boolean} isFatal Whether the user can recover from the error.

clearErrorNotice(blockId)   X-Ref
Sets the error notice to empty for specific block.

return: {Object} Action object.
param: {string} blockId The ID of the block plugin. eg: my-block

AutoBlockUninstaller()   X-Ref
Internal dependencies


_extends()   X-Ref
No description

Icon(_ref)   X-Ref
Return an SVG icon.

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

Stars(_ref)   X-Ref
No description

DownloadableBlockIcon(_ref)   X-Ref
WordPress dependencies


getDownloadableBlockLabel(_ref, _ref2)   X-Ref
No description

DownloadableBlockListItem(_ref3)   X-Ref
No description

DownloadableBlocksList(_ref)   X-Ref
No description

DownloadableBlocksInserterPanel(_ref)   X-Ref
No description

DownloadableBlocksNoResults()   X-Ref
No description

DownloadableBlocksPanel(_ref)   X-Ref
No description

getInstallableBlocks(term)   X-Ref
No description

InserterMenuDownloadableBlocksPanel()   X-Ref
No description

CompactList(_ref)   X-Ref
Internal dependencies


InstalledBlocksPrePublishPanel()   X-Ref
No description

InstallButton(_ref)   X-Ref
Internal dependencies




Generated: Sun Jun 26 01:00:03 2022 Cross-referenced by PHPXref 0.7.1