GravityKit\EntryTags\EntryTagAddon
Source: src/EntryTagAddon.php:10
Details
- Kind:
class - Namespace:
GravityKit\EntryTags - Extends: GFAddOn
Methods
| Method | Description |
|---|---|
get_instance() | Get the singleton instance of this class. |
init() | |
init_admin() | |
enqueue_block_assets() | Enqueues assets in block editor. |
modify_field_options_from_template_options() | Remaps the current gk/gravityview/template/options hook to the legacy field options callback. |
modify_field_options_in_gravityview() | Modifies field's options in GravityView. |
set_default_values_for_tag_field() | Sets default values for the tag field in JS. |
register_noconflict_scripts() | |
process_tags_before_entry_save() | Processes tags before an entry save. |
process_tags_on_entry_save() | Processes tags on entry save. |
admin_enqueue_styles() | Enqueues a color picker style in admin. |
scripts() | |
styles() | |
localize_admin_scripts() | Localizes admin scripts. |
localize_frontend_scripts() | Localizes frontend scripts. |
Method Reference
get_instance()
public static function get_instance()
Get the singleton instance of this class.
Returns
EntryTagAddon|null
Since: 1.0.0
Source: src/EntryTagAddon.php:51
init()
public function init()
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:66
init_admin()
public function init_admin()
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:85
enqueue_block_assets()
public function enqueue_block_assets()
Enqueues assets in block editor.
Returns
void
Since: 1.0.1
Source: src/EntryTagAddon.php:106
modify_field_options_from_template_options()
public function modify_field_options_from_template_options( $field_options, $field_type, $template_id, $context, $grouped, $form_id, $field_id, $input_type )
Remaps the current gk/gravityview/template/options hook to the legacy field options callback.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field_options | array | The field options. | |
$field_type | string | The field type (widget or field). | |
$template_id | string | The template ID. | |
$context | string | The context. | |
$grouped | bool | Whether the options should be grouped. | |
$form_id | int | The form ID. | |
$field_id | string | GF Field ID. | |
$input_type | string | The input type. |
Returns
array— The filtered options.
Since: TBD
Source: src/EntryTagAddon.php:138
modify_field_options_in_gravityview()
public function modify_field_options_in_gravityview( $field_options )
Modifies field's options in GravityView.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$field_options | array | Array of field options. |
Returns
array
Since: 1.0.0
Source: src/EntryTagAddon.php:155
set_default_values_for_tag_field()
public function set_default_values_for_tag_field()
Sets default values for the tag field in JS.
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:174
register_noconflict_scripts()
public function register_noconflict_scripts( $scripts )
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$scripts |
Since: 1.0.0
Source: src/EntryTagAddon.php:187
process_tags_before_entry_save()
public function process_tags_before_entry_save( $form )
Processes tags before an entry save.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$form | array |
Returns
void
Since: 1.0.1
Source: src/EntryTagAddon.php:200
process_tags_on_entry_save()
public function process_tags_on_entry_save( $entry, $form )
Processes tags on entry save.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
$entry | array | ||
$form | array |
Returns
array
Since: 1.0.0
Source: src/EntryTagAddon.php:238
admin_enqueue_styles()
public function admin_enqueue_styles()
Enqueues a color picker style in admin.
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:282
scripts()
public function scripts()
Returns
array[]
Since: 1.0.0
Source: src/EntryTagAddon.php:293
styles()
public function styles()
Returns
array[]
Since: 1.0.0
Source: src/EntryTagAddon.php:352
localize_admin_scripts()
public function localize_admin_scripts()
Localizes admin scripts.
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:399
localize_frontend_scripts()
public function localize_frontend_scripts()
Localizes frontend scripts.
Returns
void
Since: 1.0.0
Source: src/EntryTagAddon.php:416