API Documentation
\
Barn2
Plugin
WC_Product_Table
Admin
Compat
Data

\Barn2\Plugin\WC_Product_TableTable_Args

Responsible for storing and validating the product table arguments.

Parses an array of args into the corresponding properties.

Summary

Methods
Properties
Constants
__construct()
get_args()
set_args()
is_multi_add_to_cart()
get_defaults()
parse_columns_arg()
parse_filters_arg()
$columns
$headings
$widths
$auto_width
$priorities
$column_breakpoints
$responsive_control
$responsive_display
$wrap
$show_footer
$search_on_click
$filters
$filter_headings
$show_quantity
$variations
$cart_button
$ajax_cart
$scroll_offset
$description_length
$links
$lazy_load
$cache
$image_size
$lightbox
$shortcodes
$button_text
$date_format
$date_columns
$no_products_message
$no_products_filtered_message
$paging_type
$page_length
$search_box
$totals
$pagination
$reset_button
$add_selected_button
$user_products
$rows_per_page
$product_limit
$sort_by
$sort_order
$status
$category
$exclude_category
$tag
$term
$numeric_terms
$cf
$year
$month
$day
$exclude
$include
$search_term
$show_hidden
$offset
$search_filters
$default_args
No constants found
No protected methods found
No protected properties found
N/A
parse_args()
parse_columns()
parse_filters()
set_image_column_width()
array_filter_validate_boolean()
array_filter_custom_field_or_taxonomy()
$args
$_defaults
$standard_columns
$column_replacements
N/A

Properties

$columns

$columns :

Type

$headings

$headings :

Type

$widths

$widths :

Type

$auto_width

$auto_width :

Type

$priorities

$priorities :

Type

$column_breakpoints

$column_breakpoints :

Type

$responsive_control

$responsive_control :

Type

$responsive_display

$responsive_display :

Type

$wrap

$wrap :

Type

$show_footer

$show_footer :

Type

$search_on_click

$search_on_click :

Type

$filters

$filters :

Type

$filter_headings

$filter_headings :

Type

$show_quantity

$show_quantity :

Type

$variations

$variations :

Type

$cart_button

$cart_button :

Type

$ajax_cart

$ajax_cart :

Type

$scroll_offset

$scroll_offset :

Type

$description_length

$description_length :

Type

$links

$links :

Type

$lazy_load

$lazy_load :

Type

$cache

$cache :

Type

$image_size

$image_size :

Type

$lightbox

$lightbox :

Type

$shortcodes

$shortcodes :

Type

$button_text

$button_text :

Type

$date_format

$date_format :

Type

$date_columns

$date_columns :

Type

$no_products_message

$no_products_message :

Type

$no_products_filtered_message

$no_products_filtered_message :

Type

$paging_type

$paging_type :

Type

$page_length

$page_length :

Type

$search_box

$search_box :

Type

$totals

$totals :

Type

$pagination

$pagination :

Type

$reset_button

$reset_button :

Type

$add_selected_button

$add_selected_button :

Type

$user_products

$user_products :

Type

$rows_per_page

$rows_per_page :

Type

$product_limit

$product_limit :

Type

$sort_by

$sort_by :

Type

$sort_order

$sort_order :

Type

$status

$status :

Type

$category

$category :

Type

$exclude_category

$exclude_category :

Type

$tag

$tag :

Type

$term

$term :

Type

$numeric_terms

$numeric_terms :

Type

$cf

$cf :

Type

$year

$year :

Type

$month

$month :

Type

$day

$day :

Type

$exclude

$exclude :

Type

$include

$include :

Type

$search_term

$search_term :

Type

$show_hidden

$show_hidden :

Type

$offset

$offset :

Type

$search_filters

$search_filters :

Type

$default_args

$default_args :array

Type

array—The default table args.

$args

$args :array

Type

array—The original args array.

$_defaults

$_defaults :array

Type

array—The default args after merging with the plugin options (lazy loaded, internal use only).

$standard_columns

$standard_columns :array

Type

array—The full list of standard columns (excludes prefixed columns such as custom fields, taxonomies, and attributes).

$column_replacements

$column_replacements :array

Type

array—Some column replacements used for correcting misspelled columns.

Methods

__construct()

__construct(array  $args = array())

Parameters

array $args

get_args()

get_args()

set_args()

set_args(array  $args)

Parameters

array $args

is_multi_add_to_cart()

is_multi_add_to_cart()

get_defaults()

get_defaults()

parse_columns_arg()

parse_columns_arg(  $raw_columns)

Parameters

$raw_columns

parse_filters_arg()

parse_filters_arg(  $filters,  $variations,  $columns)

Parameters

$filters
$variations
$columns

parse_args()

parse_args(array  $args)

Parameters

array $args

parse_columns()

parse_columns(  $columns)

Parameters

$columns

parse_filters()

parse_filters(  $filters,  $variations,  $columns)

Parameters

$filters
$variations
$columns

set_image_column_width()

set_image_column_width()

array_filter_validate_boolean()

array_filter_validate_boolean(  $var)

Parameters

$var

array_filter_custom_field_or_taxonomy()

array_filter_custom_field_or_taxonomy(  $column)

Parameters

$column