class-reorder-entry-images.php

<?php
/**
 * Reorder Entry images
 *
 * @package   ReorderEntryImages
 * @author    Vayu Robins <v@vayu.dk>
 * @license   GPL-2.0+
 * @link      http://vayu.dk/reorder-entry-images/
 * @copyright 2013 Vayu Robins
 */

/**
 * Plugin class.
 *
 * @package ReorderEntryImages
 * @author  Vayu Robins <v@vayu.dk>
 */
class ReorderEntryImages {

	/**
	 * Plugin version, used for cache-busting of style and script file references.
	 *
	 * @since   1.0.0
	 *
	 * @var     string
	 */
	protected $version = '1.0.8';
	

	/**
	* Unique identifier for your plugin.
	*
	* Use this value (not the variable name) as the text domain when internationalizing strings of text. It should
	* match the Text Domain file header in the main plugin file.
	*
	* @since 1.0.0
	*
	* @var string
	*/
	protected $plugin_slug = 'reorder-entry-images';

	/**
	 * Instance of this class.
	 *
	 * @since    1.0.0
	 *
	 * @var      object
	 */
	protected static $instance = null;

	/**
	* Slug of the plugin screen.
	*
	* @since 1.0.0
	*
	* @var string
	*/
	protected $plugin_screen_hook_suffix = 'reorder-entry-images';

	/**
	 * Entry type to add the metabox to.
	 *
	 * @since    1.0.0
	 *
	 * @var      string
	 */
	protected $the_post_type = array();

	/**
	 * Initialize the plugin by setting localization, filters, and administration functions.
	 *
	 * @since     1.0.0
	 */
	private function __construct() {

		if( is_admin() ) :
			// Load plugin text domain
			add_action( 'init', array( $this, 'load_plugin_textdomain' ) );

			// Add the options page and menu item.
			add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );

			// Register plugin settings.
			add_action( 'admin_init', array( $this, 'register_plugin_settings' ) );

			// Load admin style sheet and JavaScript.
			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_styles' ) );
			add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_admin_scripts' ) );

			// Get the post type from options settings and save in variable
			$this->the_post_type = is_array( get_option( 'rei-options' ) ) ? get_option( 'rei-options' ) : $this->the_post_type;

			// Add metabox on the proper metabox hook
			if( is_array( $this->the_post_type ) ) {
				foreach ( $this->the_post_type as $type ) {
					add_action( 'add_meta_boxes_' . $type, array( $this, 'add_image_sortable_box' ) );
				}
			}

			// Updates the attachments when saving
			add_filter( 'wp_insert_post_data', array( $this, 'sort_images_meta_save' ), 99, 2 );

			// This function is called with ajax, to get the products under the chosen category and display them in the form.
			add_action( 'wp_ajax_delete_attachment', array( $this, 'delete_attachment' ) );


		endif;

		// Add list attached images shortcode
		add_shortcode( 'list_attached_images', array( $this, 'list_attached_images_shortcode' ) );
	}


	/**
	 * Return an instance of this class.
	 *
	 * @since     1.0.0
	 *
	 * @return    object    A single instance of this class.
	 */
	public static function get_instance() {

		// If the single instance hasn't been set, set it now.
		if ( null == self::$instance ) {
			self::$instance = new self;
		}

		return self::$instance;
	}

	/**
	 * Fired when the plugin is activated.
	 *
	 * @since    1.0.0
	 *
	 * @param    boolean    $network_wide    True if WPMU superadmin uses "Network Activate" action, false if WPMU is disabled or plugin is activated on an individual blog.
	 */
	public static function activate( $network_wide ) {
		if ( ! current_user_can( 'activate_plugins' ) ) { return; }

		$plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
		check_admin_referer( "activate-plugin_{$plugin}" );
	}

	/**
	 * Fired when the plugin is deactivated.
	 *
	 * @since    1.0.0
	 *
	 * @param    boolean    $network_wide    True if WPMU superadmin uses "Network Deactivate" action, false if WPMU is disabled or plugin is deactivated on an individual blog.
	 */
	public static function deactivate( $network_wide ) {
		if ( ! current_user_can( 'activate_plugins' ) ) { return; }

		$plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';
		check_admin_referer( "deactivate-plugin_{$plugin}" );
	}

	/**
	 * Load the plugin text domain for translation.
	 *
	 * @since    1.0.0
	 */
	public function load_plugin_textdomain() {

		$domain = $this->plugin_slug;
		$locale = apply_filters( 'plugin_locale', get_locale(), $domain );

		load_textdomain( $domain, WP_LANG_DIR . '/' . $domain . '/' . $domain . '-' . $locale . '.mo' );
		load_plugin_textdomain( $domain, FALSE, dirname( plugin_basename( __FILE__ ) ) . '/lang/' );
	}

	/**
	 * Register and enqueue admin-specific style sheet.
	 *
	 * @since     1.0.0
	 *
	 * @return    null    Return early if no settings page is registered.
	 */
	public function enqueue_admin_styles() {

		$screen = get_current_screen();

		if ( in_array( $screen->id, $this->the_post_type ) ) {
			wp_enqueue_style( $this->plugin_slug .'-admin-styles', plugins_url( 'css/admin.css', __FILE__ ), array(), $this->version );
		}

	}

	/**
	 * Register and enqueue admin-specific JavaScript.
	 *
	 * @since    1.0.0
	 *
	 * @return   null    Return early if no settings page is registered.
	 */
	public function enqueue_admin_scripts() {

		$screen = get_current_screen();
		if ( in_array( $screen->id, $this->the_post_type ) ) {
			wp_enqueue_script( $this->plugin_slug . '-admin-script', plugins_url( 'js/admin.js', __FILE__ ), array( 'jquery' ), $this->version );
		}

	}

	/**
	* Register the administration menu for this plugin into the WordPress Dashboard menu.
	*
	* @since 1.0.0
	*/
	public function add_plugin_admin_menu() {
		$this->pagehook = add_options_page(
			__( 'Reorder entry images', $this->plugin_slug ),
			__( 'Reorder images', $this->plugin_slug ),
			'manage_options',
			$this->plugin_slug,
			array( $this, 'display_plugin_admin_page' )
		);
	}

	/**
	* Render the settings page for this plugin.
	*
	* @since 1.0.0
	*/
	public function display_plugin_admin_page() {
		include_once( 'views/admin.php' );
	}

	/**
	 * Register plugin settings
	 *
	 * @since     1.0.0
	 */
	public function register_plugin_settings() {

		register_setting( 'rei_the_settings_group', 'rei-options' );

		add_settings_section(
			'rei-section-general-options',
			__( 'Post type', 'reorder-entry-images' ),
			array( $this, 'rei_general_settings_callback'),
			$this->plugin_slug
		);

		add_settings_field(
			'rei-posttype',
			__( 'Post type', 'reorder-entry-images' ),
			array( $this, 'rei_option_posttype'),
			$this->plugin_slug,
			'rei-section-general-options'
		);

		add_settings_field( 
			'rei-feature-image',
			__( 'Feature image', 'reorder-entry-images' ),
			array( $this, 'rei_option_feature_image'),
			$this->plugin_slug,
			'rei-section-general-options'
		);
	}

	/**
	* Render the settings section page for this plugin.
	*
	* @since 1.0.0
	*/
	public function rei_general_settings_callback() {
		_e( 'Choose which post type you would like to use the reorder images functionality.', 'reorder-entry-images' );
	}

	/**
	* Render the settings posttype field for this plugin.
	*
	* @since 1.0.0
	*/
	public function rei_option_posttype() {

		$settings = (array) get_option( 'rei-options' );
		foreach( self::getObjectTypes() as $type ) {
			if( $type->name != 'attachment' ) {
				echo '<label class="inline"><input type="checkbox" name="rei-options['.$type->name.']" value="'.esc_attr($type->name).'" '.checked( $type->name, isset( $settings[$type->name] ) ? $settings[$type->name] : 0, false ).' /> '.esc_html($type->label).'</label>';
			}
		}
		?>
		<span class="description"><?php _e( 'You can use this builtin-in or custom post types.', 'reorder-entry-images' ); ?></span>
		<?php
	}

	/**
	* Render the settings feature image field for this plugin.
	*
	* @since 1.0.4
	*/
	public function rei_option_feature_image() {

		$settings = (array) get_option( 'rei-options' );
		echo '<label class="inline"><input type="checkbox" name="rei-options[feature-image]" value="true" '.checked( 'true', $settings['feature-image'], false ).' />'.__( 'Yes, include feature image', 'reorder-entry-images' ).'</label>';
		
		?>
		<span class="description"><?php _e( 'Include/exclude feature image in the sort order list.', 'reorder-entry-images' ); ?></span>
		<?php
	}


	/**
	 * Add a custom metabox to post, page or cpt, that displays the attachments in a list.
	 *
	 * @since   1.0.0
	 */
	public function add_image_sortable_box() {

		$images = get_children(
			array(
				'post_parent' => get_the_ID(),
				'post_type' => 'attachment',
				'post_mime_type' => 'image'
			)
		);
		if ( $images ) {
			if( is_array( $this->the_post_type ) ) {
				foreach( $this->the_post_type as $type ) {
					add_meta_box(
						'sort-entry-images',
						__( 'Reorder images with drag & drop', 'reorder-entry-images' ),
						array( $this, 'add_image_metabox_sorter' ),
						$type,
						'normal',
						'default'
					);
				}
			}
		}
	}

	/**
	 * Gets all attachments and displays them in a sortable list on admin pages.
	 *
	 * @param 	array|object 	$p
	 * @since   1.0.0
	 */
	public function add_image_metabox_sorter( $p ) {

		$settings = (array) get_option( 'rei-options' );
		$thumb_id = $settings['feature-image'] ? 0 : get_post_thumbnail_id( get_the_ID() );

		$args = array(
			'order'          => 'ASC',
			'orderby'        => 'menu_order',
			'post_type'      => 'attachment',
			'post_parent'    => get_the_ID(),
			'post_mime_type' => array( 'image/jpeg', 'image/png', 'image/gif' ),
			'post_status'    => null,
			'numberposts'    => -1,
			'exclude'		 => $thumb_id // Exclude featured thumbnail
		);

		$attachments = get_posts( $args );

		if( $attachments ) :
			wp_nonce_field( 'custom_images_sort', 'images_sort_nonce' ); ?>

			<div class="imageuploader">
				<div id="attachmentcontainer">
					<?php $i = 0; foreach( $attachments as $attachment ) :
						$editorimage = wp_get_attachment_image_src( intval( $attachment->ID ), 'thumbnail', false, false);
						$i++;
						?>
						<div class="attachment" id="image-<?php echo intval( $attachment->ID ); ?>" aria-label="<?php echo esc_attr( $attachment->post_title ); ?>" data-id="<?php echo intval( $attachment->ID ); ?>">
							<div class="image">
								<a href="<?php echo esc_url( get_admin_url( '', 'post.php?post='. intval( $attachment->ID ) .'&action=edit' ) ); ?>" title="<?php echo esc_attr( $attachment->post_title ); ?>">
									<img width="100" height="auto" src="<?php echo esc_url( $editorimage[0] ); ?>" />
								</a>
								<input type="hidden" name="att_id[]" id="att_id" value="<?php echo intval( $attachment->ID ); ?>" />
							</div>
							<div class="title"><?php echo esc_attr( $attachment->post_title ); ?></div>
							<span class="number"><?php echo esc_attr( intval( $i ) ); ?></span>

							<a class="button-link delete-attachment" data-name="remove" data-nonce="<?php echo wp_create_nonce( 'delete-attachment-nonce' ); ?>" href="#">Delete</a>
						</div>
					<?php endforeach; ?>
					<div style="clear: both;"></div>
				</div>
			</div>

		<?php
		endif;
	}

	/**
	 * Delete attachment ajax function
	 *
	 */
	function delete_attachment() {

		$nonce = $_GET['_ajax_nonce'];
	
		// check to see if the submitted nonce matches with the generated nonce we created earlier
		if ( ! wp_verify_nonce( $nonce, 'delete-attachment-nonce' ) ) { die ( 'Busted!'); }
	
		$json_array		= array();
		$attachment_id	= isset( $_GET['attachment_id'] ) ? absint( $_GET['attachment_id'] ) : '';
		
		if( ! empty( $attachment_id ) ) {
			if ( false === wp_delete_attachment( (int) $attachment_id ) ) {
				$json_array['attachment_id'] = 0;
			}else{
				$json_array['attachment_id'] = (int) $attachment_id;
			}
		}

		echo json_encode( $json_array );

		// IMPORTANT: don't forget to "exit"
		exit;
	}

	/**
	 * Saves the data to the post
	 *
	 * @param 	array 	$data			Sinitized post data
	 * @param 	array 	$_post_vars		Raw post data
	 * @return	$data
	 * @since   1.0.0
	 */
	public function sort_images_meta_save( $data, $_post_vars ) {

		$post_ID = $_post_vars['ID'];

		if( !in_array( $data['post_type'], $this->the_post_type ) || !isset( $_post_vars['images_sort_nonce'] ) ) {
			return $data;
		}

		if( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE ) {
			return $data;
		}

		if( !wp_verify_nonce( $_post_vars['images_sort_nonce'], 'custom_images_sort' ) ) {
			return $data;
		}

		if( !current_user_can( 'edit_post', $post_ID ) ) {
			return $data;
		}

		if( isset( $_post_vars['att_id'] ) ) {
			foreach( $_post_vars['att_id'] as $img_index => $img_id ) {
				$a = array(
					'ID' => $img_id,
					'menu_order' => $img_index
				);
				wp_update_post( $a );
			}
		}
		return $data;
	}

	/**
	 * Use to get post types
	 *
	 * @since 1.0.0
	 *
	 * @param string $key
	 * @return array|object
	 */
	private static function getObjectTypes( $key = '' ) {
		// Get all post types registered.
		$object_types = get_post_types( array('public' => true), 'objects' );
		$object_types = apply_filters( 'rei-post-object-types', $object_types, $key );
		if ( isset( $object_types[$key] ) ) {
			return $object_types[$key];
		}

		return $object_types;
	}


	/**
	 * Add shortcode to show image attachements in a post or page.
	 *
	 * @since 1.0.1
	 *
	 * @param array|string $attr Shortcode attributes. Empty string if no attributes.
	 * @return string Shortcode output
	 */
	function list_attached_images_shortcode( $attr ) {
		$defaults =  array(
			'imagesize'     => 'thumbnail',
			'numberimages'	=> 0,
			'order'			=> 'desc',
			'listclass'     => 'list-images',
			'before'        => '<li class="image-item %s">',
			'after'         => '</li>',
			'imagelink'     => false,
			'items_wrap'    => '<ul id="list-attached-images" class="%1$s">%2$s</ul>',
		);
		/* Merge the input attributes and the defaults. */
		extract( shortcode_atts( $defaults, $attr ) );

		$wrap_class = $listclass ? $listclass : '';

		$settings = (array) get_option( 'rei-options' );
		$thumb_id = $settings['feature-image'] ? 0 : get_post_thumbnail_id( get_the_ID() );
		$args = array(
			'post_type' => 'attachment',
			'post_mime_type'  => array('image/jpeg', 'image/png', 'image/gif'),
			'orderby' => 'menu_order',
			'numberposts' => $numberimages,
			'order' => $order,
			'post_parent' => get_the_ID(),
			'exclude' => $thumb_id // Exclude featured thumbnail
		);
		$attachments = get_posts($args);
		$images_count = count( $attachments );

		if ( $attachments ) :
			foreach ( $attachments as $key => $attachment ) :
				if( $imagelink == 'true' ) {
					$link_before = sprintf( '<a href="%s" title="%s">', esc_attr( $attachment->guid ), esc_attr( $attachment->post_title ) );
					$link_after = '</a>';
				}
				$last_child = $key % $images_count == ( $images_count-1 ) ? 'last-child' : '';
				$items .= sprintf( $before, esc_attr( $last_child ) ) . $link_before . wp_get_attachment_image( intval( $attachment->ID ), $imagesize ) .$link_after . $after;
			endforeach;
		endif;

		$output .= sprintf( $items_wrap, esc_attr( $wrap_class ), $items );

		return apply_filters( 'rei_shortcode', $output, $attr );
	}
}