Skip to content

Date Time Control

Elementor Core BasicDate Time Control

Elementor date time control displays a date/time picker field based on the Flatpickr library.

The control is defined in Control_Date_Time class which extends Base_Data_Control class.

When using this control, the type should be set to \Elementor\Controls_Manager::DATE_TIME constant.

Arguments

NameTypeDefaultDescription
typestringdate_timeThe type of the control.
labelstringThe label that appears above of the field.
descriptionstringThe description that appears below the field.
show_labelbooltrueWhether to display the label.
label_blockbooltrueWhether to display the label in a separate line.
separatorstringdefaultSet the position of the control separator. Available values are default, before and after. default will hide the separator, unless the control type has specific separator settings. before / after will position the separator before/after the control.
picker_optionsarrayenableTime:true,
minuteIncrement:1
The picker configurations.
defaultstringDefault date/time in MySQL format (YYYY-mm-dd HH:ii).

Return Value

(string) The chosen date/time in MySQL format (YYYY-mm-dd HH:ii).

Usage

php
<?php
class Elementor_Test_Widget extends \Elementor\Widget_Base {

	protected function register_controls(): void {

		$this->start_controls_section(
			'content_section',
			[
				'label' => esc_html__( 'Content', 'textdomain' ),
				'tab' => \Elementor\Controls_Manager::TAB_CONTENT,
			]
		);

		$this->add_control(
			'due_date',
			[
				'label' => esc_html__( 'Due Date', 'textdomain' ),
				'type' => \Elementor\Controls_Manager::DATE_TIME,
			]
		);

		$this->end_controls_section();

	}

	protected function render(): void {
		$settings = $this->get_settings_for_display();

		if ( empty( $settings['due_date'] ) ) {
			return;
		}

		$due_date = strtotime( $settings['due_date'] );
		$due_date_in_days = $due_date / DAY_IN_SECONDS;
		?>
		<p><?php printf( esc_html__( 'Something will happen in %s days.', 'textdomain' ), $due_date_in_days ); ?></p>
		<?php
	}

	protected function content_template(): void {
		?>
		<#
		if ( '' === settings.due_date ) {
			return;
		}

		const due_date = new Date( settings.due_date );
		const now_date = new Date();
		const due_date_in_days = Math.floor( ( due_date - now_date ) / 86400000 ); // 86400000 milliseconds in one Day.
		#>
		<p> Something will happen in {{{ due_date_in_days }}} days. </p>
		<?php
	}

}