Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
ACF gallery field to display attachment_metadata for EXIF
<?php
/*
* ACF Gallery Field Class
*
* All the logic for this field type
*
* @class acf_field_gallery
* @extends acf_field
* @package ACF
* @subpackage Fields
*/
if( ! class_exists('acf_field_gallery') ) :
class acf_field_gallery 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 = 'gallery';
$this->label = __("Gallery",'acf');
$this->category = 'content';
$this->defaults = array(
'preview_size' => 'thumbnail',
'library' => 'all',
'min' => 0,
'max' => 0,
);
$this->l10n = array(
'select' => __("Add Image to Gallery",'acf'),
'edit' => __("Edit Image",'acf'),
'update' => __("Update Image",'acf'),
'uploadedTo' => __("uploaded to this post",'acf'),
'max' => __("Maximum selection reached",'acf'),
'tmpl' => '<div data-id="<%= id %>" class="acf-gallery-attachment acf-soh">
<input type="hidden" value="<%= id %>" name="<%= name %>[]">
<div class="padding">
<img alt="" src="<%= url %>">
</div>
<div class="actions acf-soh-target">
<a href="#" class="acf-icon dark remove-attachment" data-id="<%= id %>">
<i class="acf-sprite-delete"></i>
</a>
</div>
</div>'
);
// actions
add_action('wp_ajax_acf/fields/gallery/get_attachment', array($this, 'ajax_get_attachment'));
add_action('wp_ajax_nopriv_acf/fields/gallery/get_attachment', array($this, 'ajax_get_attachment'));
add_action('wp_ajax_acf/fields/gallery/update_attachment', array($this, 'ajax_update_attachment'));
add_action('wp_ajax_nopriv_acf/fields/gallery/update_attachment', array($this, 'ajax_update_attachment'));
add_action('wp_ajax_acf/fields/gallery/get_sort_order', array($this, 'ajax_get_sort_order'));
add_action('wp_ajax_nopriv_acf/fields/gallery/get_sort_order', array($this, 'ajax_get_sort_order'));
// do not delete!
parent::__construct();
}
/*
* ajax_get_attachment
*
* description
*
* @type function
* @date 13/12/2013
* @since 5.0.0
*
* @param $post_id (int)
* @return $post_id (int)
*/
function ajax_get_attachment() {
// options
$options = acf_parse_args( $_POST, array(
'post_id' => 0,
'id' => 0,
'field_key' => '',
'nonce' => '',
));
// validate
if( ! wp_verify_nonce($options['nonce'], 'acf_nonce') ) {
die();
}
if( empty($options['id']) ) {
die();
}
// load field
$field = acf_get_field( $options['field_key'] );
if( !$field ) {
die();
}
// render
$this->render_attachment( $options['id'], $field );
die;
}
/*
* ajax_update_attachment
*
* description
*
* @type function
* @date 13/12/2013
* @since 5.0.0
*
* @param $post_id (int)
* @return $post_id (int)
*/
function ajax_update_attachment() {
// validate
if( ! wp_verify_nonce($_REQUEST['nonce'], 'acf_nonce') ) {
wp_send_json_error();
}
if( empty($_REQUEST['attachments']) ) {
wp_send_json_error();
}
foreach( $_REQUEST['attachments'] as $id => $changes ) {
if ( ! current_user_can( 'edit_post', $id ) )
wp_send_json_error();
$post = get_post( $id, ARRAY_A );
if ( 'attachment' != $post['post_type'] )
wp_send_json_error();
if ( isset( $changes['title'] ) )
$post['post_title'] = $changes['title'];
if ( isset( $changes['caption'] ) )
$post['post_excerpt'] = $changes['caption'];
if ( isset( $changes['description'] ) )
$post['post_content'] = $changes['description'];
if ( isset( $changes['alt'] ) ) {
$alt = wp_unslash( $changes['alt'] );
if ( $alt != get_post_meta( $id, '_wp_attachment_image_alt', true ) ) {
$alt = wp_strip_all_tags( $alt, true );
update_post_meta( $id, '_wp_attachment_image_alt', wp_slash( $alt ) );
}
}
// save post
wp_update_post( $post );
// save meta
acf_save_post( $id );
}
wp_send_json_success();
}
/*
* ajax_get_sort_order
*
* description
*
* @type function
* @date 13/12/2013
* @since 5.0.0
*
* @param $post_id (int)
* @return $post_id (int)
*/
function ajax_get_sort_order() {
// vars
$r = array();
$order = 'DESC';
$args = acf_parse_args( $_POST, array(
'ids' => 0,
'sort' => 'date',
'field_key' => '',
'nonce' => '',
));
// validate
if( ! wp_verify_nonce($args['nonce'], 'acf_nonce') ) {
wp_send_json_error();
}
// reverse
if( $args['sort'] == 'reverse' ) {
$ids = array_reverse($args['ids']);
wp_send_json_success($ids);
}
if( $args['sort'] == 'title' ) {
$order = 'ASC';
}
// find attachments (DISTINCT POSTS)
$ids = get_posts(array(
'post_type' => 'attachment',
'numberposts' => -1,
'post_status' => 'any',
'post__in' => $args['ids'],
'order' => $order,
'orderby' => $args['sort'],
'fields' => 'ids'
));
// success
if( !empty($ids) ) {
wp_send_json_success($ids);
}
// failure
wp_send_json_error();
}
/*
* render_attachment
*
* description
*
* @type function
* @date 13/12/2013
* @since 5.0.0
*
* @param $post_id (int)
* @return $post_id (int)
*/
function render_attachment( $id = 0, $field ) {
$attachment = wp_prepare_attachment_for_js( $id );
$prefix = "attachments[{$id}]";
$compat = get_compat_media_markup( $id );
?>
<div class="acf-gallery-side-info acf-cf">
<img src="<?php echo $attachment['sizes']['thumbnail']['url']; ?>" alt="<?php echo $attachment['alt']; ?>" />
<p class="filename"><strong><?php _e('Attachment Details', 'acf'); ?></strong></p>
<p class="uploaded"><?php echo $attachment['dateFormatted']; ?></p>
<p class="dimensions"><?php echo $attachment['width']; ?> × <?php echo $attachment['height']; ?> </p>
<p class="actions"><a href="#" class="edit-attachment" data-id="<?php echo $id; ?>">Edit</a> <a href="#" class="remove-attachment" data-id="<?php echo $id; ?>">Remove</a></p>
</div>
<table class="form-table">
<tbody>
<?php
acf_render_field_wrap(array(
//'key' => "{$field['key']}-title",
'name' => 'title',
'prefix' => $prefix,
'type' => 'text',
'label' => 'Title',
'value' => $attachment['title']
), 'tr');
acf_render_field_wrap(array(
//'key' => "{$field['key']}-caption",
'name' => 'caption',
'prefix' => $prefix,
'type' => 'textarea',
'label' => 'Caption',
'value' => $attachment['caption']
), 'tr');
acf_render_field_wrap(array(
//'key' => "{$field['key']}-alt",
'name' => 'alt',
'prefix' => $prefix,
'type' => 'text',
'label' => 'Alt Text',
'value' => $attachment['alt']
), 'tr');
acf_render_field_wrap(array(
//'key' => "{$field['key']}-description",
'name' => 'description',
'prefix' => $prefix,
'type' => 'textarea',
'label' => 'Description',
'value' => $attachment['description']
), 'tr');
?>
</tbody>
</table>
<?php echo $compat['item']; ?>
<?php
}
/*
* 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
$atts = array(
'id' => $field['id'],
'class' => "acf-gallery {$field['class']}",
'data-preview_size' => $field['preview_size'],
'data-library' => $field['library'],
'data-min' => $field['min'],
'data-max' => $field['max'],
);
// vars
$height = acf_get_user_setting('gallery_height', 400);
$height = max( $height, 200 ); // minimum height is 200
$atts['style'] = "height:{$height}px";
?>
<div <?php acf_esc_attr_e($atts); ?>>
<div class="acf-hidden">
<input type="hidden" <?php acf_esc_attr_e(array( 'name' => $field['name'], 'value' => '', 'data-name' => 'ids' )); ?> />
</div>
<div class="acf-gallery-main">
<div class="acf-gallery-attachments">
<?php if( !empty($field['value']) ):
// force value to array
$field['value'] = acf_force_type_array( $field['value'] );
// convert values to int
$field['value'] = array_map('intval', $field['value']);
foreach( $field['value'] as $id ):
// vars
$mime_type = get_post_mime_type( $id );
$src = '';
if( strpos($mime_type, 'image') !== false )
{
$src = wp_get_attachment_image_src( $id, $field['preview_size'] );
$src = $src[0];
}
else
{
$src = wp_mime_type_icon( $id );
}
?>
<div class="acf-gallery-attachment acf-soh" data-id="<?php echo $id; ?>">
<input type="hidden" name="<?php echo $field['name']; ?>[]" value="<?php echo $id; ?>" />
<div class="padding">
<img src="<?php echo $src; ?>" alt="" />
</div>
<div class="actions acf-soh-target">
<a class="acf-icon dark remove-attachment" data-id="<?php echo $id; ?>" href="#">
<i class="acf-sprite-delete"></i>
</a>
</div>
</div>
<?php endforeach; ?>
<?php endif; ?>
</div>
<div class="acf-gallery-toolbar">
<ul class="acf-hl">
<li>
<a href="#" class="acf-button blue add-attachment"><?php _e('Add to gallery', 'acf'); ?></a>
</li>
<li class="acf-fr">
<select class="bulk-actions">
<option value=""><?php _e('Bulk actions', 'acf'); ?></option>
<option value="date"><?php _e('Sort by date uploaded', 'acf'); ?></option>
<option value="modified"><?php _e('Sort by date modified', 'acf'); ?></option>
<option value="title"><?php _e('Sort by title', 'acf'); ?></option>
<option value="reverse"><?php _e('Reverse current order', 'acf'); ?></option>
</select>
</li>
</ul>
</div>
</div>
<div class="acf-gallery-side">
<div class="acf-gallery-side-inner">
<div class="acf-gallery-side-data"></div>
<div class="acf-gallery-toolbar">
<ul class="acf-hl">
<li>
<a href="#" class="acf-button close-sidebar"><?php _e('Close', 'acf'); ?></a>
</li>
<li class="acf-fr">
<a class="acf-button blue update-attachment"><?php _e('Update', 'acf'); ?></a>
</li>
</ul>
</div>
</div>
</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 ) {
// min / max
$field['min'] = empty($field['min']) ? '' : $field['min'];
$field['max'] = empty($field['max']) ? '' : $field['max'];
// min
acf_render_field_setting( $field, array(
'label' => __('Minimum Selection','acf'),
'instructions' => '',
'type' => 'number',
'name' => 'min',
'placeholder' => '0',
));
// max
acf_render_field_setting( $field, array(
'label' => __('Maximum Selection','acf'),
'instructions' => '',
'type' => 'number',
'name' => 'max',
'placeholder' => '0',
));
// 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')
)
));
}
/*
* 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;
}
// force value to array
$value = acf_force_type_array( $value );
// convert values to int
$value = array_map('intval', $value);
// load posts in 1 query to save multiple DB calls from following code
$posts = get_posts(array(
'posts_per_page' => -1,
'post_type' => 'attachment',
'post_status' => 'any',
'post__in' => $value,
'orderby' => 'post__in'
));
foreach( $value as $k => $v ) {
// get post
$post = get_post( $v );
// create $attachment
$a = array(
'ID' => $post->ID,
'id' => $post->ID,
'alt' => get_post_meta($post->ID, '_wp_attachment_image_alt', true),
'title' => $post->post_title,
'caption' => $post->post_excerpt,
'description' => $post->post_content,
'mime_type' => $post->post_mime_type,
'type' => 'file',
'url' => ''
);
// image
if( strpos($a['mime_type'], 'image') !== false ) {
// type
$a['type'] = 'image';
// url
$src = wp_get_attachment_image_src( $a['ID'], 'full' );
$a['url'] = $src[0];
$a['width'] = $src[1];
$a['height'] = $src[2];
// find all image meta
$image_meta = wp_get_attachment_metadata($post->ID);
if( $image_meta ) {
$a['image_meta'] = array();
$a['image_meta']['aperture' ] = $image_meta[image_meta][aperture];
$a['image_meta']['credit' ] = $image_meta[image_meta][credit];
$a['image_meta']['camera' ] = $image_meta[image_meta][camera];
$a['image_meta']['caption' ] = $image_meta[image_meta][caption];
$a['image_meta']['created_timestamp' ] = $image_meta[image_meta][created_timestamp];
$a['image_meta']['copyright' ] = $image_meta[image_meta][copyright];
$a['image_meta']['focal_length' ] = $image_meta[image_meta][focal_length];
$a['image_meta']['iso' ] = $image_meta[image_meta][iso];
$a['image_meta']['shutter_speed' ] = $image_meta[image_meta][shutter_speed];
$a['image_meta']['title' ] = $image_meta[image_meta][title];
$a['image_meta']['orientation' ] = $image_meta[image_meta][orientation];
}
// find all image sizes
$sizes = get_intermediate_image_sizes();
// sizes
if( !empty($sizes) ) {
$a['sizes'] = array();
foreach( $sizes as $size ) {
// url
$src = wp_get_attachment_image_src( $a['ID'], $size );
// add src
$a['sizes'][ $size ] = $src[0];
$a['sizes'][ $size . '-width' ] = $src[1];
$a['sizes'][ $size . '-height' ] = $src[2];
}
// foreach
}
// if
} else {
// is file
$src = wp_get_attachment_url( $a['ID'] );
$a['url'] = $src;
}
$value[ $k ] = $a;
}
// foreach
// return
return $value;
}
/*
* validate_value
*
* description
*
* @type function
* @date 11/02/2014
* @since 5.0.0
*
* @param $post_id (int)
* @return $post_id (int)
*/
function validate_value( $valid, $value, $field, $input ){
if( empty($value) || !is_array($value) ) {
$value = array();
}
if( count($value) < $field['min'] ) {
$valid = _n( '%s requires at least %s selection', '%s requires at least %s selections', $field['min'], 'acf' );
$valid = sprintf( $valid, $field['label'], $field['min'] );
}
return $valid;
}
}
new acf_field_gallery();
endif;
?>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment