Option_Product_List_With_Images
- Full name:
\BigCommerce\Templates\Option_Types\Option_Product_List_With_Images - Parent class:
\BigCommerce\Templates\Option_Types\Option_Product_List
Properties
template
protected $templateMethods
get_options
protected get_options(): mixedget_attachment_id
protected get_attachment_id(mixed $post_id): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$post_id | mixed |
Inherited methods
format_currency
Formats a numeric value as a currency string.
protected format_currency(float $value, string $empty_value = ''): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$value | float | The currency value to format. |
$empty_value | string | The value to return if $value is empty. Pass null to format anyway. |
Return Value:
The formatted currency string or the empty value.
factory
Creates an instance of the controller
public static factory(array $options = [], string $template = ''): static- This method is static.
Parameters:
| Parameter | Type | Description |
|---|---|---|
$options | array | |
$template | string |
__construct
public __construct(array $options = [], string $template = ''): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$options | array | |
$template | string |
parse_options
protected parse_options(array $options): arrayParameters:
| Parameter | Type | Description |
|---|---|---|
$options | array |
render
Render the template and return it as a string
public render(): stringReturn Value:
The rendered template
get_data
Build the data that will be available to the template
public get_data(): arraywrap
Wrap the template output in an optional tag. This provides us a mechanism to ensure that some elements and classes are consistently available for JavaScript targeting, despite possible template overrides.
protected wrap(string $html): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$html | string |
get_wrapper_tag
protected get_wrapper_tag(): mixedget_wrapper_classes
protected get_wrapper_classes(): mixedget_wrapper_attributes
protected get_wrapper_attributes(): mixedbuild_attribute_string
Build a string of HTML attributes that can safely be injected into a template out of a list of key/value pairs
protected build_attribute_string(array $attributes): stringParameters:
| Parameter | Type | Description |
|---|---|---|
$attributes | array |
get_id
protected get_id(): mixedget_label
protected get_label(): mixedget_options
protected get_options(): mixeddefault_option
protected default_option(): mixedsort_options
protected sort_options(mixed $a, mixed $b): mixedParameters:
| Parameter | Type | Description |
|---|---|---|
$a | mixed | |
$b | mixed |
get_matching_post_id
protected get_matching_post_id(int $bc_id): intParameters:
| Parameter | Type | Description |
|---|---|---|
$bc_id | int | The BigCommerce product ID |
Return Value:
The WordPress post ID for the product
Automatically generated on 2025-01-21