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_RelatedUserRole
The UI and API implementation for the Related User Role field type, augmented by Select2.
List of Methods
Property Methods
-
count()Integer
Return the count of user roles selected in the UI.
-
role()WOOF_Role OR WOOF_Silent
Retrieves the first or only role selected in the UI.
-
roles()WOOF_Collection of WOOF_Role
Retrieves a collection of the roles selected in the field UI. .
Manipulation
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related User Role fields to be assigned a value in a number of different formats. A single role ID (lowercase slug, e.g.
PHP Interface Method
-
count()Integer
Return the count of user roles selected in the UI.
-
offsetGet( Integer $index )MEOW_Post OR WOOF_Silent
Gets the post object at the given numerical array offset, if it exists. Since this overrides offset-get the user role 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_Post OR WOOF_Silent
Implements MPFT::forward to return the first user role, regardless of whether or not the field is setup to allow multiple roles to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Allows the selected roles to be iterated with a foreach on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the roles selected in the UI. Since this overrides offset-exists the offset test can be made by calling isset directly on the field object.
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related User Role fields to be assigned a value in a number of different formats. A single role ID (lowercase slug, e.g.
-
count()Integer
Return the count of user roles selected in the UI.
-
forward()Mixed
Implements MPFT::forward to allow the field object to forward calls to this field type’s delegate.
-
get_delegate()MEOW_Post OR WOOF_Silent
Implements MPFT::forward to return the first user role, regardless of whether or not the field is setup to allow multiple roles to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Allows the selected roles to be iterated with a foreach on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the roles 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 )MEOW_Post OR WOOF_Silent
Gets the post object at the given numerical array offset, if it exists. Since this overrides offset-get the user role can be obtained by an array-style access directly on the field object – see example.
-
role()WOOF_Role OR WOOF_Silent
Retrieves the first or only role selected in the UI.
-
roles()WOOF_Collection of WOOF_Role
Retrieves a collection of the roles selected in the field UI. .
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related User Role fields to be assigned a value in a number of different formats. A single role ID (lowercase slug, e.g.
Delegate Methods
This class delegates to the WOOF_Role class, meaning it also supports the methods available in that class.
Base Class Methods
View method list from the base class MPFT.