Thrive Automator
Creating Action Fields
15min
Action Fields are the fields used for setting up an action in the admin user interface.
In order to create your own Action_Field you need to extend Thrive\Automator\Items\Action_Field and implement the required basic methods.
- abstract public static function get_id(): string - should return a unique identifier that will be used as a key in arrays. To avoid conflicts or overwrites we suggest using a prefix.
PHP
|
- abstract public static function get_name(): string - the name of the action field.
PHP
|
- abstract public static function get_description(): string - short description of the action field that will be displayed in the tooltip.
PHP
|
- abstract public static function get_placeholder(): string - input placeholder to be displayed in the admin UI.
PHP
|
- abstract public static function get_type(): string- type of input field, required to render in the admin UI.
PHP
|
- abstract public static function get_validators(): array - return an array of validations that should be done on the field.
PHP
|
- abstract public static function is_ajax_field(): bool - check if the field values are retrieved normally or with an ajax request.
PHP
|
- public static function get_default_value(): string - can be used to set default values for a field e.g select field.
PHP
|
- abstract public static function get_options_callback(): array - return an array of id/label arrays representing the option values for the action field.
PHP
|
In order to register this Action_Field so it can appear in the admin area, we should use the thrive_automator_register_action_field function which receives as the only parameter, the class name.

Updated 03 Mar 2023
Did this page help you?