acf_field_select{}ACF 1.0

Хуков нет.

Использование

$acf_field_select = new acf_field_select();
// use class methods

Методы

  1. public ajax_query()
  2. public format_value( $value, $post_id, $field )
  3. public format_value_single( $value, $post_id, $field )
  4. public get_ajax_query( $options = array() )
  5. public initialize()
  6. public input_admin_enqueue_scripts()
  7. public load_value( $value, $post_id, $field )
  8. public render_field( $field )
  9. public render_field_settings( $field )
  10. public translate_field( $field )
  11. public update_field( $field )
  12. public update_value( $value, $post_id, $field )

Код acf_field_select{} ACF 5.10.2

class acf_field_select 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     = 'select';
		$this->label    = _x( 'Select', 'noun', 'acf' );
		$this->category = 'choice';
		$this->defaults = array(
			'multiple'      => 0,
			'allow_null'    => 0,
			'choices'       => array(),
			'default_value' => '',
			'ui'            => 0,
			'ajax'          => 0,
			'placeholder'   => '',
			'return_format' => 'value',
		);

		// ajax
		add_action( 'wp_ajax_acf/fields/select/query', array( $this, 'ajax_query' ) );
		add_action( 'wp_ajax_nopriv_acf/fields/select/query', array( $this, 'ajax_query' ) );

	}


	/*
	*  input_admin_enqueue_scripts
	*
	*  description
	*
	*  @type    function
	*  @date    16/12/2015
	*  @since   5.3.2
	*
	*  @param   $post_id (int)
	*  @return  $post_id (int)
	*/

	function input_admin_enqueue_scripts() {

		// bail ealry if no enqueue
		if ( ! acf_get_setting( 'enqueue_select2' ) ) {
			return;
		}

		// globals
		global $wp_scripts, $wp_styles;

		// vars
		$min     = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
		$major   = acf_get_setting( 'select2_version' );
		$version = '';
		$script  = '';
		$style   = '';

		// attempt to find 3rd party Select2 version
		// - avoid including v3 CSS when v4 JS is already enququed
		if ( isset( $wp_scripts->registered['select2'] ) ) {

			$major = (int) $wp_scripts->registered['select2']->ver;

		}

		// v4
		if ( $major == 4 ) {

			$version = '4.0';
			$script  = acf_get_url( "assets/inc/select2/4/select2.full{$min}.js" );
			$style   = acf_get_url( "assets/inc/select2/4/select2{$min}.css" );

			// v3
		} else {

			$version = '3.5.2';
			$script  = acf_get_url( "assets/inc/select2/3/select2{$min}.js" );
			$style   = acf_get_url( 'assets/inc/select2/3/select2.css' );

		}

		// enqueue
		wp_enqueue_script( 'select2', $script, array( 'jquery' ), $version );
		wp_enqueue_style( 'select2', $style, '', $version );

		// localize
		acf_localize_data(
			array(
				'select2L10n' => array(
					'matches_1'            => _x( 'One result is available, press enter to select it.', 'Select2 JS matches_1', 'acf' ),
					'matches_n'            => _x( '%d results are available, use up and down arrow keys to navigate.', 'Select2 JS matches_n', 'acf' ),
					'matches_0'            => _x( 'No matches found', 'Select2 JS matches_0', 'acf' ),
					'input_too_short_1'    => _x( 'Please enter 1 or more characters', 'Select2 JS input_too_short_1', 'acf' ),
					'input_too_short_n'    => _x( 'Please enter %d or more characters', 'Select2 JS input_too_short_n', 'acf' ),
					'input_too_long_1'     => _x( 'Please delete 1 character', 'Select2 JS input_too_long_1', 'acf' ),
					'input_too_long_n'     => _x( 'Please delete %d characters', 'Select2 JS input_too_long_n', 'acf' ),
					'selection_too_long_1' => _x( 'You can only select 1 item', 'Select2 JS selection_too_long_1', 'acf' ),
					'selection_too_long_n' => _x( 'You can only select %d items', 'Select2 JS selection_too_long_n', 'acf' ),
					'load_more'            => _x( 'Loading more results…', 'Select2 JS load_more', 'acf' ),
					'searching'            => _x( 'Searching…', 'Select2 JS searching', 'acf' ),
					'load_fail'            => _x( 'Loading failed', 'Select2 JS load_fail', 'acf' ),
				),
			)
		);
	}


	/*
	*  ajax_query
	*
	*  description
	*
	*  @type    function
	*  @date    24/10/13
	*  @since   5.0.0
	*
	*  @param   $post_id (int)
	*  @return  $post_id (int)
	*/

	function ajax_query() {

		// validate
		if ( ! acf_verify_ajax() ) {
			die();
		}

		// get choices
		$response = $this->get_ajax_query( $_POST );

		// return
		acf_send_ajax_results( $response );

	}


	/*
	*  get_ajax_query
	*
	*  This function will return an array of data formatted for use in a select2 AJAX response
	*
	*  @type    function
	*  @date    15/10/2014
	*  @since   5.0.9
	*
	*  @param   $options (array)
	*  @return  (array)
	*/

	function get_ajax_query( $options = array() ) {

		// defaults
		$options = acf_parse_args(
			$options,
			array(
				'post_id'   => 0,
				's'         => '',
				'field_key' => '',
				'paged'     => 1,
			)
		);

		// load field
		$field = acf_get_field( $options['field_key'] );
		if ( ! $field ) {
			return false;
		}

		// get choices
		$choices = acf_get_array( $field['choices'] );
		if ( empty( $field['choices'] ) ) {
			return false;
		}

		// vars
		$results = array();
		$s       = null;

		// search
		if ( $options['s'] !== '' ) {

			// strip slashes (search may be integer)
			$s = strval( $options['s'] );
			$s = wp_unslash( $s );

		}

		// loop
		foreach ( $field['choices'] as $k => $v ) {

			// ensure $v is a string
			$v = strval( $v );

			// if searching, but doesn't exist
			if ( is_string( $s ) && stripos( $v, $s ) === false ) {
				continue;
			}

			// append
			$results[] = array(
				'id'   => $k,
				'text' => $v,
			);

		}

		// vars
		$response = array(
			'results' => $results,
		);

		// return
		return $response;

	}


	/*
	*  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 ) {

		// convert
		$value   = acf_get_array( $field['value'] );
		$choices = acf_get_array( $field['choices'] );

		// placeholder
		if ( empty( $field['placeholder'] ) ) {
			$field['placeholder'] = _x( 'Select', 'verb', 'acf' );
		}

		// add empty value (allows '' to be selected)
		if ( empty( $value ) ) {
			$value = array( '' );
		}

		// prepend empty choice
		// - only for single selects
		// - have tried array_merge but this causes keys to re-index if is numeric (post ID's)
		if ( $field['allow_null'] && ! $field['multiple'] ) {
			$choices = array( '' => "- {$field['placeholder']} -" ) + $choices;
		}

		// clean up choices if using ajax
		if ( $field['ui'] && $field['ajax'] ) {
			$minimal = array();
			foreach ( $value as $key ) {
				if ( isset( $choices[ $key ] ) ) {
					$minimal[ $key ] = $choices[ $key ];
				}
			}
			$choices = $minimal;
		}

		// vars
		$select = array(
			'id'               => $field['id'],
			'class'            => $field['class'],
			'name'             => $field['name'],
			'data-ui'          => $field['ui'],
			'data-ajax'        => $field['ajax'],
			'data-multiple'    => $field['multiple'],
			'data-placeholder' => $field['placeholder'],
			'data-allow_null'  => $field['allow_null'],
		);

		// multiple
		if ( $field['multiple'] ) {

			$select['multiple'] = 'multiple';
			$select['size']     = 5;
			$select['name']    .= '[]';

			// Reduce size to single line if UI.
			if ( $field['ui'] ) {
				$select['size'] = 1;
			}
		}

		// special atts
		if ( ! empty( $field['readonly'] ) ) {
			$select['readonly'] = 'readonly';
		}
		if ( ! empty( $field['disabled'] ) ) {
			$select['disabled'] = 'disabled';
		}
		if ( ! empty( $field['ajax_action'] ) ) {
			$select['data-ajax_action'] = $field['ajax_action'];
		}

		// hidden input is needed to allow validation to see <select> element with no selected value
		if ( $field['multiple'] || $field['ui'] ) {
			acf_hidden_input(
				array(
					'id'   => $field['id'] . '-input',
					'name' => $field['name'],
				)
			);
		}

		// append
		$select['value']   = $value;
		$select['choices'] = $choices;

		// render
		acf_select_input( $select );

	}


	/*
	*  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 ) {

		// encode choices (convert from array)
		$field['choices']       = acf_encode_choices( $field['choices'] );
		$field['default_value'] = acf_encode_choices( $field['default_value'], false );

		// choices
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Choices', 'acf' ),
				'instructions' => __( 'Enter each choice on a new line.', 'acf' ) . '<br /><br />' . __( 'For more control, you may specify both a value and label like this:', 'acf' ) . '<br /><br />' . __( 'red : Red', 'acf' ),
				'name'         => 'choices',
				'type'         => 'textarea',
			)
		);

		// default_value
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Default Value', 'acf' ),
				'instructions' => __( 'Enter each default value on a new line', 'acf' ),
				'name'         => 'default_value',
				'type'         => 'textarea',
			)
		);

		// allow_null
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Allow Null?', 'acf' ),
				'instructions' => '',
				'name'         => 'allow_null',
				'type'         => 'true_false',
				'ui'           => 1,
			)
		);

		// multiple
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Select multiple values?', 'acf' ),
				'instructions' => '',
				'name'         => 'multiple',
				'type'         => 'true_false',
				'ui'           => 1,
			)
		);

		// ui
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Stylised UI', 'acf' ),
				'instructions' => '',
				'name'         => 'ui',
				'type'         => 'true_false',
				'ui'           => 1,
			)
		);

		// ajax
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Use AJAX to lazy load choices?', 'acf' ),
				'instructions' => '',
				'name'         => 'ajax',
				'type'         => 'true_false',
				'ui'           => 1,
				'conditions'   => array(
					'field'    => 'ui',
					'operator' => '==',
					'value'    => 1,
				),
			)
		);

		// return_format
		acf_render_field_setting(
			$field,
			array(
				'label'        => __( 'Return Format', 'acf' ),
				'instructions' => __( 'Specify the value returned', 'acf' ),
				'type'         => 'select',
				'name'         => 'return_format',
				'choices'      => array(
					'value' => __( 'Value', 'acf' ),
					'label' => __( 'Label', 'acf' ),
					'array' => __( 'Both (Array)', 'acf' ),
				),
			)
		);

	}


	/*
	*  load_value()
	*
	*  This filter is applied to the $value after it is loaded from the db
	*
	*  @type    filter
	*  @since   3.6
	*  @date    23/01/13
	*
	*  @param   $value (mixed) the value found in 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
	*/
	function load_value( $value, $post_id, $field ) {

		// Return an array when field is set for multiple.
		if ( $field['multiple'] ) {
			if ( acf_is_empty( $value ) ) {
				return array();
			}
			return acf_array( $value );
		}

		// Otherwise, return a single value.
		return acf_unarray( $value );
	}


	/*
	*  update_field()
	*
	*  This filter is appied to the $field before it is saved to the database
	*
	*  @type    filter
	*  @since   3.6
	*  @date    23/01/13
	*
	*  @param   $field - the field array holding all the field options
	*  @param   $post_id - the field group ID (post_type = acf)
	*
	*  @return  $field - the modified field
	*/

	function update_field( $field ) {

		// decode choices (convert to array)
		$field['choices']       = acf_decode_choices( $field['choices'] );
		$field['default_value'] = acf_decode_choices( $field['default_value'], true );

		// Convert back to string for single selects.
		if ( ! $field['multiple'] ) {
			$field['default_value'] = acf_unarray( $field['default_value'] );
		}

		// return
		return $field;
	}


	/*
	*  update_value()
	*
	*  This filter is appied to the $value before it is updated in the db
	*
	*  @type    filter
	*  @since   3.6
	*  @date    23/01/13
	*
	*  @param   $value - the value which will be saved in the database
	*  @param   $post_id - the $post_id of which the value will be saved
	*  @param   $field - the field array holding all the field options
	*
	*  @return  $value - the modified value
	*/

	function update_value( $value, $post_id, $field ) {

		// Bail early if no value.
		if ( empty( $value ) ) {
			return $value;
		}

		// Format array of values.
		// - Parse each value as string for SQL LIKE queries.
		if ( is_array( $value ) ) {
			$value = array_map( 'strval', $value );
		}

		// return
		return $value;
	}


	/*
	*  translate_field
	*
	*  This function will translate field settings
	*
	*  @type    function
	*  @date    8/03/2016
	*  @since   5.3.2
	*
	*  @param   $field (array)
	*  @return  $field
	*/

	function translate_field( $field ) {

		// translate
		$field['choices'] = acf_translate( $field['choices'] );

		// return
		return $field;

	}


	/*
	*  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 ) {
		if ( is_array( $value ) ) {
			foreach ( $value as $i => $val ) {
				$value[ $i ] = $this->format_value_single( $val, $post_id, $field );
			}
		} else {
			$value = $this->format_value_single( $value, $post_id, $field );
		}
		return $value;
	}


	function format_value_single( $value, $post_id, $field ) {

		// bail ealry if is empty
		if ( acf_is_empty( $value ) ) {
			return $value;
		}

		// vars
		$label = acf_maybe_get( $field['choices'], $value, $value );

		// value
		if ( $field['return_format'] == 'value' ) {

			// do nothing

			// label
		} elseif ( $field['return_format'] == 'label' ) {

			$value = $label;

			// array
		} elseif ( $field['return_format'] == 'array' ) {

			$value = array(
				'value' => $value,
				'label' => $label,
			);

		}

		// return
		return $value;

	}

}