WooCommerce Code Reference

ProductDetails extends AbstractBlock
in package

ProductDetails class.

Table of Contents

$asset_api  : Api
Instance of the asset API.
$asset_data_registry  : AssetDataRegistry
Instance of the asset data registry.
$block_name  : string
Block name.
$enqueued_assets  : bool
Tracks if assets have been enqueued.
$integration_registry  : IntegrationRegistry
Instance of the integration registry.
$namespace  : string
Block namespace.
__construct()  : mixed
Constructor.
enqueue_editor_assets()  : mixed
Enqueue assets used for rendering the block in editor context.
render_callback()  : string
The default render_callback for all blocks. This will ensure assets are enqueued just in time, then render the block (if applicable).
enqueue_data()  : mixed
Data passed through from server to client for block.
enqueue_scripts()  : mixed
Register/enqueue scripts used for this block on the frontend, during render.
get_block_type()  : string
Get the block type.
get_block_type_attributes()  : array<string|int, mixed>
Get block attributes.
get_block_type_editor_script()  : array<string|int, mixed>|string
Get the editor script data for this block type.
get_block_type_editor_style()  : string|null
Get the editor style handle for this block type.
get_block_type_render_callback()  : callable|null
Get the render callback for this block type.
get_block_type_script()  : array<string|int, mixed>|string|null
Get the frontend script handle for this block type.
get_block_type_style()  : array<string|int, string>|null
Get the frontend style handle for this block type.
get_block_type_supports()  : string
Get the supports array for this block type.
get_block_type_uses_context()  : array<string|int, mixed>
Get block usesContext.
get_chunks_paths()  : array<string|int, string>
Generate an array of chunks paths for loading translation.
get_full_block_name()  : string
Get the interactivity namespace. Only used when utilizing the interactivity API.
get_routes_from_namespace()  : array<string|int, mixed>
Get routes from a REST API namespace.
initialize()  : void
Initialize the block type.
is_block_editor()  : mixed
Are we currently on the admin block editor screen?
parse_render_callback_attributes()  : array<string|int, mixed>
Parses block attributes from the render_callback.
register_block_type()  : array<string|int, string>
Registers the block type with WordPress.
register_block_type_assets()  : mixed
Register script and style assets for the block type before it is registered.
register_chunk_translations()  : mixed
Injects Chunk Translations into the page so translations work for lazy loaded components.
render()  : string
Render the block.
render_legacy_block()  : string
Previously, the Product Details block was a standalone block. It doesn't have any inner blocks and it rendered the tabs directly like the classic template. When upgrading, we want the existing stores using the block to continue working as before, so we moved the logic the legacy render method here.
render_tabs()  : string
Gets the tabs with their content to be rendered by the block.
create_accordion_item_block()  : array<string|int, mixed>
Create an accordion item block.
has_accordion()  : bool
Check if a parsed block has an accordion.
hide_empty_accordion_items()  : array<string|int, mixed>
Hide empty accordion items.
inject_compatible_tabs()  : array<string|int, mixed>
Inject compatible tabs.
inject_parsed_accordion_blocks()  : array<string|int, mixed>
Inject parsed accordion blocks.
mark_accordion_item_hidden()  : array<string|int, mixed>
Mark an accordion item as hidden if it has no content.
register_hooked_block()  : void
Register a product details item using Block Hooks API.
validate_hooked_blocks()  : array<string|int, mixed>
Validate hooked blocks data. Remove duplicated entries with the same title and invalid entries with invalid content. Log errors to the WC logger.

Properties

Methods

__construct()

Constructor.

public __construct(Api $asset_api, AssetDataRegistry $asset_data_registry, IntegrationRegistry $integration_registry[, string $block_name = '' ]) : mixed
Parameters
$asset_api : Api

Instance of the asset API.

$asset_data_registry : AssetDataRegistry

Instance of the asset data registry.

$integration_registry : IntegrationRegistry

Instance of the integration registry.

$block_name : string = ''

Optionally set block name during construct.

Return values
mixed

enqueue_editor_assets()

Enqueue assets used for rendering the block in editor context.

public enqueue_editor_assets() : mixed

This is needed if a block is not yet within the post content--render and enqueue_assets may not have ran.

Return values
mixed

render_callback()

The default render_callback for all blocks. This will ensure assets are enqueued just in time, then render the block (if applicable).

public render_callback([array<string|int, mixed>|WP_Block $attributes = [] ][, string $content = '' ][, WP_Block|null $block = null ]) : string
Parameters
$attributes : array<string|int, mixed>|WP_Block = []

Block attributes, or an instance of a WP_Block. Defaults to an empty array.

$content : string = ''

Block content. Default empty string.

$block : WP_Block|null = null

Block instance.

Return values
stringRendered block type output.

enqueue_data()

Data passed through from server to client for block.

protected enqueue_data([array<string|int, mixed> $attributes = [] ]) : mixed
Parameters
$attributes : array<string|int, mixed> = []

Any attributes that currently are available from the block. Note, this will be empty in the editor context when the block is not in the post content on editor load.

Return values
mixed

enqueue_scripts()

Register/enqueue scripts used for this block on the frontend, during render.

protected enqueue_scripts([array<string|int, mixed> $attributes = [] ]) : mixed
Parameters
$attributes : array<string|int, mixed> = []

Any attributes that currently are available from the block.

Return values
mixed

get_block_type_attributes()

Get block attributes.

protected get_block_type_attributes() : array<string|int, mixed>
Return values
array<string|int, mixed>

get_block_type_editor_script()

Get the editor script data for this block type.

protected get_block_type_editor_script([string $key = null ]) : array<string|int, mixed>|string
Parameters
$key : string = null

Data to get, or default to everything.

Tags
see

$this->register_block_type()

Return values
array<string|int, mixed>|string

get_block_type_editor_style()

Get the editor style handle for this block type.

protected get_block_type_editor_style() : string|null
Tags
see

$this->register_block_type()

Return values
string|null

get_block_type_render_callback()

Get the render callback for this block type.

protected get_block_type_render_callback() : callable|null

Dynamic blocks should return a callback, for example, return [ $this, 'render' ];

Tags
see

$this->register_block_type()

Return values
callable|null

get_block_type_script()

Get the frontend script handle for this block type.

protected get_block_type_script([string $key = null ]) : array<string|int, mixed>|string|null
Parameters
$key : string = null

Data to get, or default to everything.

Tags
see

$this->register_block_type()

Return values
array<string|int, mixed>|string|null

get_block_type_style()

Get the frontend style handle for this block type.

protected get_block_type_style() : array<string|int, string>|null
Return values
array<string|int, string>|null

get_block_type_supports()

Get the supports array for this block type.

protected get_block_type_supports() : string
Tags
see

$this->register_block_type()

Return values
string

get_block_type_uses_context()

Get block usesContext.

protected get_block_type_uses_context() : array<string|int, mixed>
Return values
array<string|int, mixed>

get_chunks_paths()

Generate an array of chunks paths for loading translation.

protected get_chunks_paths(string $chunks_folder) : array<string|int, string>
Parameters
$chunks_folder : string

The folder to iterate over.

Return values
array<string|int, string>$chunks list of chunks to load.

get_full_block_name()

Get the interactivity namespace. Only used when utilizing the interactivity API.

protected get_full_block_name() : string
Return values
stringThe interactivity namespace, used to namespace interactivity API actions and state.

get_routes_from_namespace()

Get routes from a REST API namespace.

protected get_routes_from_namespace(string $namespace) : array<string|int, mixed>
Parameters
$namespace : string

Namespace to retrieve.

Return values
array<string|int, mixed>

parse_render_callback_attributes()

Parses block attributes from the render_callback.

protected parse_render_callback_attributes(array<string|int, mixed>|WP_Block $attributes) : array<string|int, mixed>
Parameters
$attributes : array<string|int, mixed>|WP_Block

Block attributes, or an instance of a WP_Block. Defaults to an empty array.

Return values
array<string|int, mixed>

register_block_type()

Registers the block type with WordPress.

protected register_block_type() : array<string|int, string>
Return values
array<string|int, string>Chunks paths.

register_block_type_assets()

Register script and style assets for the block type before it is registered.

protected register_block_type_assets() : mixed

This registers the scripts; it does not enqueue them.

Return values
mixed

register_chunk_translations()

Injects Chunk Translations into the page so translations work for lazy loaded components.

protected register_chunk_translations(array<string|int, string> $chunks) : mixed

The chunk names are defined when creating lazy loaded components using webpackChunkName.

Parameters
$chunks : array<string|int, string>

Array of chunk names.

Return values
mixed

render()

Render the block.

protected render(array<string|int, mixed> $attributes, string $content, WP_Block $block) : string
Parameters
$attributes : array<string|int, mixed>

Block attributes.

$content : string

Block content.

$block : WP_Block

Block instance.

Return values
stringRendered block output.

render_legacy_block()

Previously, the Product Details block was a standalone block. It doesn't have any inner blocks and it rendered the tabs directly like the classic template. When upgrading, we want the existing stores using the block to continue working as before, so we moved the logic the legacy render method here.

protected render_legacy_block(array<string|int, mixed> $attributes, string $content, WP_Block $block) : string
Parameters
$attributes : array<string|int, mixed>

Block attributes.

$content : string

Block content.

$block : WP_Block

Block instance.

Tags
see
https://github.com/woocommerce/woocommerce/pull/59005
Return values
stringRendered block output.

render_tabs()

Gets the tabs with their content to be rendered by the block.

protected render_tabs() : string
Return values
stringThe tabs html to be rendered by the block

create_accordion_item_block()

Create an accordion item block.

private create_accordion_item_block(string $title, string $content) : array<string|int, mixed>
Parameters
$title : string

Title of the accordion item.

$content : string

Content of the accordion item as block markup.

Return values
array<string|int, mixed>Accordion item.

has_accordion()

Check if a parsed block has an accordion.

private has_accordion(array<string|int, mixed> $parsed_block) : bool
Parameters
$parsed_block : array<string|int, mixed>

Parsed block.

Return values
boolTrue if the block has an accordion, false otherwise.

hide_empty_accordion_items()

Hide empty accordion items.

private hide_empty_accordion_items(array<string|int, mixed> $parsed_block, array<string|int, mixed> $context) : array<string|int, mixed>
Parameters
$parsed_block : array<string|int, mixed>

Parsed block.

$context : array<string|int, mixed>

Context.

Return values
array<string|int, mixed>Parsed block.

inject_compatible_tabs()

Inject compatible tabs.

private inject_compatible_tabs(array<string|int, mixed> $parsed_block) : array<string|int, mixed>
Parameters
$parsed_block : array<string|int, mixed>

Parsed block.

Return values
array<string|int, mixed>Parsed block.

inject_parsed_accordion_blocks()

Inject parsed accordion blocks.

private inject_parsed_accordion_blocks(array<string|int, mixed> $parsed_block, array<string|int, mixed> $accordion_blocks) : array<string|int, mixed>
Parameters
$parsed_block : array<string|int, mixed>

Parsed block.

$accordion_blocks : array<string|int, mixed>

Accordion blocks.

Return values
array<string|int, mixed>Parsed block.

mark_accordion_item_hidden()

Mark an accordion item as hidden if it has no content.

private mark_accordion_item_hidden(array<string|int, mixed> $item, array<string|int, mixed> $context) : array<string|int, mixed>
Parameters
$item : array<string|int, mixed>

Item to mark.

$context : array<string|int, mixed>

Context.

Return values
array<string|int, mixed>Item.

register_hooked_block()

Register a product details item using Block Hooks API.

private register_hooked_block(string $slug, array<string|int, mixed> $block) : void
Parameters
$slug : string

The slug of the item.

$block : array<string|int, mixed>

The block data.

Return values
void

validate_hooked_blocks()

Validate hooked blocks data. Remove duplicated entries with the same title and invalid entries with invalid content. Log errors to the WC logger.

private validate_hooked_blocks(array<string|int, mixed> $hooked_blocks) : array<string|int, mixed>
Parameters
$hooked_blocks : array<string|int, mixed>

{ Hooked blocks data. @type string $title Title of the hooked block. @type string $content Content of the hooked block, as block markup. }

Return values
array<string|int, mixed>Validated hooked blocks.