[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-includes/ -> blocks.php (summary)

Functions related to registering and parsing blocks.

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

Defines 27 functions

  register_block_type()
  unregister_block_type()
  remove_block_asset_path_prefix()
  generate_block_asset_handle()
  register_block_script_handle()
  register_block_style_handle()
  register_block_type_from_metadata()
  has_blocks()
  has_block()
  get_dynamic_block_names()
  serialize_block_attributes()
  strip_core_block_namespace()
  get_comment_delimited_block_content()
  serialize_block()
  serialize_blocks()
  filter_block_content()
  filter_block_kses()
  filter_block_kses_value()
  excerpt_remove_blocks()
  _excerpt_render_inner_columns_blocks()
  render_block()
  parse_blocks()
  do_blocks()
  _restore_wpautop_hook()
  block_version()
  register_block_style()
  unregister_block_style()

Functions
Functions that are not part of a class:

register_block_type( $name, $args = array()   X-Ref
Registers a block type.

param: string|WP_Block_Type $name Block type name including namespace, or alternatively
param: array                $args {
return: WP_Block_Type|false The registered block type on success, or false on failure.

unregister_block_type( $name )   X-Ref
Unregisters a block type.

param: string|WP_Block_Type $name Block type name including namespace, or alternatively
return: WP_Block_Type|false The unregistered block type on success, or false on failure.

remove_block_asset_path_prefix( $asset_handle_or_path )   X-Ref
Removes the block asset's path prefix if provided.

param: string $asset_handle_or_path Asset handle or prefixed path.
return: string Path without the prefix or the original value.

generate_block_asset_handle( $block_name, $field_name )   X-Ref
Generates the name for an asset based on the name of the block
and the field name provided.

param: string $block_name Name of the block.
param: string $field_name Name of the metadata field.
return: string Generated asset name for the block's field.

register_block_script_handle( $metadata, $field_name )   X-Ref
Finds a script handle for the selected block metadata field. It detects
when a path to file was provided and finds a corresponding asset file
with details necessary to register the script under automatically
generated handle name. It returns unprocessed script handle otherwise.

param: array  $metadata   Block metadata.
param: string $field_name Field name to pick from metadata.
return: string|bool Script handle provided directly or created through

register_block_style_handle( $metadata, $field_name )   X-Ref
Finds a style handle for the block metadata field. It detects when a path
to file was provided and registers the style under automatically
generated handle name. It returns unprocessed style handle otherwise.

param: array  $metadata Block metadata.
param: string $field_name Field name to pick from metadata.
return: string|boolean Style handle provided directly or created through

register_block_type_from_metadata( $file_or_folder, $args = array()   X-Ref
Registers a block type from metadata stored in the `block.json` file.

param: string $file_or_folder Path to the JSON file with metadata definition for
param: array  $args {
return: WP_Block_Type|false The registered block type on success, or false on failure.

has_blocks( $post = null )   X-Ref
Determine whether a post or content string has blocks.

This test optimizes for performance rather than strict accuracy, detecting
the pattern of a block but not validating its structure. For strict accuracy,
you should use the block parser on post content.

param: int|string|WP_Post|null $post Optional. Post content, post ID, or post object. Defaults to global $post.
return: bool Whether the post has blocks.

has_block( $block_name, $post = null )   X-Ref
Determine whether a $post or a string contains a specific block type.

This test optimizes for performance rather than strict accuracy, detecting
the block type exists but not validating its structure. For strict accuracy,
you should use the block parser on post content.

param: string                  $block_name Full Block type to look for.
param: int|string|WP_Post|null $post Optional. Post content, post ID, or post object. Defaults to global $post.
return: bool Whether the post content contains the specified block.

get_dynamic_block_names()   X-Ref
Returns an array of the names of all registered dynamic block types.

return: string[] Array of dynamic block names.

serialize_block_attributes( $block_attributes )   X-Ref
Given an array of attributes, returns a string in the serialized attributes
format prepared for post content.

The serialized result is a JSON-encoded string, with unicode escape sequence
substitution for characters which might otherwise interfere with embedding
the result in an HTML comment.

param: array $block_attributes Attributes object.
return: string Serialized attributes.

strip_core_block_namespace( $block_name = null )   X-Ref
Returns the block name to use for serialization. This will remove the default
"core/" namespace from a block name.

param: string $block_name Original block name.
return: string Block name to use for serialization.

get_comment_delimited_block_content( $block_name, $block_attributes, $block_content )   X-Ref
Returns the content of a block, including comment delimiters.

param: string|null $block_name       Block name. Null if the block name is unknown,
param: array       $block_attributes Block attributes.
param: string      $block_content    Block save content.
return: string Comment-delimited block content.

serialize_block( $block )   X-Ref
Returns the content of a block, including comment delimiters, serializing all
attributes from the given parsed block.

This should be used when preparing a block to be saved to post content.
Prefer `render_block` when preparing a block for display. Unlike
`render_block`, this does not evaluate a block's `render_callback`, and will
instead preserve the markup as parsed.

param: WP_Block_Parser_Block $block A single parsed block object.
return: string String of rendered HTML.

serialize_blocks( $blocks )   X-Ref
Returns a joined string of the aggregate serialization of the given parsed
blocks.

param: WP_Block_Parser_Block[] $blocks Parsed block objects.
return: string String of rendered HTML.

filter_block_content( $text, $allowed_html = 'post', $allowed_protocols = array()   X-Ref
Filters and sanitizes block content to remove non-allowable HTML from
parsed block attribute values.

param: string         $text              Text that may contain block content.
param: array[]|string $allowed_html      An array of allowed HTML elements
param: string[]       $allowed_protocols Array of allowed URL protocols.
return: string The filtered and sanitized content result.

filter_block_kses( $block, $allowed_html, $allowed_protocols = array()   X-Ref
Filters and sanitizes a parsed block to remove non-allowable HTML from block
attribute values.

param: WP_Block_Parser_Block $block             The parsed block object.
param: array[]|string        $allowed_html      An array of allowed HTML
param: string[]              $allowed_protocols Allowed URL protocols.
return: array The filtered and sanitized block object result.

filter_block_kses_value( $value, $allowed_html, $allowed_protocols = array()   X-Ref
Filters and sanitizes a parsed block attribute value to remove non-allowable
HTML.

param: string[]|string $value             The attribute value to filter.
param: array[]|string  $allowed_html      An array of allowed HTML elements
param: string[]        $allowed_protocols Array of allowed URL protocols.
return: string[]|string The filtered and sanitized result.

excerpt_remove_blocks( $content )   X-Ref
Parses blocks out of a content string, and renders those appropriate for the excerpt.

As the excerpt should be a small string of text relevant to the full post content,
this function renders the blocks that are most likely to contain such text.

param: string $content The content to parse.
return: string The parsed and filtered content.

_excerpt_render_inner_columns_blocks( $columns, $allowed_blocks )   X-Ref
Render inner blocks from the `core/columns` block for generating an excerpt.

param: array $columns        The parsed columns block.
param: array $allowed_blocks The list of allowed inner blocks.
return: string The rendered inner blocks.

render_block( $parsed_block )   X-Ref
Renders a single block into a HTML string.

param: array $parsed_block A single parsed block object.
return: string String of rendered HTML.

parse_blocks( $content )   X-Ref
Parses blocks out of a content string.

param: string $content Post content.
return: array[] Array of parsed block objects.

do_blocks( $content )   X-Ref
Parses dynamic blocks out of `post_content` and re-renders them.

param: string $content Post content.
return: string Updated post content.

_restore_wpautop_hook( $content )   X-Ref
If do_blocks() needs to remove wpautop() from the `the_content` filter, this re-adds it afterwards,
for subsequent `the_content` usage.

param: string $content The post content running through this filter.
return: string The unmodified content.

block_version( $content )   X-Ref
Returns the current version of the block format that the content string is using.

If the string doesn't contain blocks, it returns 0.

param: string $content Content to test.
return: int The block format version is 1 if the content contains one or more blocks, 0 otherwise.

register_block_style( $block_name, $style_properties )   X-Ref
Registers a new block style.

param: string $block_name       Block type name including namespace.
param: array  $style_properties Array containing the properties of the style name,
return: bool True if the block style was registered with success and false otherwise.

unregister_block_style( $block_name, $block_style_name )   X-Ref
Unregisters a block style.

param: string $block_name       Block type name including namespace.
param: array  $block_style_name Block style name.
return: bool True if the block style was unregistered with success and false otherwise.



Generated : Wed Oct 28 08:20:01 2020 Cross-referenced by PHPXref