MPFT_RelatedUserRole

Extends MPFT

Delegate WOOF_Role

Methods

The UI and API implementation for the Related User Role field type, augmented by Select2.

List of Methods

Property Methods

Manipulation

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.

Latest From the Blog

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.

Plugin Requirements

MasterPress requires a minimum of WordPress version 4.9, MySQL 5.6, and PHP version 5.6.20.

We also recommend that PHP is configured to use a memory limit of 64MB per request (128MB may be required for sites with higher complexity).

This plug-in is not compatible with the WordPress.com hosted service.

Three AM