MasterPress 1.2.8 is now available
It was brought to our attention that MasterPress would give a tonne of warnings and deprecation notices when used with PHP 7.4 – this update addresses those.
WOOF_Taxonomy
Extends WOOF_Collection
MethodsRepresents a single Taxonomy (custom or built-in) within WordPress, containing many powerful methods for working with the terms within each taxonomy.
Example: Ways to obtain a WOOF_Taxonomy
List of Methods
Property Methods
-
label()String
An alias of the WOOF_Taxonomy::plural_label method to retrieve the plural-form of the taxonomy name.
-
plural_label()String
Retrieves the plural-form of the taxonomy name.
-
singular_label()String
Retrieves the singular form label for this taxonomy.
-
title()String
An alias of the WOOF_Taxonomy::plural_label method to retrieve the plural-form of the taxonomy name.
Manipulation
-
create( Arguments $args = array(), Boolean $update = false, Boolean $strip = true )WOOF_Term
Creates a new WOOF_Term object in this taxonomy, which can either have properties set by passing properties in the $args parameter, or setting them manually later in code (via the use of the magic method ---set).
-
find_or_create( String $slug )WOOF_Term
Retrieves a term object in this taxonomy by first trying to find a term with the specified $slug, or creating a new term with the specified slug if not found.This method could be very useful in some kind of import process, where you might want to create or update terms from another data source (such as a JSON API) without needing to worry about checking for existence first (see example).
-
insert( Arguments $args, Boolean $strip = true )WOOF_Term
A more readable synonym for the WOOF_Taxonomy::insert to create a term in this taxonomy and immediately update the database.
Taxonomy Terms
-
create( Arguments $args = array(), Boolean $update = false, Boolean $strip = true )WOOF_Term
Creates a new WOOF_Term object in this taxonomy, which can either have properties set by passing properties in the $args parameter, or setting them manually later in code (via the use of the magic method ---set).
-
find_or_create( String $slug )WOOF_Term
Retrieves a term object in this taxonomy by first trying to find a term with the specified $slug, or creating a new term with the specified slug if not found.This method could be very useful in some kind of import process, where you might want to create or update terms from another data source (such as a JSON API) without needing to worry about checking for existence first (see example).
-
flatten_terms( Arguments $args = array() )WOOF_Collection of WOOF_Term
Flattens a hierarchical term structure into a flat collection of terms.This method uses get_terms to retrieve the terms, so you can further clarify the query used with the args parameter.
-
non_empty_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are non-empty, that is, currently in use by one or more posts.
-
non_empty_top_level_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are both non-empty (in use by one or more posts) and at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
term( Mixed $id ) OR WOOF_Silent
Retrieve a term object in this taxonomy for the given $id.Note that this method forwards on to the WOOF::term method to retrieve the term, so the $id parameter can be a slug, ID, or even a WOOF_Term object itself (which will simply return this object).
-
terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
top_level_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
top_terms( Arguments $args = array() )WOOF_Collection of
An alias for the method WOOF_Taxonomy::top_level_terms and a preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
Post Types
-
post_types()WOOF_Collection of WOOF_PostType
Retrieves a collection of WOOF_PostType objects representing the post types attached to this taxonomy.
-
types()WOOF_Collection of WOOF_PostType
An alias of the WOOF_Taxonomy::post_types method to retrieve a collection of WOOF_PostType objects representing the post types attached to this taxonomy.
Internal Use
-
iterator_items()Array
Allows the post type to be directly iterated over, by returning all posts under this post type as items for the collection.
-
iterator_items()Array
Allows the taxonomy to be directly iterated over, by returning all terms under this taxonomy as items for the collection.
-
iterator_items()Array
Allows the post type to be directly iterated over, by returning all posts under this post type as items for the collection.
-
cap( String $key, String $fallback )String
Returns the custom capability key in use for a given standard capability key.
-
create( Arguments $args = array(), Boolean $update = false, Boolean $strip = true )WOOF_Term
Creates a new WOOF_Term object in this taxonomy, which can either have properties set by passing properties in the $args parameter, or setting them manually later in code (via the use of the magic method ---set).
-
find_or_create( String $slug )WOOF_Term
Retrieves a term object in this taxonomy by first trying to find a term with the specified $slug, or creating a new term with the specified slug if not found.This method could be very useful in some kind of import process, where you might want to create or update terms from another data source (such as a JSON API) without needing to worry about checking for existence first (see example).
-
flatten_terms( Arguments $args = array() )WOOF_Collection of WOOF_Term
Flattens a hierarchical term structure into a flat collection of terms.This method uses get_terms to retrieve the terms, so you can further clarify the query used with the args parameter.
-
insert( Arguments $args, Boolean $strip = true )WOOF_Term
A more readable synonym for the WOOF_Taxonomy::insert to create a term in this taxonomy and immediately update the database.
-
iterator_items()Array
Allows the taxonomy to be directly iterated over, by returning all terms under this taxonomy as items for the collection.
-
label()String
An alias of the WOOF_Taxonomy::plural_label method to retrieve the plural-form of the taxonomy name.
-
non_empty_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are non-empty, that is, currently in use by one or more posts.
-
non_empty_top_level_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are both non-empty (in use by one or more posts) and at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
plural_label()String
Retrieves the plural-form of the taxonomy name.
-
post_types()WOOF_Collection of WOOF_PostType
Retrieves a collection of WOOF_PostType objects representing the post types attached to this taxonomy.
-
singular_label()String
Retrieves the singular form label for this taxonomy.
-
term( Mixed $id ) OR WOOF_Silent
Retrieve a term object in this taxonomy for the given $id.Note that this method forwards on to the WOOF::term method to retrieve the term, so the $id parameter can be a slug, ID, or even a WOOF_Term object itself (which will simply return this object).
-
terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
title()String
An alias of the WOOF_Taxonomy::plural_label method to retrieve the plural-form of the taxonomy name.
-
top_level_terms( Arguments $args = array() )WOOF_Collection of
A preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
top_terms( Arguments $args = array() )WOOF_Collection of
An alias for the method WOOF_Taxonomy::top_level_terms and a preset on the method WOOF::terms to retrieve a collection of terms for this taxonomy which are at the top level of the taxonomy hierarchy.This method uses get_terms to retrieve the terms, so you can further clarify this query with the args parameter.
-
types()WOOF_Collection of WOOF_PostType
An alias of the WOOF_Taxonomy::post_types method to retrieve a collection of WOOF_PostType objects representing the post types attached to this taxonomy.
Base Class Methods
View method list from the base class WOOF_Collection.