Add user_select field

README.md

@@ -1,11 +1,11 @@
 # Shortcake (Shortcode UI) #
-**Contributors:** fusionengineering, mattheu, danielbachhuber, zebulonj, goldenapples, jitendraharpalani, sanchothefat, bfintal, davisshaver, garyj, mte90, fredserva, khromov, bronsonquick  
-**Tags:** shortcodes  
-**Requires at least:** 4.1  
-**Tested up to:** 4.4  
+**Contributors:** fusionengineering, mattheu, danielbachhuber, zebulonj, goldenapples, jitendraharpalani, sanchothefat, bfintal, davisshaver, garyj, mte90, fredserva, khromov, bronsonquick, dashaluna
+**Tags:** shortcodes
+**Requires at least:** 4.1
+**Tested up to:** 4.4
 **Stable tag:** 0.6.3
-**License:** GPLv2 or later  
-**License URI:** http://www.gnu.org/licenses/gpl-2.0.html  
+**License:** GPLv2 or later
+**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
 
 Shortcake makes using WordPress shortcodes a piece of cake.
 
@@ -60,6 +60,9 @@ We've removed the compatibility shim for the magical `content` attribute. If you
 ## Changelog ##
 
 
+### 0.6.4 (June 1, 2016) ###
+* Introduced a `user_select` input type for user selection.
+
 ### 0.6.3 (May 19, 2016) ###
 * Introduced a `term_select` input type for taxonomy selection.
 

dev.php

@@ -193,6 +193,12 @@ function shortcode_ui_dev_advanced_example() {
 			'taxonomy' => 'post_tag',
 			'multiple' => true,
 		),
+		array(
+			'label'    => __( 'User Select', 'shortcode-ui-example' ),
+			'attr'     => 'users',
+			'type'     => 'user_select',
+			'multiple' => true,
+		),
 		array(
 			'label'  => esc_html__( 'Color', 'shortcode-ui-example' ),
 			'attr'   => 'color',
@@ -287,13 +293,12 @@ function shortcode_ui_dev_shortcode( $attr, $content, $shortcode_tag ) {
 		'attachment' => 0,
 		'page'       => '',
 		'term'       => '',
+		'users'      => '',
 		'color'      => '',
 		'alignment'  => '',
 		'year'       => '',
 	), $attr, $shortcode_tag );
 
-	// Make some sense of the data.
-
 	$attr['page'] = array_map(
 		function( $post_id ) {
 			return get_the_title( $post_id );
@@ -303,12 +308,20 @@ function( $post_id ) {
 
 	$attr['term'] = array_map(
 		function( $term_id ) {
-			$data = get_term( $term_id, 'category' );
+			$data = get_term( $term_id, 'post_tag' );
 			return $data->name;
 		},
 		array_filter( array_map( 'absint', explode( ',', $attr['term'] ) ) )
 	);
 
+	$attr['users'] = array_map(
+		function( $user_id ) {
+			$data = get_userdata( $user_id );
+			return $data->display_name;
+		},
+		array_filter( array_map( 'absint', explode( ',', $attr['users'] ) ) )
+	);
+
 	$attr['color'] = urldecode( $attr['color'] );
 
 	// Shortcode callbacks must return content, hence, output buffering here.
@@ -337,6 +350,10 @@ function( $term_id ) {
 				<b><?php esc_html_e( 'Terms:', 'shortcode-ui-example' ); ?></b> <?php echo esc_html( implode( ', ', $attr['term'] ) ); ?></br>
 			<?php endif; ?>
 
+			<?php if ( ! empty( $attr['users'] ) ) : ?>
+				<b><?php esc_html_e( 'Users:', 'shortcode-ui-example' ); ?></b> <?php echo esc_html( implode( ', ', $attr['users'] ) ); ?></br>
+			<?php endif; ?>
+
 			<?php if ( ! empty( $attr['color'] ) ) : ?>
 				<b><?php esc_html_e( 'Color:', 'shortcode-ui-example' ); ?></b> <span style="display: inline-block; width: 1.5em; height: 1.5em; vertical-align: bottom; background-color: <?php echo esc_html( $attr['color'] ); ?>"></span></br>
 			<?php endif; ?>

inc/class-shortcode-ui.php

@@ -195,6 +195,9 @@ public function get_shortcode( $shortcode_tag ) {
 	 */
 	public function action_admin_enqueue_scripts( $editor_supports ) {
 		add_editor_style( trailingslashit( $this->plugin_url ) . 'css/shortcode-ui-editor-styles.css' );
+
+		wp_register_script( 'select2', trailingslashit( $this->plugin_url ) . 'lib/select2/select2.min.js', array( 'jquery', 'jquery-ui-sortable' ), '3.5.2' );
+		wp_register_style( 'select2', trailingslashit( $this->plugin_url ) . 'lib/select2/select2.css', null, '3.5.2' );
 	}
 
 	/**

inc/fields/class-field-post-select.php

@@ -38,10 +38,8 @@ public function filter_shortcode_ui_fields( $fields ) {
 
 	public function action_enqueue_shortcode_ui() {
 
-		$plugin_dir = dirname( dirname( __FILE__ ) );
-
-		wp_enqueue_script( 'select2', plugins_url( 'lib/select2/select2.min.js', $plugin_dir ) , array( 'jquery', 'jquery-ui-sortable' ), '3.5.2' );
-		wp_enqueue_style( 'select2', plugins_url( 'lib/select2/select2.css', $plugin_dir ), null, '3.5.2' );
+		wp_enqueue_script( 'select2' );
+		wp_enqueue_style( 'select2' );
 
 		wp_localize_script( 'shortcode-ui', 'shortcodeUiPostFieldData', array(
 			'nonce' => wp_create_nonce( 'shortcode_ui_field_post_select' ),

inc/fields/class-field-term-select.php

@@ -51,10 +51,9 @@ public function filter_shortcode_ui_fields( $fields ) {
 	 * Add Select2 for our UI.
 	 */
 	public function action_enqueue_shortcode_ui() {
-		$plugin_dir = dirname( dirname( __FILE__ ) );
 
-		wp_enqueue_script( 'select2', plugins_url( 'lib/select2/select2.min.js', $plugin_dir ), array( 'jquery', 'jquery-ui-sortable' ), '3.5.2' );
-		wp_enqueue_style( 'select2', plugins_url( 'lib/select2/select2.css', $plugin_dir ), null, '3.5.2' );
+		wp_enqueue_script( 'select2' );
+		wp_enqueue_style( 'select2' );
 
 		wp_localize_script( 'shortcode-ui', 'shortcodeUiTermFieldData', array(
 			'nonce' => wp_create_nonce( 'shortcode_ui_field_term_select' ),

inc/fields/class-field-user-select.php

@@ -0,0 +1,180 @@
+<?php
+
+class Shortcode_UI_Field_User_Select {
+
+	private static $instance;
+
+	// All registered user fields.
+	private $user_fields  = array();
+
+	// Field Settings.
+	private $fields = array(
+		'user_select' => array(
+			'template' => 'shortcode-ui-field-user-select',
+			'view'     => 'editAttributeFieldUserSelect',
+		),
+	);
+
+	/**
+	 * Setup the instance.
+	 *
+	 * @return Shortcode_UI_Field_User_Select
+	 */
+	public static function get_instance() {
+
+		if ( ! isset( self::$instance ) ) {
+			self::$instance = new self;
+			self::$instance->setup_actions();
+		}
+		return self::$instance;
+	}
+
+	/**
+	 * Add the required actions and filters.
+	 */
+	private function setup_actions() {
+
+		add_filter( 'shortcode_ui_fields',             array( $this, 'filter_shortcode_ui_fields' ) );
+		add_action( 'enqueue_shortcode_ui',            array( $this, 'action_enqueue_shortcode_ui' ) );
+		add_action( 'wp_ajax_shortcode_ui_user_field', array( $this, 'action_wp_ajax_shortcode_ui_user_field' ) );
+		add_action( 'shortcode_ui_loaded_editor',      array( $this, 'action_shortcode_ui_loaded_editor' ) );
+	}
+
+	/**
+	 * Add our field to the shortcode fields.
+	 *
+	 * @param $fields
+	 *
+	 * @return array
+	 */
+	public function filter_shortcode_ui_fields( $fields ) {
+
+		return array_merge( $fields, $this->fields );
+	}
+
+	/**
+	 * Add Select2 for our UI.
+	 */
+	public function action_enqueue_shortcode_ui() {
+
+		wp_enqueue_script( 'select2' );
+		wp_enqueue_style( 'select2' );
+
+		wp_localize_script( 'shortcode-ui', 'shortcodeUiUserFieldData', array(
+			'nonce' => wp_create_nonce( 'shortcode_ui_field_user_select' ),
+		) );
+	}
+
+	/**
+	 * Output styles and templates used by user select field.
+	 */
+	public function action_shortcode_ui_loaded_editor() {
+		?>
+
+		<style>
+
+			.edit-shortcode-form .select2-container {
+				min-width: 300px;
+			}
+
+			.edit-shortcode-form .select2-container a {
+				transition: none;
+				-webkit-transition: none;
+			}
+
+			.wp-admin .select2-drop {
+				z-index: 160001;
+			}
+
+		</style>
+
+		<script type="text/html" id="tmpl-shortcode-ui-field-user-select">
+			<div class="field-block shortcode-ui-field-user-select shortcode-ui-attribute-{{ data.attr }}">
+				<label for="{{ data.id }}">{{{ data.label }}}</label>
+				<input type="text" name="{{ data.attr }}" id="{{ data.id }}" value="{{ data.value }}" class="shortcode-ui-user-select" />
+				<# if ( typeof data.description == 'string' ) { #>
+					<p class="description">{{{ data.description }}}</p>
+				<# } #>
+			</div>
+		</script>
+
+		<?php
+	}
+
+	/**
+	 * Ajax handler for select2 user field queries.
+	 * Output JSON containing user data.
+	 * Requires that shortcode, attr and nonce are passed.
+	 * Requires that the field has been correctly registered and can be found in $this->post_fields
+	 * Supports passing page number and search query string.
+	 *
+	 * @return null
+	 */
+	public function action_wp_ajax_shortcode_ui_user_field() {
+
+		$nonce               = isset( $_GET['nonce'] ) ? sanitize_text_field( wp_unslash( $_GET['nonce'] ) ) : null;
+		$requested_shortcode = isset( $_GET['shortcode'] ) ? sanitize_text_field( wp_unslash( $_GET['shortcode'] ) ) : null;
+		$requested_attr      = isset( $_GET['attr'] ) ? sanitize_text_field( wp_unslash( $_GET['attr'] ) ) : null;
+		$page                = isset( $_GET['page'] ) ? sanitize_text_field( wp_unslash( $_GET['page'] ) ) : null;
+		$search_str          = isset( $_GET['s'] ) ? sanitize_text_field( wp_unslash( $_GET['s'] ) ) : null;
+		$response            = array( 'users' => array(), 'found_users' => 0, 'users_per_page' => 0 );
+
+		$include = null;
+		if ( isset( $_GET['include'] ) ) {
+			// Make sure include is always an array & sanitize its values.
+			$include = is_array( $_GET['include'] ) ? $_GET['include'] : explode( ',', $_GET['include'] );
+			$include = array_map( 'absint', stripslashes_deep( $include ) );
+		}
+
+		if ( ! wp_verify_nonce( $nonce, 'shortcode_ui_field_user_select' ) ) {
+			wp_send_json_error( $response );
+		}
+
+		$shortcodes = Shortcode_UI::get_instance()->get_shortcodes();
+
+		// Shortcode not found.
+		if ( ! isset( $shortcodes[ $requested_shortcode ] ) ) {
+			wp_send_json_error( $response );
+		}
+
+		$shortcode = $shortcodes[ $requested_shortcode ];
+
+		// Defaults user query args.
+		$query_args['search_columns'] = array( 'ID', 'user_login', 'user_nicename', 'user_email' );
+		$query_args['number']         = 10;
+
+		// Include selected users to be displayed.
+		if ( $include ) {
+			$query_args['include'] = $include;
+		}
+
+		// Supports WP_User_Query query args.
+		foreach ( $shortcode['attrs'] as $attr ) {
+			if ( $attr['attr'] === $requested_attr && isset( $attr['query'] ) ) {
+				$query_args = $attr['query'];
+			}
+		}
+
+		if ( $page ) {
+			$query_args['paged'] = $page;
+		}
+
+		if ( $search_str ) {
+			$query_args['search'] = '*' . $search_str . '*';
+		}
+
+		$query = new WP_User_Query( $query_args );
+
+		foreach ( $query->get_results() as $user ) {
+			array_push( $response['users'], array(
+				'id'   => $user->ID,
+				'text' => html_entity_decode( $user->display_name ),
+			) );
+		}
+
+		$response['found_users']    = $query->get_total();
+		$response['users_per_page'] = $query->query_vars['number'];
+
+		wp_send_json_success( $response );
+	}
+}