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.
MPFT_RelatedUser
The UI and API implementation for the Related User field type, augmented by Select2.
List of Methods
Property Methods
-
count()Integer
Return the count of users selected in the UI. Since this provides a method for MEOW_Field::count to forward to, the number of users can also be retrieved by calling count directly on the field object.
-
user()MEOW_User OR WOOF_Silent
Retrieves the first (or only) selected user in the field UI. .
-
users()WOOF_Collection of MEOW_User
Retrieves a collection of the users selected in the field UI. .
Manipulation
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related User fields to be assigned a value in a number of different formats. A single user login, email, ID, or MEOW_User object.An array of user logins, emails, IDs, or MEOW_User objects.A CSV string of user logins, emails, or IDs.
PHP Interface Method
-
count()Integer
Return the count of users selected in the UI. Since this provides a method for MEOW_Field::count to forward to, the number of users 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 users 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_User OR WOOF_Silent
Gets the user object at the given numerical array offset, if it exists. Since this overrides offset-get the user 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_User OR WOOF_Silent
Implements MPFT::forward to return the first user, regardless of whether or not the field is setup to allow multiple users to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Allows the selected posts 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 User fields to be assigned a value in a number of different formats. A single user login, email, ID, or MEOW_User object.An array of user logins, emails, IDs, or MEOW_User objects.A CSV string of user logins, emails, or IDs.
-
count()Integer
Return the count of users selected in the UI. Since this provides a method for MEOW_Field::count to forward to, the number of users 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_User OR WOOF_Silent
Implements MPFT::forward to return the first user, regardless of whether or not the field is setup to allow multiple users to be selected (iterator-related methods are setup to regard the multiple items though).
-
iterator_items()Array
Allows the selected posts to be iterated with a foreach on the field object.
-
offsetExists( Integer $index )Boolean
Checks if the numerical array offset exists in the users 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_User OR WOOF_Silent
Gets the user object at the given numerical array offset, if it exists. Since this overrides offset-get the user can be obtained by an array-style access directly on the field object – see example.
-
user()MEOW_User OR WOOF_Silent
Retrieves the first (or only) selected user in the field UI. .
-
users()WOOF_Collection of MEOW_User
Retrieves a collection of the users selected in the field UI. .
-
value_for_set( Mixed $value )Mixed
Overrides the MPFT::value_for_set method to allow Related User fields to be assigned a value in a number of different formats. A single user login, email, ID, or MEOW_User object.An array of user logins, emails, IDs, or MEOW_User objects.A CSV string of user logins, emails, or IDs.
Delegate Methods
This class delegates to the MEOW_User class, meaning it also supports the methods available in that class.
Base Class Methods
View method list from the base class MPFT.