Skip to content
This repository
branch: master
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 447 lines (325 sloc) 11.944 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
<?php

/*
* Advanced Custom Fields - Users Multi-Select Field add-on
*
*
* Contributors: by @lewismcarey (@forepoint) ,
* update nicename to displayname - jeradin (ACF support)
* translation issue resolved - eonlova (issue 1)
* now includes users.php if using ACF front-end-forms - owsleye (issue 2)
* additional translation issue resolved - Synaestesia (issue 3)
*
* Tags: acf, acf add-on, users, custom field, user field
* Requires at least: 3.0
* Tested up to: 3.3.1
* Stable tag: 0.0
*
* Documentation can be found at https://github.com/lewismcarey/User-Field-ACF-Add-on/blob/master/readme.txt
* Report any issues or feature requests to https://github.com/lewismcarey/User-Field-ACF-Add-on/issues
*
*/
 
if ( class_exists( 'acf_Field' ) && ! class_exists( 'Users_field' ) ) {
 
class Users_field extends acf_Field {

/*--------------------------------------------------------------------------------------
*
* Constructor
* - This function is called when the field class is initalized on each page.
* - Here you can add filters / actions and setup any other functionality for your field
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function __construct( $parent ) {

// do not delete!
parent::__construct( $parent );

// set name / title
$this->name = 'users_field'; // variable name (no spaces / special characters / etc)
$this->title = __( "Users", 'acf' ); // field label (Displayed in edit screens)

}


/*--------------------------------------------------------------------------------------
*
* create_options
* - this function is called from core/field_meta_box.php to create extra options
* for your field
*
* @params
* - $key (int) - the $_POST obejct key required to save the options to the field
* - $field (array) - the field object
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function create_options( $key, $field ) {

//role_capability
// defaults
$field['role'] = isset( $field['role'] ) ? $field['role'] : '';
$field['multiple'] = isset( $field['multiple'] ) ? $field['multiple'] : '0';
$field['allow_null'] = isset( $field['allow_null'] ) ? $field['allow_null'] : '0';

?>
<tr class="field_option field_option_<?php echo $this->name; ?>">
<td class="label">
<label><?php _e( "Filter by role", 'acf' ); ?></label>
</td>
<td>
<?php
$choices = array( '' => '-All-' );

$editable_roles = get_editable_roles();

foreach ( $editable_roles as $role => $details ) {

// only translate the output not the value
$choices[$role] = translate_user_role( $details['name'] );

}

$this->parent->create_field( array(
'type' => 'select',
'name' => 'fields[' . $key . '][role]',
'value' => $field['role'],
'choices' => array( $choices ),
'optgroup' => true,
'multiple' => '1',
) );
?>
</td>
</tr>
<tr class="field_option field_option_<?php echo $this->name; ?>">
<td class="label">
<label><?php _e( "Allow Null?", 'acf' ); ?></label>
</td>
<td>
<?php
$this->parent->create_field( array(
'type' => 'radio',
'name' => 'fields['. $key . '][allow_null]',
'value' => $field['allow_null'],
'choices' => array(
'1' => 'Yes',
'0' => 'No',
),
'layout' => 'horizontal',
)) ;
?>
</td>
</tr>
<tr class="field_option field_option_<?php echo $this->name; ?>">
<td class="label">
<label><?php _e( "Select multiple values?", 'acf' ); ?></label>
</td>
<td>
<?php
$this->parent->create_field( array(
'type' => 'radio',
'name' => 'fields[' . $key . '][multiple]',
'value' => $field['multiple'],
'choices' => array (
'1' => 'Yes',
'0' => 'No',
),
'layout' => 'horizontal',
) );
?>
</td>
</tr>
<?php

}


/*--------------------------------------------------------------------------------------
*
* pre_save_field
* - this function is called when saving your acf object. Here you can manipulate the
* field object and it's options before it gets saved to the database.
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function pre_save_field( $field ) {

// do stuff with field (mostly format options data)

return parent::pre_save_field( $field );

}


/*--------------------------------------------------------------------------------------
*
* create_field
* - this function is called on edit screens to produce the html for this field
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function create_field( $field ) {

$editable_roles = get_editable_roles();

$field['role'] = isset( $field['role'] ) ? $field['role'] : false;
$field['multiple'] = isset( $field['multiple'] ) ? $field['multiple'] : false;


if ( ! $field['role'] || ! is_array( $field['role'] ) || $field['role'][0] == "" ) {

$field['role'] = array();

foreach ( $editable_roles as $role => $details ) {

if ( $details['name'] != "" ) {

$field['role'][] = $role ;

}

}

}

// multiple select
$multiple = '';

if ( $field['multiple'] == '1' ) {

$multiple = ' multiple="multiple" size="5" ';
$field['name'] .= '[]';
}

// html
echo '<select id="' . $field['name'] . '" class="' . $field['class'] . '" name="' . $field['name'] . '" ' . $multiple . ' >';

// null
if ( $field['allow_null'] == '1' ) {

echo '<option value="null"> - Select - </option>';

}


foreach ( $field['role'] as $role ) {

$label = $editable_roles[ $role]['name'];

// get users
$args = array(
'role' => $role
);

$users = get_users( $args );

if ( $users ) {

echo '<optgroup label="' . translate_user_role( $label ) . '">';

foreach ( $users as $k => $user ) {

$key = $user->ID;
$value = ucfirst( $user->display_name );
$selected = '';

if ( is_array( $field['value'] ) ) {

// 2. If the value is an array (multiple select),
// loop through values and check if it is selected

if ( in_array( $key, $field['value'] ) ) {

$selected = 'selected="selected"';

}

} else {

// 3. this is not a multiple select, just check normaly
if ( $key == $field['value'] ) {
$selected = 'selected="selected"';
}
}

echo '<option value="' . $key . '" ' . $selected . '>' . $value . '</option>';

}

echo '</optgroup>';

}

}// endforeach

echo '</select>';

}


/*--------------------------------------------------------------------------------------
*
* admin_head
* - this function is called in the admin_head of the edit screen where your field
* is created. Use this function to create css and javascript to assist your
* create_field() function.
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function admin_head() {

if ( ! function_exists( 'get_editable_roles' ) ) {

// if using front-end forms then we need to add this core file
require_once( ABSPATH . '/wp-admin/includes/user.php' );

}

}


/*--------------------------------------------------------------------------------------
*
* admin_print_scripts / admin_print_styles
* - this function is called in the admin_print_scripts / admin_print_styles where
* your field is created. Use this function to register css and javascript to assist
* your create_field() function.
*
* @author Elliot Condon
* @since 3.0.0
*
*-------------------------------------------------------------------------------------*/

function admin_print_scripts() {

}

function admin_print_styles() {

}


/*--------------------------------------------------------------------------------------
*
* update_value
* - this function is called when saving a post object that your field is assigned to.
* the function will pass through the 3 parameters for you to use.
*
* @params
* - $post_id (int) - usefull if you need to save extra data or manipulate the current
* post object
* - $field (array) - usefull if you need to manipulate the $value based on a field option
* - $value (mixed) - the new value of your field.
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function update_value( $post_id, $field, $value ) {

// do stuff with value

// save value
parent::update_value( $post_id, $field, $value );

}


/*--------------------------------------------------------------------------------------
*
* get_value
* - called from the edit page to get the value of your field. This function is useful
* if your field needs to collect extra data for your create_field() function.
*
* @params
* - $post_id (int) - the post ID which your value is attached to
* - $field (array) - the field object.
*
* @author Elliot Condon
* @since 2.2.0
*
*-------------------------------------------------------------------------------------*/

function get_value( $post_id, $field ) {

// get value
$value = parent::get_value( $post_id, $field );

// format value

// return value
return $value;

}


/*--------------------------------------------------------------------------------------
*
* get_value_for_api
* - called from your template file when using the API functions (get_field, etc).
* This function is useful if your field needs to format the returned value
*
* @params
* - $post_id (int) - the post ID which your value is attached to
* - $field (array) - the field object.
*
* @author Elliot Condon
* @since 3.0.0
*
*-------------------------------------------------------------------------------------*/

function get_value_for_api( $post_id, $field ) {

// get value
$value = $this->get_value( $post_id, $field );

// format value
if ( ( ! $value ) || ( $value == 'null' ) ) {

return false;

}

// make sure that whats returned is an array
$value = (array) $value;

foreach ( $value as $k => $v ) {

$user_data = get_userdata( $v );

//cope with deleted users by @adampope
if ( ! is_object( $user_data ) ) {

unset( $value[$k] );

continue;

}

$value[ $k ] = array();
$value[ $k ]['ID'] = $v;
$value[ $k ]['user_firstname'] = $user_data->user_firstname;
$value[ $k ]['user_lastname'] = $user_data->user_lastname;
$value[ $k ]['nickname'] = $user_data->nickname;
$value[ $k ]['user_nicename'] = $user_data->user_nicename;
$value[ $k ]['display_name'] = $user_data->display_name;
$value[ $k ]['user_email'] = $user_data->user_email;
$value[ $k ]['user_url'] = $user_data->user_url;
$value[ $k ]['user_registered'] = $user_data->user_registered;
$value[ $k ]['user_description'] = $user_data->user_description;
$value[ $k ]['user_avatar'] = get_avatar( $v );

}

// return value
return $value;

}

}

}

?>
Something went wrong with that request. Please try again.