W3cubDocs

/WordPress

WP_Block_Type::__construct( string $block_type, array|string $args = array() )

Constructor.

Description

Will populate object properties from the provided arguments.

See also

Parameters

$block_typestringrequired
Block type name including namespace.
$argsarray|stringoptional
Array or string of arguments for registering a block type. Any arguments may be defined, however the ones described below are supported by default.
  • api_version string
    Block API version.
  • title string
    Human-readable block type label.
  • category string|null
    Block type category classification, used in search interfaces to arrange block types by category.
  • parent string[]|null
    Setting parent lets a block require that it is only available when nested within the specified blocks.
  • ancestor string[]|null
    Setting ancestor makes a block available only inside the specified block types at any position of the ancestor’s block subtree.
  • allowed_blocks string[]|null
    Limits which block types can be inserted as children of this block type.
  • icon string|null
    Block type icon.
  • description string
    A detailed block type description.
  • keywords string[]
    Additional keywords to produce block type as result in search interfaces.
  • textdomain string|null
    The translation textdomain.
  • styles array[]
    Alternative block styles.
  • variations array[]
    Block variations.
  • selectors array
    Custom CSS selectors for theme.json style generation.
  • supports array|null
    Supported features.
  • example array|null
    Structured data for the block preview.
  • render_callback callable|null
    Block type render callback.
  • variation_callback callable|null
    Block type variations callback.
  • attributes array|null
    Block type attributes property schemas.
  • uses_context string[]
    Context values inherited by blocks of this type.
  • provides_context string[]|null
    Context provided by blocks of this type.
  • block_hooks string[]
    Block hooks.
  • editor_script_handles string[]
    Block type editor only script handles.
  • script_handles string[]
    Block type front end and editor script handles.
  • view_script_handles string[]
    Block type front end only script handles.
  • editor_style_handles string[]
    Block type editor only style handles.
  • style_handles string[]
    Block type front end and editor style handles.
  • view_style_handles string[]
    Block type front end only style handles.

Default:array()

Source

public function __construct( $block_type, $args = array() ) {
	$this->name = $block_type;

	$this->set_props( $args );
}

Changelog

Version Description
6.5.0 Added the allowed_blocks, variation_callback, and view_style_handles properties.
6.4.0 Added the block_hooks property.
6.3.0 Added the selectors property.
6.1.0 Added the editor_script_handles, script_handles, view_script_handles, editor_style_handles, and style_handles properties.
Deprecated the editor_script, script, view_script, editor_style, and style properties.
6.0.0 Added the ancestor property.
5.9.0 Added the view_script property.
5.8.0 Added the variations property.
5.6.0 Added the api_version property.
5.5.0 Added the title, category, parent, icon, description, keywords, textdomain, styles, supports, example, uses_context, and provides_context properties.
5.0.0 Introduced.
Show 5 moreShow less

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_block_type/__construct