Date

This field type renders a date picker.

Parameters

  • placeholder - text that describes the expected value;

  • format - the source date format;

  • display_format - the displayed date format;

  • min_date - the earliest date available for selection;

  • max_date - the latest date available for selection;

  • disabled_dates - an array of dates disabled in the calendar;

  • disabled_days - an array of week day numbers disabled in the calendar;

  • offset - number of days not available for selection (starting from today);

  • window - number of days available for selection (starting from today);

  • time - set to true to allow selecting time.

Example

The code below renders a required date picker with the custom_field name, "Custom field" label and custom date formats (e.g. the source date "2001-01-01" is displayed as "January 1, 2001"). It allows selecting a date starting from tomorrow and up to 30 days in advance.

echo ( new HivePress\Fields\Date(
	[
		'name'           => 'custom_field',
		'label'          => 'Custom field',
		'format'         => 'Y-m-d',
		'display_format' => 'F j, Y',
		'offset'         => 1,
		'window'         => 30,
		'required'       => true,
	]
) )->render();

Last updated