acf-user-functions.php — Advanced Custom Fields (ACF®) 6.8.8

advanced-custom-fields / includes / acf-user-functions.php

advanced-custom-fields / includes Last commit date

acf-user-functions.php

129 lines

1	<?php
2	/**
3	* @package ACF
4	* @author WP Engine
5	*
6	* © 2026 Advanced Custom Fields (ACF®). All rights reserved.
7	* "ACF" is a trademark of WP Engine.
8	* Licensed under the GNU General Public License v2 or later.
9	* https://www.gnu.org/licenses/gpl-2.0.html
10	*/
11
12	/**
13	* acf_get_users
14	*
15	* Similar to the get_users() function but with extra functionality.
16	*
17	* @date 9/1/19
18	* @since 5.7.10
19	*
20	* @param array $args The query args.
21	* @return array
22	*/
23	function acf_get_users( $args = array() ) {
24
25	// Get users.
26	$users = get_users( $args );
27
28	// Maintain order.
29	if ( $users && $args['include'] ) {
30
31	// Generate order array.
32	$order = array();
33	foreach ( $users as $i => $user ) {
34	$order[ $i ] = array_search( $user->ID, $args['include'] );
35	}
36
37	// Sort results.
38	array_multisort( $order, $users );
39	}
40
41	// Return
42	return $users;
43	}
44
45	/**
46	* acf_get_user_result
47	*
48	* Returns a result containing "id" and "text" for the given user.
49	*
50	* @date 21/5/19
51	* @since 5.8.1
52	*
53	* @param WP_User $user The user object.
54	* @return array
55	*/
56	function acf_get_user_result( $user ) {
57
58	// Vars.
59	$id = $user->ID;
60	$text = $user->user_login;
61
62	// Add name.
63	if ( $user->first_name && $user->last_name ) {
64	$text .= " ({$user->first_name} {$user->last_name})";
65	} elseif ( $user->first_name ) {
66	$text .= " ({$user->first_name})";
67	}
68	return compact( 'id', 'text' );
69	}
70
71
72	/**
73	* acf_get_user_role_labels
74	*
75	* Returns an array of user roles in the format "name => label".
76	*
77	* @date 20/5/19
78	* @since 5.8.1
79	*
80	* @param array $roles A specific array of roles.
81	* @return array
82	*/
83	function acf_get_user_role_labels( $roles = array() ) {
84	$all_roles = wp_roles()->get_names();
85
86	// Load all roles if none provided.
87	if ( empty( $roles ) ) {
88	$roles = array_keys( $all_roles );
89	}
90
91	// Loop over roles and populare labels.
92	$lables = array();
93	foreach ( $roles as $role ) {
94	if ( isset( $all_roles[ $role ] ) ) {
95	$lables[ $role ] = translate_user_role( $all_roles[ $role ] );
96	}
97	}
98
99	// Return labels.
100	return $lables;
101	}
102
103	/**
104	* acf_allow_unfiltered_html
105	*
106	* Returns true if the current user is allowed to save unfiltered HTML.
107	*
108	* @date 9/1/19
109	* @since 5.7.10
110	*
111	* @param void
112	* @return boolean
113	*/
114	function acf_allow_unfiltered_html() {
115
116	// Check capability.
117	$allow_unfiltered_html = current_user_can( 'unfiltered_html' );
118
119	/**
120	* Filters whether the current user is allowed to save unfiltered HTML.
121	*
122	* @date 9/1/19
123	* @since 5.7.10
124	*
125	* @param bool allow_unfiltered_html The result.
126	*/
127	return apply_filters( 'acf/allow_unfiltered_html', $allow_unfiltered_html );
128	}
129