Posts_Table_Pro implements Registerable, Service

Handles the integration with PTP

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Interfaces, Classes and Traits

Registerable
Service

Table of Contents

add_column_defaults()  : array<string|int, mixed>
Adjust the column defaults for the table in PTP.
add_config_data()  : array<string|int, mixed>
Adds config data to the table html
change_document_categories_filter_heading()  : string
Change Document Categories filter heading
change_document_tags_filter_heading()  : string
Change Document Tags filter heading
get_doc_author_data()  : Document_Author
Add the Author column to the Table.
get_document_categories_data()  : Document_Categories
Add the Document Categories column to the Table.
get_document_link_data()  : Document_Categories
Add the Document Link column to the Table.
get_document_tags_data()  : Document_Tags
Add the Document Categories column to the Table.
get_document_version_data()  : Document_Categories
Add the Document Version column to the Table.
get_download_count_data()  : Download_Count
Add the Download Count column to the Table.
get_file_size_data()  : File_Size
Add the File Size column to the Table.
get_file_type_data()  : Document_Categories
Add the File Type column to the Table.
is_searchable_column()  : bool
Determines searchable status of columns
is_sortable_column()  : bool
Determines sortable status of columns
parse_custom_table_args()  : mixed
Parse any custom args.
register()  : mixed
{@inheritdoc}
register_custom_table_args_properties()  : array<string|int, string>
Adds new custom public properites to Table_Args
register_filterable_columns()  : array<string|int, string>
Register the columns which should be filterable
register_linkable_columns()  : array<string|int, string>
Register the columns which should have filter links
register_table_args_validation()  : array<string|int, mixed>
Register the validation handlers for custom Table_Args properties
register_table_default_args()  : array<string|int, mixed>
Adds the default args for new custom Table_Args properties
register_tax_queries()  : array<string|int, mixed>
Add our taxonomies to the table query
register_update_args()  : array<string|int, string>
Register the args which should update the filters
shortcode_tag_to_strip()  : string
Gets the Shortcode tag.
tax_query_item()  : array<string|int, mixed>
Generate an inner array for the 'tax_query' arg in WP_Query.

Methods

add_column_defaults()

Adjust the column defaults for the table in PTP.

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

add_config_data()

Adds config data to the table html

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

change_document_categories_filter_heading()

Change Document Categories filter heading

public change_document_categories_filter_heading(string $heading, Table_Args $args) : string
Parameters
$heading : string
$args : Table_Args
Tags
Return values
string —

change_document_tags_filter_heading()

Change Document Tags filter heading

public change_document_tags_filter_heading(string $heading, Table_Args $args) : string
Parameters
$heading : string
$args : Table_Args
Tags
Return values
string —

get_doc_author_data()

Add the Author column to the Table.

public get_doc_author_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Author
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Author —

get_document_categories_data()

Add the Document Categories column to the Table.

public get_document_categories_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Categories
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Categories —

get_document_link_data()

Add the Document Link column to the Table.

public get_document_link_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Categories
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Categories —

get_document_tags_data()

Add the Document Categories column to the Table.

public get_document_tags_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Tags
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Tags —

get_document_version_data()

Add the Document Version column to the Table.

public get_document_version_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Categories
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Categories —

get_download_count_data()

Add the Download Count column to the Table.

public get_download_count_data(mixed $data, WP_Post $post, Table_Args $args) : Download_Count
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Download_Count —

get_file_size_data()

Add the File Size column to the Table.

public get_file_size_data(mixed $data, WP_Post $post, Table_Args $args) : File_Size
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
File_Size —

get_file_type_data()

Add the File Type column to the Table.

public get_file_type_data(mixed $data, WP_Post $post, Table_Args $args) : Document_Categories
Parameters
$data : mixed
$post : WP_Post
$args : Table_Args
Tags
Return values
Document_Categories —

is_searchable_column()

Determines searchable status of columns

public is_searchable_column(bool $searchable, string $column) : bool
Parameters
$searchable : bool
$column : string
Tags
Return values
bool —

is_sortable_column()

Determines sortable status of columns

public is_sortable_column(bool $sortable, string $column) : bool
Parameters
$sortable : bool
$column : string
Tags
Return values
bool —

parse_custom_table_args()

Parse any custom args.

public parse_custom_table_args(Table_Args $table_args) : mixed
Parameters
$table_args : Table_Args
Tags
Return values
mixed —

register()

{@inheritdoc}

public register() : mixed
Tags
Return values
mixed —

register_custom_table_args_properties()

Adds new custom public properites to Table_Args

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

register_filterable_columns()

Register the columns which should be filterable

public register_filterable_columns(array<string|int, string> $columns) : array<string|int, string>
Parameters
$columns : array<string|int, string>
Tags
Return values
array<string|int, string> —

register_linkable_columns()

Register the columns which should have filter links

public register_linkable_columns(array<string|int, string> $columns) : array<string|int, string>
Parameters
$columns : array<string|int, string>
Tags
Return values
array<string|int, string> —

register_table_args_validation()

Register the validation handlers for custom Table_Args properties

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

register_table_default_args()

Adds the default args for new custom Table_Args properties

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

register_tax_queries()

Add our taxonomies to the table query

public register_tax_queries(array<string|int, mixed> $tax_query, Table_Query $table_query) : array<string|int, mixed>
Parameters
$tax_query : array<string|int, mixed>
$table_query : Table_Query
Tags
Return values
array<string|int, mixed> —

$tax_query

register_update_args()

Register the args which should update the filters

public register_update_args(array<string|int, string> $columns) : array<string|int, string>
Parameters
$columns : array<string|int, string>
Tags
Return values
array<string|int, string> —

shortcode_tag_to_strip()

Gets the Shortcode tag.

public shortcode_tag_to_strip(mixed $shortcode_tag) : string
Parameters
$shortcode_tag : mixed
Tags
Return values
string —

tax_query_item()

Generate an inner array for the 'tax_query' arg in WP_Query.

private tax_query_item(bool $numeric_terms, string $terms, string $taxonomy[, string $operator = 'IN' ][, string $field = '' ]) : array<string|int, mixed>
Parameters
$numeric_terms : bool

Term ID's or slugs

$terms : string

The list of terms as a string

$taxonomy : string

The taxonomy name

$operator : string = 'IN'

IN, NOT IN, AND, etc

$field : string = ''
Tags
Return values
array<string|int, mixed> —

A tax query sub-array

Search results