onUserfieldsLoaded

This event is triggered after the userfields have been loaded. The event is useful if you want to add another field for all users or a certain user role.

Availability

This event is available where

Data

Plugins must return a content-array for this event; otherwise, the content will not be available in the frontend.

Example Data

Array
(
    [userrole] => administrator
    [inspectorrole] => administrator
    [userfields] => Array
    (
        [username] => Array
            (
                [name] => username
                [label] => Username (read only)
                [type] => text
                [readonly] => 1
             )

        [image] => Array
             (
                [name] => profileimage
                [label] => Profile Image
                [type] => image
             )

        [description] => Array
             (
                [name] => description
                [label] => Author-Description (Markdown)
                [type] => textarea
             )
         ...
    )
)

Extra Note

If you add a field, then the key of the field and the name of the field must be the same. Otherwise the validation will remove that field.

# The KEY and the NAME must be the same "providerlogo"
$userfields['providerlogo'] = [
    'name'    => 'providerlogo',
    'label'   => 'Logo', 
    'type'    => 'image'
];

Example Usage

<?php

namespace plugins\myplugin;

use \typemill\plugin;

class myplugin extends plugin
{
    public static function getSubscribedEvents()
    {
        return [
            'onUserfieldsLoaded' => 'onUserfieldsLoaded'
        ];
    }

    public function onUserfieldsLoaded($data)
    {
        $userforms = $data->getData();

        $userfields = $userforms['userfields'];

        if($userforms['userrole'] == 'provider')
        {
            # add validation rules
            $userfields['providerlogo'] = [
                  'name'    => 'providerlogo',
                  'label'   => 'Logo', 
                  'type'    => 'image'
            ];
            $userfields['providertext'] = [
                  'name'    => 'providertext',
                  'label'   => 'Small text for infobox', 
                  'type'    => 'textarea',
                  'regex'   => '/^[a-zA-Z0-9 .,?!;:_\-\*]*$/'
            ];
        }

        $userforms['userfields'] = $userfields;

        $data->setData($userforms);
    }
}

See also

• onRolesPermissionsLoaded event.
• onResourcesLoaded event.
• Example code to add a new user role for plugin developers.
• User management for admins.