2018-01-26 15:50:15 +01:00

114 lines
3.7 KiB
PHP

<?php
namespace Elementor;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Elementor textarea control.
*
* A base control for creating textarea control. Displays a classic textarea.
*
* Creating new control in the editor (inside `Widget_Base::_register_controls()`
* method):
*
* $this->add_control(
* 'item_description',
* [
* 'label' => __( 'Description', 'plugin-domain' ),
* 'type' => Controls_Manager::TEXTAREA,
* 'default' => __( 'Default description', 'plugin-domain' ),
* ]
* );
*
* PHP usage (inside `Widget_Base::render()` method):
*
* echo '<p>' . $this->get_settings( 'item_description' ) . '</p>';
*
* JS usage (inside `Widget_Base::_content_template()` method):
*
* <p>{{{ settings.item_description }}}</p>
*
* @since 1.0.0
*
* @param string $label Optional. The label that appears above of the
* field. Default is empty.
* @param string $title Optional. The field title that appears on mouse
* hover. Default is empty.
* @param string $placeholder Optional. The field placeholder that appears when
* the field has no values. Default is empty.
* @param string $description Optional. The description that appears below the
* field. Default is empty.
* @param mixed $default Optional. The field default value.
* @param int $rows Optional. Number of rows. Default is 5.
* @param string $separator Optional. 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. Default
* is 'default'.
* @param bool $show_label Optional. Whether to display the label. Default is
* true.
* @param bool $label_block Optional. Whether to display the label in a
* separate line. Default is false.
*/
class Control_Textarea extends Base_Data_Control {
/**
* Retrieve textarea control type.
*
* @since 1.0.0
* @access public
*
* @return string Control type.
*/
public function get_type() {
return 'textarea';
}
/**
* Retrieve textarea control default settings.
*
* Get the default settings of the textarea control. Used to return the
* default settings while initializing the textarea control.
*
* @since 1.0.0
* @access protected
*
* @return array Control default settings.
*/
protected function get_default_settings() {
return [
'label_block' => true,
'rows' => 5,
];
}
/**
* Render textarea control output in the editor.
*
* Used to generate the control HTML in the editor using Underscore JS
* template. The variables for the class are available using `data` JS
* object.
*
* @since 1.0.0
* @access public
*/
public function content_template() {
$control_uid = $this->get_control_uid();
?>
<div class="elementor-control-field">
<label for="<?php echo $control_uid; ?>" class="elementor-control-title">{{{ data.label }}}</label>
<div class="elementor-control-input-wrapper">
<textarea id="<?php echo $control_uid; ?>" rows="{{ data.rows }}" data-setting="{{ data.name }}" placeholder="{{ data.placeholder }}"></textarea>
</div>
</div>
<# if ( data.description ) { #>
<div class="elementor-control-field-description">{{{ data.description }}}</div>
<# } #>
<?php
}
}