Table_Args

Responsible for storing and validating the posts table arguments.

Parses an array of args into the corresponding properties.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Table of Contents

$author  : mixed
$auto_width  : mixed
$button_text  : mixed
$cache  : mixed
$category  : mixed
$cf  : mixed
$column_breakpoints  : mixed
$columns  : mixed
$content_length  : mixed
$date_columns  : mixed
$date_format  : mixed
$day  : mixed
$excerpt_length  : mixed
$exclude  : mixed
$exclude_category  : mixed
$exclude_term  : mixed
$filter_headings  : mixed
$filters  : mixed
$headings  : mixed
$image_size  : mixed
$include  : mixed
$lazy_load  : mixed
$lightbox  : mixed
$links  : mixed
$month  : mixed
$no_posts_filtered_message  : mixed
$no_posts_message  : mixed
$numeric_terms  : mixed
$offset  : mixed
$page_length  : mixed
$pagination  : mixed
$paging_type  : mixed
$post_limit  : mixed
$post_mime_type  : mixed
$post_type  : mixed
$priorities  : mixed
$reset_button  : mixed
$responsive_control  : mixed
$responsive_display  : mixed
$rows_per_page  : mixed
$scroll_offset  : mixed
$search_box  : mixed
$search_filters  : mixed
$search_on_click  : mixed
$search_term  : mixed
$shortcodes  : mixed
$show_footer  : mixed
$show_hidden_columns  : mixed
$sort_by  : mixed
$sort_order  : mixed
$status  : mixed
$tag  : mixed
$term  : mixed
$totals  : mixed
$user_search_term  : mixed
$widths  : mixed
$wrap  : mixed
$year  : mixed
$args  : array<string|int, mixed>
$default_args  : array<string|int, mixed>
__construct()  : mixed
get_args()  : mixed
get_defaults()  : mixed
Deprecated.
get_site_defaults()  : array<string|int, mixed>
Get the default table args, including plugin settings. Plugin settings override the initial args.
get_table_defaults()  : array<string|int, mixed>
Get the initial default table args, not including plugin settings.
get_user_defaults()  : mixed
Deprecated.
set_args()  : mixed
array_filter_custom_field_or_taxonomy()  : mixed
array_filter_validate_boolean()  : mixed
parse_args()  : mixed
set_columns()  : mixed
Validate the columns arg, and stores the result in the $columns and $headings properties.
set_custom_properties()  : mixed
set_filters()  : mixed
Validate the filters arg, and stores the result in the $filters and $filter_headings properties.
set_image_column_width()  : mixed
set_image_size()  : mixed
set_post_type()  : mixed

Properties

$column_breakpoints

public mixed $column_breakpoints
Tags

$content_length

public mixed $content_length
Tags

$excerpt_length

public mixed $excerpt_length
Tags

$exclude_category

public mixed $exclude_category
Tags

$filter_headings

public mixed $filter_headings
Tags

$no_posts_filtered_message

public mixed $no_posts_filtered_message
Tags

$no_posts_message

public mixed $no_posts_message
Tags

$post_mime_type

public mixed $post_mime_type
Tags

$responsive_control

public mixed $responsive_control
Tags

$responsive_display

public mixed $responsive_display
Tags

$search_filters

public mixed $search_filters = []
Tags

$search_on_click

public mixed $search_on_click
Tags

$show_hidden_columns

public mixed $show_hidden_columns
Tags

$user_search_term

public mixed $user_search_term
Tags

$args

private array<string|int, mixed> $args = []

The args array.

Tags

$default_args

private static array<string|int, mixed> $default_args = [ 'columns' => 'image,title,excerpt,categories,author,date', // allowed: id, title, content, excerpt, date, categories, tags, author, status, image, tax:<taxonomy_name>, cf:<custom_field> 'widths' => '', 'auto_width' => true, 'priorities' => '', 'column_breakpoints' => '', 'responsive_control' => 'inline', // inline or column 'responsive_display' => 'child_row', // child_row, child_row_visible, or modal 'wrap' => true, 'show_footer' => false, 'search_on_click' => true, 'filters' => false, 'scroll_offset' => 15, 'content_length' => 15, 'excerpt_length' => -1, 'links' => 'title,categories,tags,terms,author', // set to all or none, or any combination of id, title, terms, tags, categories, author, image 'lazy_load' => false, 'cache' => false, 'image_size' => '70x70', 'lightbox' => true, 'shortcodes' => false, 'date_format' => '', 'date_columns' => '', 'no_posts_message' => '', 'no_posts_filtered_message' => '', 'paging_type' => 'numbers', 'page_length' => 'bottom', 'search_box' => true, 'totals' => 'bottom', 'pagination' => 'bottom', 'reset_button' => true, 'button_text' => 'View', 'rows_per_page' => 25, 'post_limit' => 500, 'sort_by' => 'date', 'sort_order' => '', // no default set - see parse_args() 'post_type' => 'post', 'status' => 'publish', 'category' => '', // list of slugs or IDs 'exclude_category' => '', // list of slugs or IDs 'tag' => '', // list of slugs or IDs 'term' => '', // list of terms of the form <taxonomy>:<term> 'exclude_term' => '', // list of terms of the form <taxonomy>:<term> 'numeric_terms' => false, // set to true if using categories, tags or terms with numeric slugs 'cf' => '', // list of custom fields of the form <field_key>:<field_value> 'year' => '', 'month' => '', 'day' => '', 'author' => '', // list of author IDs 'exclude' => '', // list of post IDs 'include' => '', // list of post IDs 'search_term' => '', 'show_hidden_columns' => false, ]

The default table parameters

Tags

Methods

__construct()

public __construct([array<string|int, mixed> $args = [] ]) : mixed
Parameters
$args : array<string|int, mixed> = []
Tags
Return values
mixed —

get_args()

public get_args() : mixed
Tags
Return values
mixed —

get_defaults()

Deprecated.

public static get_defaults() : mixed
Tags
deprecated
2.3.2

Renamed get_site_defaults().

Return values
mixed —

get_site_defaults()

Get the default table args, including plugin settings. Plugin settings override the initial args.

public static get_site_defaults() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

The site defaults.

get_table_defaults()

Get the initial default table args, not including plugin settings.

public static get_table_defaults() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

The table defaults.

get_user_defaults()

Deprecated.

public static get_user_defaults() : mixed
Tags
deprecated
2.5.1

Renamed get_site_defaults().

Return values
mixed —

set_args()

public set_args(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>
Tags
Return values
mixed —

array_filter_custom_field_or_taxonomy()

private array_filter_custom_field_or_taxonomy(mixed $column) : mixed
Parameters
$column : mixed
Tags
Return values
mixed —

array_filter_validate_boolean()

private array_filter_validate_boolean(mixed $var) : mixed
Parameters
$var : mixed
Tags
Return values
mixed —

parse_args()

private parse_args(array<string|int, mixed> $args) : mixed
Parameters
$args : array<string|int, mixed>
Tags
Return values
mixed —

set_columns()

Validate the columns arg, and stores the result in the $columns and $headings properties.

private set_columns() : mixed
Tags
Return values
mixed —

set_custom_properties()

private set_custom_properties(mixed $custom_properties) : mixed
Parameters
$custom_properties : mixed
Tags
Return values
mixed —

set_filters()

Validate the filters arg, and stores the result in the $filters and $filter_headings properties.

private set_filters() : mixed
Tags
Return values
mixed —

set_image_column_width()

private set_image_column_width() : mixed
Tags
Return values
mixed —

set_image_size()

private set_image_size() : mixed
Tags
Return values
mixed —

set_post_type()

private set_post_type() : mixed
Tags
Return values
mixed —

Search results