Product_Shortcode_Single_Preview

Full name: \BigCommerce\Templates\Product_Shortcode_Single_Preview
Parent class: \BigCommerce\Templates\Product_Shortcode_Single

Methods

get_title

protected get_title(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_description

protected get_description(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_gallery

protected get_gallery(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_form

protected get_form(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

Inherited methods

format_currency

Formats a numeric value as a currency string.

protected format_currency(float $value, string $empty_value = &#039;&#039;): string

Parameters:

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 = &#039;&#039;): static

This method is static.

Parameters:

Parameter	Type	Description
`$options`	array
`$template`	string

__construct

public __construct(array $options = [], string $template = &#039;&#039;): mixed

Parameters:

Parameter	Type	Description
`$options`	array
`$template`	string

parse_options

protected parse_options(array $options): array

Parameters:

Parameter	Type	Description
`$options`	array

render

Render the template and return it as a string

public render(): string

Return Value:

The rendered template

get_data

Build the data that will be available to the template

public get_data(): array

wrap

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): string

Parameters:

Parameter	Type	Description
`$html`	string

get_wrapper_tag

protected get_wrapper_tag(): mixed

get_wrapper_classes

protected get_wrapper_classes(): mixed

get_wrapper_attributes

protected get_wrapper_attributes(): mixed

build_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): string

Parameters:

Parameter	Type	Description
`$attributes`	array

should_hide_prices

protected should_hide_prices(\BigCommerce\Post_Types\Product\Product $product): bool

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_price

public get_price(\BigCommerce\Post_Types\Product\Product $product): string

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_sku

protected get_sku(\BigCommerce\Post_Types\Product\Product $product): string

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_brand

protected get_brand(\BigCommerce\Post_Types\Product\Product $product): string

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_title

protected get_title(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_description

protected get_description(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_gallery

protected get_gallery(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_form

protected get_form(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_rating

protected get_rating(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

get_specs

protected get_specs(\BigCommerce\Post_Types\Product\Product $product): mixed

Parameters:

Parameter	Type	Description
`$product`	\BigCommerce\Post_Types\Product\Product

Automatically generated on 2025-01-21

Product Shortcode Single Product Single