Registration_Form
A block to display the registration form.
- Full name:
\BigCommerce\Editor\Gutenberg\Blocks\Registration_Form
- Parent class:
\BigCommerce\Editor\Gutenberg\Blocks\Shortcode_Block
Constants
Constant | Visibility | Type | Value |
---|---|---|---|
NAME | public | string | ’bigcommerce/registration-form’ |
Properties
icon
The icon for the block.
protected string $icon
shortcode
The shortcode used for this block.
protected string $shortcode
Methods
title
Returns the block’s title.
protected title(): string
Return Value:
The block’s title.
html_title
Returns the HTML title for the block.
protected html_title(): string
Return Value:
The HTML title.
html_image
Returns the URL of the image associated with the block.
protected html_image(): string
Return Value:
The image URL.
keywords
Returns an array of keywords related to the block.
protected keywords(): array
Return Value:
The block’s keywords.
Inherited methods
__construct
Constructor for the block, setting the assets URL.
public __construct(string $assets_url): mixed
Parameters:
Parameter | Type | Description |
---|---|---|
$assets_url | string | The URL for assets. |
name
Returns the name of the block.
public name(): string
Return Value:
The name of the block.
register
Registers the block with Gutenberg.
public register(): void
registration_args
Returns the arguments for registering the block.
protected registration_args(): array
Return Value:
The block registration arguments.
render
Renders the block. The default behavior is to convert the block into a shortcode, which will then be rendered by do_shortcode.
public render(array $attributes): string
Parameters:
Parameter | Type | Description |
---|---|---|
$attributes | array | The block attributes. |
Return Value:
The rendered block content.
attributes
Returns the block’s attributes.
protected attributes(): array
Return Value:
The block attributes.
js_config
Returns the JavaScript configuration for the block.
public js_config(): array
Return Value:
The block’s JS configuration.
image_url
Generates the image URL for the given file.
protected image_url(string $file): string
Parameters:
Parameter | Type | Description |
---|---|---|
$file | string | The image file name. |
Return Value:
The complete URL to the image.
title
Returns the title for the block.
protected title(): string
- This method is abstract.
Return Value:
The block’s title.
icon
Returns the icon for the block.
protected icon(): string
Return Value:
The icon for the block.
category
Returns the category for the block.
protected category(): string
Return Value:
The category for the block.
keywords
Returns an array of keywords for the block.
protected keywords(): array
Return Value:
The block’s keywords.
shortcode
Returns the shortcode associated with the block.
protected shortcode(): string
Return Value:
The shortcode for the block.
html_title
Returns the HTML title for the block.
protected html_title(): string
- This method is abstract.
Return Value:
The HTML title for the block.
html_image
Returns the HTML image for the block.
protected html_image(): string
- This method is abstract.
Return Value:
The HTML image for the block.
Automatically generated on 2025-01-21