Table of Contents
Elementor button control displays a button in the panel that can trigger an event.
The control is defined in Control_Button class which extends Base_UI_Control class.
Note that when using the control, the type should be set using the \Elementor\Controls_Manager::BUTTON constant.
Arguments
| Name | Type | Default | Description |
|---|---|---|---|
type |
string |
button | The type of the control. |
label |
string |
The label that appears above of the field. | |
description |
string |
The description that appears below the field. | |
show_label |
bool |
true | Whether to display the label. |
label_block |
bool |
false | Whether to display the label in a separate line. |
separator |
string |
default | Set the position of the control separator. Available values are default, before, after and none. default will position the separator depending on the control type. before / after will position the separator before/after the control. none will hide the separator. |
text |
string |
The button text. | |
button_type |
string |
default | The button type. Available values are default and success. |
event |
string |
The event the button will trigger. The event will be triggered via elementor.channels.editor.on( event ). |
Return Value
This control does not return any value.
Usage
<?php
class Elementor_Test_Widget extends \Elementor\Widget_Base {
protected function _register_controls() {
$this->start_controls_section(
'content_section',
[
'label' => __( 'Content', 'plugin-name' ),
'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
]
);
$this->add_control(
'delete_content',
[
'label' => __( 'Delete Content', 'plugin-name' ),
'type' => \Elementor\Controls_Manager::BUTTON,
'separator' => 'before',
'button_type' => 'success',
'text' => __( 'Delete', 'plugin-domain' ),
'event' => 'namespace:editor:delete',
]
);
$this->end_controls_section();
}
}