MasterPress 1.3.1 is now available
MasterPress 1.3.1 is a compatibility release for PHP 8 and WordPress 5.7. It still remains backwards compatible with older PHP versions.
MPFT_RelatedTaxonomy
The UI and API implementation for the Related Taxonomy field type, augmented by Select2.
List of Methods
Property Methods
-
count()Integer
Return the count of taxonomies selected in the UI. Since this overrides count the number of taxonomies can also be retrieved by calling count directly on the field object.
-
taxonomies()WOOF_Collection of WOOF_Taxonomy
Retrieves a collection of the taxonomies selected in the field UI. Note: you can further clarify the selected taxonomies by setting the args parameter to a wp_parse_args compatible array or string. .
-
taxonomy()WOOF_Taxonomy OR WOOF_Silent
Retrieves the first or only taxonomy selected in the UI.
Manipulation
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related Taxonomy fields to be assigned a value in a number of different formats. A single taxonomy name.An array of taxonomy names.A csv string of taxonomy names.Note: this method is not intended to be called directly.
PHP Interface Method
-
count()Integer
Return the count of taxonomies selected in the UI. Since this overrides count the number of taxonomies can also be retrieved by calling count directly on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the taxonomies selected in the UI. Since this overrides offset-exists the offset test can be made by calling isset directly on the field object.
-
offsetGet( Integer $index )WOOF_Taxonomy OR WOOF_Silent
Gets the taxonomy object at the given numerical array offset, if it exists. Since this overrides offset-get the taxonomy can be obtained by an array-style access directly on the field object – see example.
Internal Use
-
forward()Mixed
Implements MPFT::forward to allow the field object to forward calls to this field type’s delegate.
-
get_delegate()WOOF_Taxonomy OR WOOF_Silent
Implements MPFT::forward to return the first taxonomy, regardless of whether or not the field is setup to allow multiple taxonomies to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Implements iterator_items to allow the selected taxomomies to be iterated with a foreach on the field object.
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related Taxonomy fields to be assigned a value in a number of different formats. A single taxonomy name.An array of taxonomy names.A csv string of taxonomy names.Note: this method is not intended to be called directly.
-
count()Integer
Return the count of taxonomies selected in the UI. Since this overrides count the number of taxonomies can also be retrieved by calling count directly on the field object.
-
forward()Mixed
Implements MPFT::forward to allow the field object to forward calls to this field type’s delegate.
-
get_delegate()WOOF_Taxonomy OR WOOF_Silent
Implements MPFT::forward to return the first taxonomy, regardless of whether or not the field is setup to allow multiple taxonomies to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Implements iterator_items to allow the selected taxomomies to be iterated with a foreach on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the taxonomies selected in the UI. Since this overrides offset-exists the offset test can be made by calling isset directly on the field object.
-
offsetGet( Integer $index )WOOF_Taxonomy OR WOOF_Silent
Gets the taxonomy object at the given numerical array offset, if it exists. Since this overrides offset-get the taxonomy can be obtained by an array-style access directly on the field object – see example.
-
taxonomies()WOOF_Collection of WOOF_Taxonomy
Retrieves a collection of the taxonomies selected in the field UI. Note: you can further clarify the selected taxonomies by setting the args parameter to a wp_parse_args compatible array or string. .
-
taxonomy()WOOF_Taxonomy OR WOOF_Silent
Retrieves the first or only taxonomy selected in the UI.
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related Taxonomy fields to be assigned a value in a number of different formats. A single taxonomy name.An array of taxonomy names.A csv string of taxonomy names.Note: this method is not intended to be called directly.
Delegate Methods
This class delegates to the WOOF_Taxonomy class, meaning it also supports the methods available in that class.
Base Class Methods
View method list from the base class MPFT.