215 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
			
		
		
	
	
			215 lines
		
	
	
		
			5.4 KiB
		
	
	
	
		
			PHP
		
	
	
	
	
	
<?php
 | 
						|
 | 
						|
if ( ! class_exists( 'acf_field_time_picker' ) ) :
 | 
						|
 | 
						|
	class acf_field_time_picker extends acf_field {
 | 
						|
 | 
						|
 | 
						|
		/*
 | 
						|
		*  __construct
 | 
						|
		*
 | 
						|
		*  This function will setup the field type data
 | 
						|
		*
 | 
						|
		*  @type    function
 | 
						|
		*  @date    5/03/2014
 | 
						|
		*  @since   5.0.0
 | 
						|
		*
 | 
						|
		*  @param   n/a
 | 
						|
		*  @return  n/a
 | 
						|
		*/
 | 
						|
 | 
						|
		function initialize() {
 | 
						|
 | 
						|
			// vars
 | 
						|
			$this->name          = 'time_picker';
 | 
						|
			$this->label         = __( 'Time Picker', 'acf' );
 | 
						|
			$this->category      = 'advanced';
 | 
						|
			$this->description   = __( 'An interactive UI for picking a time. The time format can be customized using the field settings.', 'acf' );
 | 
						|
			$this->preview_image = acf_get_url() . '/assets/images/field-type-previews/field-preview-time.png';
 | 
						|
			$this->doc_url       = acf_add_url_utm_tags( 'https://www.advancedcustomfields.com/resources/time-picker/', 'docs', 'field-type-selection' );
 | 
						|
			$this->defaults      = array(
 | 
						|
				'display_format' => 'g:i a',
 | 
						|
				'return_format'  => 'g:i a',
 | 
						|
			);
 | 
						|
 | 
						|
		}
 | 
						|
 | 
						|
 | 
						|
		/*
 | 
						|
		*  render_field()
 | 
						|
		*
 | 
						|
		*  Create the HTML interface for your field
 | 
						|
		*
 | 
						|
		*  @param   $field - an array holding all the field's data
 | 
						|
		*
 | 
						|
		*  @type    action
 | 
						|
		*  @since   3.6
 | 
						|
		*  @date    23/01/13
 | 
						|
		*/
 | 
						|
 | 
						|
		function render_field( $field ) {
 | 
						|
 | 
						|
			// Set value.
 | 
						|
			$display_value = '';
 | 
						|
 | 
						|
			if ( $field['value'] ) {
 | 
						|
				$display_value = acf_format_date( $field['value'], $field['display_format'] );
 | 
						|
			}
 | 
						|
 | 
						|
			// Elements.
 | 
						|
			$div          = array(
 | 
						|
				'class'            => 'acf-time-picker acf-input-wrap',
 | 
						|
				'data-time_format' => acf_convert_time_to_js( $field['display_format'] ),
 | 
						|
			);
 | 
						|
			$hidden_input = array(
 | 
						|
				'id'    => $field['id'],
 | 
						|
				'class' => 'input-alt',
 | 
						|
				'type'  => 'hidden',
 | 
						|
				'name'  => $field['name'],
 | 
						|
				'value' => $field['value'],
 | 
						|
			);
 | 
						|
			$text_input   = array(
 | 
						|
				'class' => $field['class'] . ' input',
 | 
						|
				'type'  => 'text',
 | 
						|
				'value' => $display_value,
 | 
						|
			);
 | 
						|
			foreach ( array( 'readonly', 'disabled' ) as $k ) {
 | 
						|
				if ( ! empty( $field[ $k ] ) ) {
 | 
						|
					$hidden_input[ $k ] = $k;
 | 
						|
					$text_input[ $k ]   = $k;
 | 
						|
				}
 | 
						|
			}
 | 
						|
 | 
						|
			// Output.
 | 
						|
			?>
 | 
						|
		<div <?php echo acf_esc_attrs( $div ); ?>>
 | 
						|
			<?php acf_hidden_input( $hidden_input ); ?>
 | 
						|
			<?php acf_text_input( $text_input ); ?>
 | 
						|
		</div>
 | 
						|
			<?php
 | 
						|
 | 
						|
		}
 | 
						|
 | 
						|
 | 
						|
		/*
 | 
						|
		*  render_field_settings()
 | 
						|
		*
 | 
						|
		*  Create extra options for your field. This is rendered when editing a field.
 | 
						|
		*  The value of $field['name'] can be used (like bellow) to save extra data to the $field
 | 
						|
		*
 | 
						|
		*  @type    action
 | 
						|
		*  @since   3.6
 | 
						|
		*  @date    23/01/13
 | 
						|
		*
 | 
						|
		*  @param   $field  - an array holding all the field's data
 | 
						|
		*/
 | 
						|
		function render_field_settings( $field ) {
 | 
						|
			$g_i_a = date_i18n( 'g:i a' );
 | 
						|
			$H_i_s = date_i18n( 'H:i:s' );
 | 
						|
 | 
						|
			echo '<div class="acf-field-settings-split">';
 | 
						|
 | 
						|
			acf_render_field_setting(
 | 
						|
				$field,
 | 
						|
				array(
 | 
						|
					'label'        => __( 'Display Format', 'acf' ),
 | 
						|
					'hint'         => __( 'The format displayed when editing a post', 'acf' ),
 | 
						|
					'type'         => 'radio',
 | 
						|
					'name'         => 'display_format',
 | 
						|
					'other_choice' => 1,
 | 
						|
					'choices'      => array(
 | 
						|
						'g:i a' => '<span>' . $g_i_a . '</span><code>g:i a</code>',
 | 
						|
						'H:i:s' => '<span>' . $H_i_s . '</span><code>H:i:s</code>',
 | 
						|
						'other' => '<span>' . __( 'Custom:', 'acf' ) . '</span>',
 | 
						|
					),
 | 
						|
				)
 | 
						|
			);
 | 
						|
 | 
						|
			acf_render_field_setting(
 | 
						|
				$field,
 | 
						|
				array(
 | 
						|
					'label'        => __( 'Return Format', 'acf' ),
 | 
						|
					'hint'         => __( 'The format returned via template functions', 'acf' ),
 | 
						|
					'type'         => 'radio',
 | 
						|
					'name'         => 'return_format',
 | 
						|
					'other_choice' => 1,
 | 
						|
					'choices'      => array(
 | 
						|
						'g:i a' => '<span>' . $g_i_a . '</span><code>g:i a</code>',
 | 
						|
						'H:i:s' => '<span>' . $H_i_s . '</span><code>H:i:s</code>',
 | 
						|
						'other' => '<span>' . __( 'Custom:', 'acf' ) . '</span>',
 | 
						|
					),
 | 
						|
				)
 | 
						|
			);
 | 
						|
 | 
						|
			echo '</div>';
 | 
						|
		}
 | 
						|
 | 
						|
		/*
 | 
						|
		*  format_value()
 | 
						|
		*
 | 
						|
		*  This filter is appied to the $value after it is loaded from the db and before it is returned to the template
 | 
						|
		*
 | 
						|
		*  @type    filter
 | 
						|
		*  @since   3.6
 | 
						|
		*  @date    23/01/13
 | 
						|
		*
 | 
						|
		*  @param   $value (mixed) the value which was loaded from the database
 | 
						|
		*  @param   $post_id (mixed) the $post_id from which the value was loaded
 | 
						|
		*  @param   $field (array) the field array holding all the field options
 | 
						|
		*
 | 
						|
		*  @return  $value (mixed) the modified value
 | 
						|
		*/
 | 
						|
 | 
						|
		function format_value( $value, $post_id, $field ) {
 | 
						|
 | 
						|
			return acf_format_date( $value, $field['return_format'] );
 | 
						|
 | 
						|
		}
 | 
						|
 | 
						|
		/**
 | 
						|
		 *  This filter is applied to the $field after it is loaded from the database
 | 
						|
		 *  and ensures the return and display values are set.
 | 
						|
		 *
 | 
						|
		 *  @type    filter
 | 
						|
		 *  @since   5.11.0
 | 
						|
		 *  @date    28/09/21
 | 
						|
		 *
 | 
						|
		 *  @param array $field The field array holding all the field options.
 | 
						|
		 *
 | 
						|
		 *  @return array
 | 
						|
		 */
 | 
						|
		function load_field( $field ) {
 | 
						|
			if ( empty( $field['display_format'] ) ) {
 | 
						|
				$field['display_format'] = $this->defaults['display_format'];
 | 
						|
			}
 | 
						|
 | 
						|
			if ( empty( $field['return_format'] ) ) {
 | 
						|
				$field['return_format'] = $this->defaults['return_format'];
 | 
						|
			}
 | 
						|
 | 
						|
			return $field;
 | 
						|
		}
 | 
						|
 | 
						|
		/**
 | 
						|
		 * Return the schema array for the REST API.
 | 
						|
		 *
 | 
						|
		 * @param array $field
 | 
						|
		 * @return array
 | 
						|
		 */
 | 
						|
		public function get_rest_schema( array $field ) {
 | 
						|
			return array(
 | 
						|
				'type'        => array( 'string', 'null' ),
 | 
						|
				'description' => 'A `H:i:s` formatted time string.',
 | 
						|
				'required'    => ! empty( $field['required'] ),
 | 
						|
			);
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
 | 
						|
	// initialize
 | 
						|
	acf_register_field_type( 'acf_field_time_picker' );
 | 
						|
 | 
						|
endif; // class_exists check
 | 
						|
 | 
						|
?>
 |