MasterPress 1.2.6 is now available
We have released a compatibility update that addresses issues that appear when using MariaDB.
MPFT_RelatedTerm Pro
The UI and API implementation for the Related Term field type, augmented by Select2.
List of Methods
Property Methods
-
count()Integer
Return the count of terms selected in the UI. Since this overrides count the number of terms can also be retrieved by calling count directly on the field object.
-
is( Mixed $id, String $taxonomy = null ) OR WOOF_Silent
Overrides the MPFT::is method to allow the first or only term setup in this field to be checked for equality.
-
term() OR WOOF_Silent
Retrieves the first or only term selected in the UI.
-
terms()WOOF_Collection of
Retrieves a collection of the terms selected in the field UI. .
Manipulation
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related Term fields to be assigned a value in a number of different formats. A single term slug, name, ID, or MEOW_Term object.An array of term slugs, names, IDs, or MEOW_Term objects.A CSV string of term slugs, names, or IDs.Note that this implementation will infer the appropriate taxonomies to look for, based on the field type setup in MasterPress.
PHP Interface Method
-
count()Integer
Return the count of terms selected in the UI. Since this overrides count the number of terms 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 terms 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 ) OR WOOF_Silent
Gets the term object at the given numerical array offset, if it exists. Since this overrides offset-get the term 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()MEOW_Term OR WOOF_Silent
Implements MPFT::forward to return the first term, regardless of whether or not the field is setup to allow multiple terms to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Implements iterator_items to allow the selected terms 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 Term fields to be assigned a value in a number of different formats. A single term slug, name, ID, or MEOW_Term object.An array of term slugs, names, IDs, or MEOW_Term objects.A CSV string of term slugs, names, or IDs.Note that this implementation will infer the appropriate taxonomies to look for, based on the field type setup in MasterPress.
-
count()Integer
Return the count of terms selected in the UI. Since this overrides count the number of terms 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()MEOW_Term OR WOOF_Silent
Implements MPFT::forward to return the first term, regardless of whether or not the field is setup to allow multiple terms to be selected (iterator-related methods are setup to regard the multiple items though).
-
is( Mixed $id, String $taxonomy = null ) OR WOOF_Silent
Overrides the MPFT::is method to allow the first or only term setup in this field to be checked for equality.
-
iterator_items()Array
Implements iterator_items to allow the selected terms to be iterated with a foreach on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the terms 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 ) OR WOOF_Silent
Gets the term object at the given numerical array offset, if it exists. Since this overrides offset-get the term can be obtained by an array-style access directly on the field object – see example.
-
term() OR WOOF_Silent
Retrieves the first or only term selected in the UI.
-
terms()WOOF_Collection of
Retrieves a collection of the terms selected in the field UI. .
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related Term fields to be assigned a value in a number of different formats. A single term slug, name, ID, or MEOW_Term object.An array of term slugs, names, IDs, or MEOW_Term objects.A CSV string of term slugs, names, or IDs.Note that this implementation will infer the appropriate taxonomies to look for, based on the field type setup in MasterPress.
Delegate Methods
This class delegates to the MEOW_Term class, meaning it also supports the methods available in that class.
Base Class Methods
View method list from the base class MPFT.