[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> class-wp-term-query.php (summary)

Taxonomy API: WP_Term_Query class.

File Size: 1069 lines (37 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_Term_Query:: (9 methods):
  __construct()
  parse_query()
  query()
  get_terms()
  parse_orderby()
  parse_orderby_meta()
  parse_order()
  get_search_sql()
  populate_terms()


Class: WP_Term_Query  - X-Ref

Class used for querying terms.

__construct( $query = '' )   X-Ref
Constructor.

Sets up the term query, based on the query vars passed.

since: 4.6.0
since: 4.6.0 Introduced 'term_taxonomy_id' parameter.
since: 4.7.0 Introduced 'object_ids' parameter.
since: 4.9.0 Added 'slug__in' support for 'orderby'.
param: string|array $query {

parse_query( $query = '' )   X-Ref
Parse arguments passed to the term query with default query parameters.

since: 4.6.0
param: string|array $query WP_Term_Query arguments. See WP_Term_Query::__construct()

query( $query )   X-Ref
Sets up the query and retrieves the results.

The return type varies depending on the value passed to `$args['fields']`. See
WP_Term_Query::get_terms() for details.

since: 4.6.0
return: WP_Term[]|int[]|string[]|string Array of terms, or number of terms as numeric string
param: string|array $query Array or URL query string of parameters.

get_terms()   X-Ref
Retrieves the query results.

The return type varies depending on the value passed to `$args['fields']`.

The following will result in an array of `WP_Term` objects being returned:

- 'all'
- 'all_with_object_id'

The following will result in a numeric string being returned:

- 'count'

The following will result in an array of text strings being returned:

- 'id=>name'
- 'id=>slug'
- 'names'
- 'slugs'

The following will result in an array of numeric strings being returned:

- 'id=>parent'

The following will result in an array of integers being returned:

- 'ids'
- 'tt_ids'

since: 4.6.0
return: WP_Term[]|int[]|string[]|string Array of terms, or number of terms as numeric string

parse_orderby( $orderby_raw )   X-Ref
Parse and sanitize 'orderby' keys passed to the term query.

since: 4.6.0
return: string|false Value to used in the ORDER clause. False otherwise.
param: string $orderby_raw Alias for the field to order by.

parse_orderby_meta( $orderby_raw )   X-Ref
Generate the ORDER BY clause for an 'orderby' param that is potentially related to a meta query.

since: 4.6.0
return: string ORDER BY clause.
param: string $orderby_raw Raw 'orderby' value passed to WP_Term_Query.

parse_order( $order )   X-Ref
Parse an 'order' query variable and cast it to ASC or DESC as necessary.

since: 4.6.0
return: string The sanitized 'order' query variable.
param: string $order The 'order' query variable.

get_search_sql( $string )   X-Ref
Used internally to generate a SQL string related to the 'search' parameter.

since: 4.6.0
return: string
param: string $string

populate_terms( $term_ids )   X-Ref
Creates an array of term objects from an array of term IDs.

Also discards invalid term objects.

since: 4.9.8
return: array
param: array $term_ids Term IDs.



Generated: Thu May 13 01:00:05 2021 Cross-referenced by PHPXref 0.7.1