/wp-content/plugins/advanced-custom-fields-pro/fields/image.php
PHP | 514 lines | 236 code | 125 blank | 153 comment | 27 complexity | d00bcfb171d0ff87ee0e0f53f8f57b68 MD5 | raw file
- <?php
- /*
- * ACF Image Field Class
- *
- * All the logic for this field type
- *
- * @class acf_field_image
- * @extends acf_field
- * @package ACF
- * @subpackage Fields
- */
- if( ! class_exists('acf_field_image') ) :
- class acf_field_image 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 __construct() {
-
- // vars
- $this->name = 'image';
- $this->label = __("Image",'acf');
- $this->category = 'content';
- $this->defaults = array(
- 'return_format' => 'array',
- 'preview_size' => 'thumbnail',
- 'library' => 'all',
- 'min_width' => 0,
- 'min_height' => 0,
- 'min_size' => 0,
- 'max_width' => 0,
- 'max_height' => 0,
- 'max_size' => 0,
- 'mime_types' => ''
- );
- $this->l10n = array(
- 'select' => __("Select Image",'acf'),
- 'edit' => __("Edit Image",'acf'),
- 'update' => __("Update Image",'acf'),
- 'uploadedTo' => __("Uploaded to this post",'acf'),
- 'all' => __("All images",'acf'),
- );
-
-
- // filters
- add_filter('get_media_item_args', array($this, 'get_media_item_args'));
- add_filter('wp_prepare_attachment_for_js', array($this, 'wp_prepare_attachment_for_js'), 10, 3);
-
-
- // do not delete!
- parent::__construct();
-
- }
-
-
- /*
- * 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 ) {
-
- // enqueue
- acf_enqueue_uploader();
-
-
- // vars
- $div = array(
- 'class' => 'acf-image-uploader acf-cf',
- 'data-preview_size' => $field['preview_size'],
- 'data-library' => $field['library'],
- 'data-mime_types' => $field['mime_types']
- );
-
- $url = '';
-
-
- // has value?
- if( $field['value'] && is_numeric($field['value']) ) {
-
- $url = wp_get_attachment_image_src($field['value'], $field['preview_size']);
-
- if( $url ) {
-
- $url = $url[0];
-
- $div['class'] .= ' has-value';
-
- }
-
- }
-
-
- // uploader
- $uploader = acf_get_setting('uploader');
-
- if( $uploader == 'basic' ) {
-
- $div['class'] .= ' basic';
-
- }
-
- ?>
- <div <?php acf_esc_attr_e( $div ); ?>>
- <div class="acf-hidden">
- <?php acf_hidden_input(array( 'name' => $field['name'], 'value' => $field['value'], 'data-name' => 'id' )); ?>
- </div>
- <div class="view show-if-value acf-soh">
- <img data-name="image" src="<?php echo $url; ?>" alt=""/>
- <ul class="acf-hl acf-soh-target">
- <?php if( $uploader != 'basic' ): ?>
- <li><a class="acf-icon dark" data-name="edit" href="#"><i class="acf-sprite-edit"></i></a></li>
- <?php endif; ?>
- <li><a class="acf-icon dark" data-name="remove" href="#"><i class="acf-sprite-delete"></i></a></li>
- </ul>
- </div>
- <div class="view hide-if-value">
- <?php if( $uploader == 'basic' ): ?>
-
- <?php if( $field['value'] && !is_numeric($field['value']) ): ?>
- <div class="acf-error-message"><p><?php echo $field['value']; ?></p></div>
- <?php endif; ?>
-
- <input type="file" name="<?php echo $field['name']; ?>" id="<?php echo $field['id']; ?>" />
-
- <?php else: ?>
-
- <p style="margin:0;"><?php _e('No image selected','acf'); ?> <a data-name="add" class="acf-button" href="#"><?php _e('Add Image','acf'); ?></a></p>
-
- <?php endif; ?>
- </div>
- </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 ) {
-
- // clear numeric settings
- $clear = array(
- 'min_width',
- 'min_height',
- 'min_size',
- 'max_width',
- 'max_height',
- 'max_size'
- );
-
- foreach( $clear as $k ) {
-
- if( empty($field[$k]) ) {
-
- $field[$k] = '';
-
- }
-
- }
-
-
- // return_format
- acf_render_field_setting( $field, array(
- 'label' => __('Return Value','acf'),
- 'instructions' => __('Specify the returned value on front end','acf'),
- 'type' => 'radio',
- 'name' => 'return_format',
- 'layout' => 'horizontal',
- 'choices' => array(
- 'array' => __("Image Array",'acf'),
- 'url' => __("Image URL",'acf'),
- 'id' => __("Image ID",'acf')
- )
- ));
-
-
- // preview_size
- acf_render_field_setting( $field, array(
- 'label' => __('Preview Size','acf'),
- 'instructions' => __('Shown when entering data','acf'),
- 'type' => 'select',
- 'name' => 'preview_size',
- 'choices' => acf_get_image_sizes()
- ));
-
-
- // library
- acf_render_field_setting( $field, array(
- 'label' => __('Library','acf'),
- 'instructions' => __('Limit the media library choice','acf'),
- 'type' => 'radio',
- 'name' => 'library',
- 'layout' => 'horizontal',
- 'choices' => array(
- 'all' => __('All', 'acf'),
- 'uploadedTo' => __('Uploaded to post', 'acf')
- )
- ));
-
-
- // min
- acf_render_field_setting( $field, array(
- 'label' => __('Minimum','acf'),
- 'instructions' => __('Restrict which images can be uploaded','acf'),
- 'type' => 'text',
- 'name' => 'min_width',
- 'prepend' => __('Width', 'acf'),
- 'append' => 'px',
- ));
-
- acf_render_field_setting( $field, array(
- 'label' => '',
- 'type' => 'text',
- 'name' => 'min_height',
- 'prepend' => __('Height', 'acf'),
- 'append' => 'px',
- 'wrapper' => array(
- 'data-append' => 'min_width'
- )
- ));
-
- acf_render_field_setting( $field, array(
- 'label' => '',
- 'type' => 'text',
- 'name' => 'min_size',
- 'prepend' => __('File size', 'acf'),
- 'append' => 'MB',
- 'wrapper' => array(
- 'data-append' => 'min_width'
- )
- ));
-
-
- // max
- acf_render_field_setting( $field, array(
- 'label' => __('Maximum','acf'),
- 'instructions' => __('Restrict which images can be uploaded','acf'),
- 'type' => 'text',
- 'name' => 'max_width',
- 'prepend' => __('Width', 'acf'),
- 'append' => 'px',
- ));
-
- acf_render_field_setting( $field, array(
- 'label' => '',
- 'type' => 'text',
- 'name' => 'max_height',
- 'prepend' => __('Height', 'acf'),
- 'append' => 'px',
- 'wrapper' => array(
- 'data-append' => 'max_width'
- )
- ));
-
- acf_render_field_setting( $field, array(
- 'label' => '',
- 'type' => 'text',
- 'name' => 'max_size',
- 'prepend' => __('File size', 'acf'),
- 'append' => 'MB',
- 'wrapper' => array(
- 'data-append' => 'max_width'
- )
- ));
-
-
- // allowed type
- acf_render_field_setting( $field, array(
- 'label' => __('Allowed file types','acf'),
- 'instructions' => __('Comma separated list. Leave blank for all types','acf'),
- 'type' => 'text',
- 'name' => 'mime_types',
- ));
-
- }
-
-
- /*
- * 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 ) {
-
- // bail early if no value
- if( empty($value) ) {
-
- return $value;
-
- }
-
-
- // convert to int
- $value = intval($value);
-
-
- // format
- if( $field['return_format'] == 'url' ) {
-
- return wp_get_attachment_url( $value );
-
- } elseif( $field['return_format'] == 'array' ) {
-
- return acf_get_attachment( $value );
-
- }
-
- return $value;
-
- }
-
-
- /*
- * get_media_item_args
- *
- * description
- *
- * @type function
- * @date 27/01/13
- * @since 3.6.0
- *
- * @param $vars (array)
- * @return $vars
- */
-
- function get_media_item_args( $vars ) {
-
- $vars['send'] = true;
- return($vars);
-
- }
-
-
- /*
- * image_size_names_choose
- *
- * @description:
- * @since: 3.5.7
- * @created: 13/01/13
- */
-
- /*
- function image_size_names_choose( $sizes )
- {
- global $_wp_additional_image_sizes;
-
- if( $_wp_additional_image_sizes )
- {
- foreach( $_wp_additional_image_sizes as $k => $v )
- {
- $title = $k;
- $title = str_replace('-', ' ', $title);
- $title = str_replace('_', ' ', $title);
- $title = ucwords( $title );
-
- $sizes[ $k ] = $title;
- }
- // foreach( $image_sizes as $image_size )
- }
-
- return $sizes;
- }
- */
-
-
- /*
- * wp_prepare_attachment_for_js
- *
- * this filter allows ACF to add in extra data to an attachment JS object
- * This sneaky hook adds the missing sizes to each attachment in the 3.5 uploader.
- * It would be a lot easier to add all the sizes to the 'image_size_names_choose' filter but
- * then it will show up on the normal the_content editor
- *
- * @type function
- * @since: 3.5.7
- * @date 13/01/13
- *
- * @param {int} $post_id
- * @return {int} $post_id
- */
-
- function wp_prepare_attachment_for_js( $response, $attachment, $meta ) {
-
- // only for image
- if( $response['type'] != 'image' ) {
-
- return $response;
-
- }
-
-
- // make sure sizes exist. Perhaps they dont?
- if( !isset($meta['sizes']) ) {
-
- return $response;
-
- }
-
-
- $attachment_url = $response['url'];
- $base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
-
- if( isset($meta['sizes']) && is_array($meta['sizes']) ) {
-
- foreach( $meta['sizes'] as $k => $v ) {
-
- if( !isset($response['sizes'][ $k ]) ) {
-
- $response['sizes'][ $k ] = array(
- 'height' => $v['height'],
- 'width' => $v['width'],
- 'url' => $base_url . $v['file'],
- 'orientation' => $v['height'] > $v['width'] ? 'portrait' : 'landscape',
- );
- }
-
- }
-
- }
- return $response;
- }
-
-
- /*
- * 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 ) {
-
- // array?
- if( is_array($value) && isset($value['ID']) ) {
-
- return $value['ID'];
-
- }
-
-
- // object?
- if( is_object($value) && isset($value->ID) ) {
-
- return $value->ID;
-
- }
-
-
- // return
- return $value;
- }
-
-
- }
- new acf_field_image();
- endif;
- ?>