Products extends Abstract_Field

Abstract field class.

Tags

Table of Contents

$button_width  : mixed

$choice_char  : array<string|int, mixed>

The choice character setting.

$choice_qty  : array<string|int, mixed>

The choice quantity setting.

$display_label  : mixed

$dynamic_products  : mixed

$equal_pricing  : bool

Whether all choices have equal pricing.

$has_conditional_logic  : bool

Whether the field has conditional logic.

$has_user_value  : bool

Whether the field has a user-defined value.

$is_display_field  : bool

Whether the field is for display only.

$label_position  : mixed

$manual_products  : mixed

$option  : mixed

$product  : mixed

$product_display_style  : mixed

$product_selection  : mixed

$show_in_product_gallery  : mixed

$stores_multiple_values  : bool

Whether the field can store multiple value selections (e.g checkboxes).

$supports_multiple_values  : bool

Whether the field supports multiple values (e.g checkboxes, radios, select).

$type  : mixed

$used_settings  : array<string|int, mixed>

An array of settings being used by the field.

$default_width  : mixed

$products  : mixed

__construct()  : mixed

Constructor.

__set()  : void

The set magic method.

add_button_width_css_variable()  : void

Add a style element with the CSS variable for the button width right after the field.

get_cart_item_data()  : array<string|int, mixed>

Retrieves the cart item data for the selected value(s) of the field.

get_choice_formula_value()  : string

Get the formula value associated with a choice of the field.

get_conditional_logic_config()  : object|null

Get the field conditional logic config.

get_id()  : string

Get the field id.

get_manually_selected_product_variations()  : array<string|int, mixed>

Get product variations that were manually selected in the backend options

get_product()  : WC_Product

Get the product for the field.

get_product_order_arg_value()  : string

Get product orderby arg value

get_product_orderby_arg_value()  : string

Get product orderby arg value

get_product_type_args()  : array<string|int, mixed>

Build product query args for product option type

get_setting()  : string|array<string|int, mixed>|null

Get the value of a specific field setting.

get_settings()  : array<string|int, mixed>|null

Get the array with the field settings.

get_type()  : string

Get the field type.

get_variable_product_style_checkbox()  : string

Return the variation products as checkboxes and allow them to add to cart from the product page

get_variable_product_style_image()  : string

Return the variation products as image buttons and allow them to add to cart from the product page

get_variable_product_style_product()  : string

Display variations as indidivual products and allow them to directly add to cart

get_variable_product_style_radio()  : string

Return the variation products as radio buttons and allow them to add to cart from the product page

has_conditional_logic()  : bool

Whether the field has conditional logic.

has_user_value()  : bool

Whether the field has a user inputted value.

is_required()  : bool

Whether the field is required.

render()  : void

Render the HTML for the field.

sanitize()  : mixed

Sanitize the field input value.

stores_multiple_values()  : bool

Whether the field stores multiple values.

validate()  : bool|WP_Error

Validate the product options and add to cart

get_attachment_image_sizes()  : string

Get the `sizes` attribute for the image element.

get_choice_for_value()  : array<string|int, mixed>|null

Retrieves the choice from the option DB based on the user value provided.

get_choice_image()  : string

get_choice_image_html()  : string

Get the choice image HTML markup

get_choice_pricing_attributes()  : string

Gets the data attributes to handle JS pricing calculation.

get_choice_pricing_string()  : string

Retrieves the pricing string for a choice

get_field_attributes()  : string

Gets the data attributes to handle conditional logic visibilities.

get_field_class()  : string

Gets the CSS class for the field.

get_image_data()  : string

Return the `data-image` attribute of the image button.

get_image_srcset()  : string

Get the srcset attribute for the image.

get_input_id()  : string

Gets the id attribute for the field input.

get_input_name()  : string

Gets the name attribute for the field input.

get_label()  : string

Get the label for the field or its choices.

get_pricing_attributes()  : array<string|int, mixed>

Retrieves top level pricing attributes for the field.

get_required_symbol()  : mixed

has_choice_images()  : bool

has_display_prerequisites()  : bool

Determines whether the option has enough data to display.

is_update_main_image_enable()  : bool

Whether the option has the "Update main image" setting enabled.

render_checkboxes_style_html()  : mixed

Render products in checkbox styles

render_choice_character_limits_label()  : void

Gets the label for choice character limits if applicable.

render_choice_quantity_limits_label()  : void

Gets the label for choice quantity limits if applicable.

render_description()  : void

Render the HTML for the field description.

render_dropdowns_style_html()  : mixed

Render products in dropdown styles

render_field_wrap_close()  : void

Renders the field wrap closing tag.

render_field_wrap_open()  : void

Renders the field wrap.

render_image_buttons_style_html()  : mixed

Render products in image buttons styles

render_option_name()  : void

Render the HTML for the field label.

render_product_style_html()  : mixed

Render the HTML for the product style.

render_products_html_based_on_style()  : mixed

Render the HTML for products based on the style.

render_radios_style_html()  : mixed

Render products in radio styles

get_button_width()  : string

Get the width of the image buttons.

get_deselect_svg()  : string

SVG for deselecting an image button.

get_edit_option_link()  : mixed

get_figcaption()  : mixed

get_image_wrap_class()  : string

Get the class for the image wrap.

init_conditional_logic()  : mixed

Determine whether the field has conditional logic.

is_update_main_image_enabled()  : bool

Whether the option has the "Update main image" setting enabled.

render_products()  : mixed

Render the HTML for the field input.