AddToCartWithOptionsVariationSelector
extends AbstractBlock
in package
Block type for variation selector in add to cart with options.
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() : mixed
- Initialize this 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_variation_label() : string
- Render variation label.
- render_variation_selector() : string
- Render variation selector dropdown.
- get_form_html() : string
- Get form HTML.
- get_form_opening() : string
- Get form opening HTML.
- get_reset_button_row() : string
- Get reset button row HTML.
- get_selected_attribute_value() : string
- Get selected attribute value.
- get_variation_options_html() : string
- Get HTML for variation options.
- get_variation_row() : string
- Get variation row HTML.
- get_variations_data() : array<string|int, mixed>|false
- Get variations data.
- get_variations_table() : string
- Get variations table HTML.
- render_variation_form() : string
- Render variation form.
Properties
$asset_api
Instance of the asset API.
protected
Api
$asset_api
$asset_data_registry
Instance of the asset data registry.
protected
AssetDataRegistry
$asset_data_registry
$block_name
Block name.
protected
string
$block_name
= 'add-to-cart-with-options-variation-selector'
$enqueued_assets
Tracks if assets have been enqueued.
protected
bool
$enqueued_assets
= false
$integration_registry
Instance of the integration registry.
protected
IntegrationRegistry
$integration_registry
$namespace
Block namespace.
protected
string
$namespace
= 'woocommerce'
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
string — Rendered 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()
Get the block type.
protected
get_block_type() : string
Return values
string —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
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
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
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
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
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
string — The 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> —initialize()
Initialize this block type.
protected
initialize() : mixed
- Hook into WP lifecycle.
- Register the block with WordPress.
Return values
mixed —is_block_editor()
Are we currently on the admin block editor screen?
protected
is_block_editor() : mixed
Return values
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
string — Rendered block output.render_variation_label()
Render variation label.
protected
render_variation_label(string $attribute_name) : string
Parameters
- $attribute_name : string
-
Name of the attribute.
Return values
string — Rendered label HTML.render_variation_selector()
Render variation selector dropdown.
protected
render_variation_selector(WC_Product $product, string $attribute_name, array<string|int, mixed> $options) : string
Parameters
- $product : WC_Product
-
The product object.
- $attribute_name : string
-
Name of the attribute.
- $options : array<string|int, mixed>
-
Available options for this attribute.
Return values
string — Rendered dropdown HTML.get_form_html()
Get form HTML.
private
get_form_html(WC_Product $product, array<string|int, mixed> $variations, array<string|int, mixed> $variation_attributes) : string
Parameters
- $product : WC_Product
-
Product instance.
- $variations : array<string|int, mixed>
-
Variations data.
- $variation_attributes : array<string|int, mixed>
-
Variation attributes.
Return values
string — Form HTMLget_form_opening()
Get form opening HTML.
private
get_form_opening(WC_Product $product, string $variations_attr) : string
Parameters
- $product : WC_Product
-
Product instance.
- $variations_attr : string
-
Variations JSON.
Return values
string — Form opening HTMLget_reset_button_row()
Get reset button row HTML.
private
get_reset_button_row() : string
Return values
string — Row HTMLget_selected_attribute_value()
Get selected attribute value.
private
get_selected_attribute_value(WC_Product $product, string $attribute_name) : string
Parameters
- $product : WC_Product
-
The product object.
- $attribute_name : string
-
Name of the attribute.
Return values
string — Selected valueget_variation_options_html()
Get HTML for variation options.
private
get_variation_options_html(WC_Product $product, string $attribute_name, array<string|int, mixed> $options, string $selected, bool $is_taxonomy) : string
Parameters
- $product : WC_Product
-
The product object.
- $attribute_name : string
-
Name of the attribute.
- $options : array<string|int, mixed>
-
Available options.
- $selected : string
-
Selected value.
- $is_taxonomy : bool
-
Whether this is a taxonomy-based attribute.
Return values
string — Options HTMLget_variation_row()
Get variation row HTML.
private
get_variation_row(WC_Product $product, string $attribute_name, array<string|int, mixed> $options) : string
Parameters
- $product : WC_Product
-
Product instance.
- $attribute_name : string
-
Attribute name.
- $options : array<string|int, mixed>
-
Attribute options.
Return values
string — Row HTMLget_variations_data()
Get variations data.
private
get_variations_data(WC_Product $product) : array<string|int, mixed>|false
Parameters
- $product : WC_Product
-
Product instance.
Return values
array<string|int, mixed>|false —get_variations_table()
Get variations table HTML.
private
get_variations_table(WC_Product $product, array<string|int, mixed> $variation_attributes) : string
Parameters
- $product : WC_Product
-
Product instance.
- $variation_attributes : array<string|int, mixed>
-
Variation attributes.
Return values
string — Table HTMLrender_variation_form()
Render variation form.
private
render_variation_form(WC_Product $product, array<string|int, mixed> $attributes) : string
Parameters
- $product : WC_Product
-
Product instance.
- $attributes : array<string|int, mixed>
-
Block attributes.