public function onLoadCustomFieldsTypes(array &$types) : void

Fires while loading the list of supported custom fields types.


Description

Trigger hook to allow external plugins to support additional types for the custom fields.

New types have to be appended to the given associative array. The key of the array is the unique ID of the type, the value is a readable name of the type.

All the values included within the $types array will be reported as accepted options of the Type dropdown under the management page of a custom field.


Parameters

&$types

(array)  An associative array holding all the supported types.

Return Value

None.


Example

The example below adds support for a new "Radio Buttons" input type.

/**
 * Trigger hook to allow external plugins to support custom types.
 * New types have to be appended to the given associative array.
 * The key of the array is the unique ID of the type, the value is
 * a readable name of the type.
 *
 * @param   array  &$types  An array of types.
 *
 * @return  void
 */
public function onLoadCustomFieldsTypes(&$types)
{
    // add support for a new "radio" input type
    $types['radio'] = 'Radio Buttons';
}

Changelog

VersionDescription
1.7 Introduced.
Last Update: 2021-10-08 12:36
Helpful?
See Also: