581 lines
11 KiB
PHP
581 lines
11 KiB
PHP
<?php
|
|
|
|
/*
|
|
* ACF User Field Class
|
|
*
|
|
* All the logic for this field type
|
|
*
|
|
* @class acf_field_user
|
|
* @extends acf_field
|
|
* @package ACF
|
|
* @subpackage Fields
|
|
*/
|
|
|
|
if( ! class_exists('acf_field_user') ) :
|
|
|
|
class acf_field_user 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 = 'user';
|
|
$this->label = __("User",'acf');
|
|
$this->category = 'relational';
|
|
$this->defaults = array(
|
|
'role' => '',
|
|
'multiple' => 0,
|
|
'allow_null' => 0,
|
|
);
|
|
|
|
|
|
// extra
|
|
add_action('wp_ajax_acf/fields/user/query', array($this, 'ajax_query'));
|
|
add_action('wp_ajax_nopriv_acf/fields/user/query', array($this, 'ajax_query'));
|
|
|
|
|
|
// do not delete!
|
|
parent::__construct();
|
|
|
|
}
|
|
|
|
|
|
/*
|
|
* 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();
|
|
|
|
|
|
// defaults
|
|
$options = acf_parse_args($_POST, array(
|
|
'post_id' => 0,
|
|
's' => '',
|
|
'field_key' => '',
|
|
'paged' => 1
|
|
));
|
|
|
|
|
|
// vars
|
|
$results = array();
|
|
$args = array();
|
|
$s = false;
|
|
$is_search = false;
|
|
|
|
|
|
// paged
|
|
$args['users_per_page'] = 20;
|
|
$args['paged'] = $options['paged'];
|
|
|
|
|
|
// search
|
|
if( $options['s'] !== '' ) {
|
|
|
|
// strip slashes (search may be integer)
|
|
$s = wp_unslash( strval($options['s']) );
|
|
|
|
|
|
// update vars
|
|
$args['s'] = $s;
|
|
$is_search = true;
|
|
|
|
}
|
|
|
|
|
|
// load field
|
|
$field = acf_get_field( $options['field_key'] );
|
|
if( !$field ) die();
|
|
|
|
|
|
// role
|
|
if( !empty($field['role']) ) {
|
|
|
|
$args['role'] = acf_get_array( $field['role'] );
|
|
|
|
}
|
|
|
|
|
|
// search
|
|
if( $is_search ) {
|
|
|
|
// append to $args
|
|
$args['search'] = '*' . $options['s'] . '*';
|
|
|
|
|
|
// add reference
|
|
$this->field = $field;
|
|
|
|
|
|
// add filter to modify search colums
|
|
add_filter('user_search_columns', array($this, 'user_search_columns'), 10, 3);
|
|
|
|
}
|
|
|
|
|
|
// filters
|
|
$args = apply_filters("acf/fields/user/query", $args, $field, $options['post_id']);
|
|
$args = apply_filters("acf/fields/user/query/name={$field['_name']}", $args, $field, $options['post_id']);
|
|
$args = apply_filters("acf/fields/user/query/key={$field['key']}", $args, $field, $options['post_id']);
|
|
|
|
|
|
// get users
|
|
$groups = acf_get_grouped_users( $args );
|
|
|
|
|
|
// loop
|
|
if( !empty($groups) ) {
|
|
|
|
foreach( array_keys($groups) as $group_title ) {
|
|
|
|
// vars
|
|
$users = acf_extract_var( $groups, $group_title );
|
|
$data = array(
|
|
'text' => $group_title,
|
|
'children' => array()
|
|
);
|
|
|
|
|
|
// append users
|
|
foreach( array_keys($users) as $user_id ) {
|
|
|
|
$users[ $user_id ] = $this->get_result( $users[ $user_id ], $field, $options['post_id'] );
|
|
|
|
};
|
|
|
|
|
|
// order by search
|
|
if( $is_search && empty($args['orderby']) ) {
|
|
|
|
$users = acf_order_by_search( $users, $args['s'] );
|
|
|
|
}
|
|
|
|
|
|
// append to $data
|
|
foreach( $users as $id => $title ) {
|
|
|
|
$data['children'][] = array(
|
|
'id' => $id,
|
|
'text' => $title
|
|
);
|
|
|
|
}
|
|
|
|
|
|
// append to $r
|
|
$results[] = $data;
|
|
|
|
}
|
|
|
|
|
|
}
|
|
|
|
// optgroup or single
|
|
if( !empty($args['role']) && count($args['role']) == 1 ) {
|
|
|
|
$results = $results[0]['children'];
|
|
|
|
}
|
|
|
|
|
|
// return
|
|
acf_send_ajax_results(array(
|
|
'results' => $results,
|
|
'limit' => $args['users_per_page']
|
|
));
|
|
|
|
}
|
|
|
|
|
|
|
|
/*
|
|
* get_result
|
|
*
|
|
* This function returns the HTML for a result
|
|
*
|
|
* @type function
|
|
* @date 1/11/2013
|
|
* @since 5.0.0
|
|
*
|
|
* @param $post (object)
|
|
* @param $field (array)
|
|
* @param $post_id (int) the post_id to which this value is saved to
|
|
* @return (string)
|
|
*/
|
|
|
|
function get_result( $user, $field, $post_id = 0 ) {
|
|
|
|
// get post_id
|
|
if( !$post_id ) $post_id = acf_get_form_data('post_id');
|
|
|
|
|
|
// vars
|
|
$result = $user->user_login;
|
|
|
|
|
|
// append name
|
|
if( $user->first_name ) {
|
|
|
|
$result .= ' (' . $user->first_name;
|
|
|
|
if( $user->last_name ) {
|
|
|
|
$result .= ' ' . $user->last_name;
|
|
|
|
}
|
|
|
|
$result .= ')';
|
|
|
|
}
|
|
|
|
|
|
// filters
|
|
$result = apply_filters("acf/fields/user/result", $result, $user, $field, $post_id);
|
|
$result = apply_filters("acf/fields/user/result/name={$field['_name']}", $result, $user, $field, $post_id);
|
|
$result = apply_filters("acf/fields/user/result/key={$field['key']}", $result, $user, $field, $post_id);
|
|
|
|
|
|
// return
|
|
return $result;
|
|
|
|
}
|
|
|
|
|
|
/*
|
|
* user_search_columns
|
|
*
|
|
* This function will modify the columns which the user AJAX search looks in
|
|
*
|
|
* @type function
|
|
* @date 17/06/2014
|
|
* @since 5.0.0
|
|
*
|
|
* @param $columns (array)
|
|
* @return $columns
|
|
*/
|
|
|
|
function user_search_columns( $columns, $search, $WP_User_Query ) {
|
|
|
|
// bail early if no field
|
|
if( empty($this->field) ) {
|
|
|
|
return $columns;
|
|
|
|
}
|
|
|
|
|
|
// vars
|
|
$field = $this->field;
|
|
|
|
|
|
// filter for 3rd party customization
|
|
$columns = apply_filters("acf/fields/user/search_columns", $columns, $search, $WP_User_Query, $field);
|
|
$columns = apply_filters("acf/fields/user/search_columns/name={$field['_name']}", $columns, $search, $WP_User_Query, $field);
|
|
$columns = apply_filters("acf/fields/user/search_columns/key={$field['key']}", $columns, $search, $WP_User_Query, $field);
|
|
|
|
|
|
// return
|
|
return $columns;
|
|
|
|
}
|
|
|
|
/*
|
|
* render_field()
|
|
*
|
|
* Create the HTML interface for your field
|
|
*
|
|
* @type action
|
|
* @since 3.6
|
|
* @date 23/01/13
|
|
*
|
|
* @param $field - an array holding all the field's data
|
|
*/
|
|
|
|
function render_field( $field ) {
|
|
|
|
// Change Field into a select
|
|
$field['type'] = 'select';
|
|
$field['ui'] = 1;
|
|
$field['ajax'] = 1;
|
|
$field['choices'] = array();
|
|
|
|
|
|
// populate choices
|
|
if( !empty($field['value']) ) {
|
|
|
|
// force value to array
|
|
$field['value'] = acf_get_array( $field['value'] );
|
|
|
|
|
|
// convert values to int
|
|
$field['value'] = array_map('intval', $field['value']);
|
|
|
|
|
|
$users = get_users(array(
|
|
'include' => $field['value']
|
|
));
|
|
|
|
|
|
if( !empty($users) ) {
|
|
|
|
foreach( $users as $user ) {
|
|
|
|
$field['choices'][ $user->ID ] = $this->get_result( $user, $field );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
// render
|
|
acf_render_field( $field );
|
|
|
|
}
|
|
|
|
|
|
/*
|
|
* 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 ) {
|
|
|
|
acf_render_field_setting( $field, array(
|
|
'label' => __('Filter by role','acf'),
|
|
'instructions' => '',
|
|
'type' => 'select',
|
|
'name' => 'role',
|
|
'choices' => acf_get_pretty_user_roles(),
|
|
'multiple' => 1,
|
|
'ui' => 1,
|
|
'allow_null' => 1,
|
|
'placeholder' => __("All user roles",'acf'),
|
|
));
|
|
|
|
|
|
|
|
// allow_null
|
|
acf_render_field_setting( $field, array(
|
|
'label' => __('Allow Null?','acf'),
|
|
'instructions' => '',
|
|
'type' => 'radio',
|
|
'name' => 'allow_null',
|
|
'choices' => array(
|
|
1 => __("Yes",'acf'),
|
|
0 => __("No",'acf'),
|
|
),
|
|
'layout' => 'horizontal',
|
|
));
|
|
|
|
|
|
// multiple
|
|
acf_render_field_setting( $field, array(
|
|
'label' => __('Select multiple values?','acf'),
|
|
'instructions' => '',
|
|
'type' => 'radio',
|
|
'name' => 'multiple',
|
|
'choices' => array(
|
|
1 => __("Yes",'acf'),
|
|
0 => __("No",'acf'),
|
|
),
|
|
'layout' => 'horizontal',
|
|
));
|
|
|
|
|
|
}
|
|
|
|
|
|
/*
|
|
* 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']) ) {
|
|
|
|
$value = $value['ID'];
|
|
|
|
}
|
|
|
|
// object?
|
|
if( is_object($value) && isset($value->ID) ) {
|
|
|
|
$value = $value->ID;
|
|
|
|
}
|
|
|
|
|
|
// return
|
|
return $value;
|
|
}
|
|
|
|
|
|
/*
|
|
* 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 ) {
|
|
|
|
// ACF4 null
|
|
if( $value === 'null' ) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
// return
|
|
return $value;
|
|
}
|
|
|
|
|
|
/*
|
|
* 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_get_array( $value );
|
|
|
|
|
|
// convert values to int
|
|
$value = array_map('intval', $value);
|
|
|
|
|
|
// load users
|
|
foreach( array_keys($value) as $i ) {
|
|
|
|
// vars
|
|
$user_id = $value[ $i ];
|
|
$user_data = get_userdata( $user_id );
|
|
|
|
|
|
//cope with deleted users by @adampope
|
|
if( !is_object($user_data) ) {
|
|
|
|
unset( $value[ $i ] );
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
// append to array
|
|
$value[ $i ] = array();
|
|
$value[ $i ]['ID'] = $user_id;
|
|
$value[ $i ]['user_firstname'] = $user_data->user_firstname;
|
|
$value[ $i ]['user_lastname'] = $user_data->user_lastname;
|
|
$value[ $i ]['nickname'] = $user_data->nickname;
|
|
$value[ $i ]['user_nicename'] = $user_data->user_nicename;
|
|
$value[ $i ]['display_name'] = $user_data->display_name;
|
|
$value[ $i ]['user_email'] = $user_data->user_email;
|
|
$value[ $i ]['user_url'] = $user_data->user_url;
|
|
$value[ $i ]['user_registered'] = $user_data->user_registered;
|
|
$value[ $i ]['user_description'] = $user_data->user_description;
|
|
$value[ $i ]['user_avatar'] = get_avatar( $user_id );
|
|
|
|
}
|
|
|
|
|
|
// convert back from array if neccessary
|
|
if( !$field['multiple'] ) {
|
|
|
|
$value = array_shift($value);
|
|
|
|
}
|
|
|
|
|
|
// return value
|
|
return $value;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
// initialize
|
|
acf_register_field_type( new acf_field_user() );
|
|
|
|
endif; // class_exists check
|
|
|
|
?>
|