Table_Query

Responsible for managing the posts table query, retrieving the list of posts (as an array of WP_Post objects), and finding the post totals.

Tags
author

Barn2 Plugins support@barn2.com

license

GPL-3.0

copyright

Barn2 Media Ltd

Table of Contents

$args  : mixed
$posts  : mixed
$total_filtered_posts  : mixed
$total_posts  : mixed
__construct()  : mixed
filter_wp_posts_selected_columns()  : mixed
get_posts()  : mixed
get_total_filtered_posts()  : mixed
get_total_posts()  : mixed
set_posts()  : mixed
set_total_filtered_posts()  : mixed
set_total_posts()  : mixed
add_ordering_args()  : array<string|int, mixed>
Adds ordering arguments to the query args array.
add_query_hooks()  : mixed
add_user_search_args()  : mixed
array_map_prefix_column()  : mixed
build_base_posts_query()  : mixed
build_meta_query()  : mixed
build_post_totals_query()  : mixed
build_posts_query()  : mixed
build_search_filters_tax_query()  : mixed
build_tax_query()  : mixed
check_within_post_limit()  : mixed
maybe_add_relation()  : mixed
maybe_nest_query()  : mixed
remove_query_hooks()  : mixed
run_posts_query()  : mixed
tax_query_item()  : array<string|int, mixed>
Generate an inner array for the 'tax_query' arg in WP_Query.

Properties

$total_filtered_posts

private mixed $total_filtered_posts = null
Tags

Methods

filter_wp_posts_selected_columns()

public filter_wp_posts_selected_columns(mixed $fields, mixed $query) : mixed
Parameters
$fields : mixed
$query : mixed
Tags
Return values
mixed —

get_posts()

public get_posts() : mixed
Tags
Return values
mixed —

get_total_filtered_posts()

public get_total_filtered_posts() : mixed
Tags
Return values
mixed —

get_total_posts()

public get_total_posts() : mixed
Tags
Return values
mixed —

set_posts()

public set_posts(mixed $posts) : mixed
Parameters
$posts : mixed
Tags
Return values
mixed —

set_total_filtered_posts()

public set_total_filtered_posts(mixed $total_filtered_posts) : mixed
Parameters
$total_filtered_posts : mixed
Tags
Return values
mixed —

set_total_posts()

public set_total_posts(mixed $total_posts) : mixed
Parameters
$total_posts : mixed
Tags
Return values
mixed —

add_ordering_args()

Adds ordering arguments to the query args array.

private add_ordering_args(array<string|int, mixed> $query_args) : array<string|int, mixed>

If sorting by a custom field (meta query), sets up orderby clauses for the meta value and handles posts with/without the meta field. Otherwise maps the sort_by parameter to the appropriate WP_Query orderby value.

Parameters
$query_args : array<string|int, mixed>

The existing query arguments

Tags
Return values
array<string|int, mixed> —

The modified query arguments with ordering parameters added

add_query_hooks()

private add_query_hooks() : mixed
Tags
Return values
mixed —

add_user_search_args()

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

array_map_prefix_column()

private static array_map_prefix_column(mixed $n) : mixed
Parameters
$n : mixed
Tags
Return values
mixed —

build_base_posts_query()

private build_base_posts_query() : mixed
Tags
Return values
mixed —

build_meta_query()

private build_meta_query() : mixed
Tags
Return values
mixed —

build_post_totals_query()

private build_post_totals_query() : mixed
Tags
Return values
mixed —

build_posts_query()

private build_posts_query() : mixed
Tags
Return values
mixed —

build_search_filters_tax_query()

private build_search_filters_tax_query([mixed $tax_query = [] ]) : mixed
Parameters
$tax_query : mixed = []
Tags
Return values
mixed —

build_tax_query()

private build_tax_query() : mixed
Tags
Return values
mixed —

check_within_post_limit()

private check_within_post_limit(mixed $count) : mixed
Parameters
$count : mixed
Tags
Return values
mixed —

maybe_add_relation()

private maybe_add_relation(mixed $query[, mixed $relation = 'AND' ]) : mixed
Parameters
$query : mixed
$relation : mixed = 'AND'
Tags
Return values
mixed —

maybe_nest_query()

private maybe_nest_query(mixed $main_query, mixed $inner_query) : mixed
Parameters
$main_query : mixed
$inner_query : mixed
Tags
Return values
mixed —

remove_query_hooks()

private remove_query_hooks() : mixed
Tags
Return values
mixed —

run_posts_query()

private run_posts_query(mixed $query_args) : mixed
Parameters
$query_args : mixed
Tags
Return values
mixed —

tax_query_item()

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

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

The list of terms as a string

$taxonomy : string

The taxonomy name

$operator : string = 'IN'

The SQL operator: IN, NOT IN, AND, etc

$field : string = ''

Add tax query by term_id or slug. Leave empty to auto-detect correct type

Tags
Return values
array<string|int, mixed> —

A tax query sub-array

Search results