get_users()

Извлекает список пользователей, соответствующих критериям
Функция WordPress
INT 3.1.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Получение списка пользователей с определенной ролью
  4. Получение списка пользователей с определенными мета-данными
  5. Получение списка пользователей с определенными возможностями
  6. Получение списка пользователей с определенными исключениями
  7. Вопросы и ответы
  8. Как получить список всех пользователей?
  9. Как получить список пользователей с определенной ролью?
  10. Как получить список пользователей с определенным мета-ключом и значением?
  11. Как получить список пользователей, у которых есть определенная возможность?
  12. Как получить список пользователей, исключая определенные роли?
  13. Как получить список пользователей, исключая определенные мета-ключи и значения?
  14. Как получить список пользователей, у которых есть определенные ID?
  15. Как получить список пользователей, у которых есть определенный поисковый запрос?
  16. Как получить список пользователей, отсортированных по определенному полю?
  17. Связанные элементы

Описание функции

Функция get_users() используется для получения списка пользователей, соответствующих заданным критериям.

Использование

get_users( array $args = array() ) : array

Функция get_users() принимает один необязательный аргумент — массив параметров $args. Возвращает массив пользователей, соответствующих заданным критериям.

  • $args (массив) — Необязательные аргументы для получения пользователей. Смотрите WP_User_Query::prepare_query() для получения дополнительной информации о принимаемых аргументах.

Функция возвращает массив пользователей, соответствующих заданным критериям.


$args = array(
  'role' => 'editor',
  'orderby' => 'display_name',
  'order' => 'ASC',
  'number' => 10
);
$users = get_users( $args );
foreach ( $users as $user ) {
  // Выводим имя пользователя
  echo $user->display_name;
}

В данном примере мы получаем массив пользователей с ролью «editor», сортируем их по имени в алфавитном порядке и выводим первые 10 пользователей.

Примеры использования

Получение списка пользователей с определенной ролью


$args = array(
    'role' => 'author',
);
$users = get_users( $args );
foreach ( $users as $user ) {
    echo 'User ID: ' . $user->ID . ', Username: ' . $user->user_login . '<br>';
}

В этом примере мы используем функцию get_users() для получения списка пользователей с ролью «author». Мы создаем массив $args с параметром 'role', указывающим на нужную роль. Затем мы передаем этот массив в функцию get_users() и сохраняем результат в переменную $users.

Затем мы проходимся по каждому пользователю в массиве $users и выводим их ID и имя пользователя.

Получение списка пользователей с определенными мета-данными


$args = array(
    'meta_key' => 'favorite_color',
    'meta_value' => 'blue',
);
$users = get_users( $args );
foreach ( $users as $user ) {
    echo 'User ID: ' . $user->ID . ', Username: ' . $user->user_login . '<br>';
}

В этом примере мы используем функцию get_users() для получения списка пользователей, у которых в мета-поле «favorite_color» указано значение «blue». Мы создаем массив $args с параметрами 'meta_key' и 'meta_value', указывающими на нужное мета-поле и его значение. Затем мы передаем этот массив в функцию get_users() и сохраняем результат в переменную $users.

Затем мы проходимся по каждому пользователю в массиве $users и выводим их ID и имя пользователя.

Получение списка пользователей с определенными возможностями


$args = array(
    'capability' => 'edit_posts',
);
$users = get_users( $args );
foreach ( $users as $user ) {
    echo 'User ID: ' . $user->ID . ', Username: ' . $user->user_login . '<br>';
}

В этом примере мы используем функцию get_users() для получения списка пользователей, у которых есть возможность редактировать записи (capability «edit_posts»). Мы создаем массив $args с параметром 'capability', указывающим на нужную возможность. Затем мы передаем этот массив в функцию get_users() и сохраняем результат в переменную $users.

Затем мы проходимся по каждому пользователю в массиве $users и выводим их ID и имя пользователя.

Получение списка пользователей с определенными исключениями


$args = array(
    'role__not_in' => array( 'subscriber', 'contributor' ),
);
$users = get_users( $args );
foreach ( $users as $user ) {
    echo 'User ID: ' . $user->ID . ', Username: ' . $user->user_login . '<br>';
}

В этом примере мы используем функцию get_users() для получения списка пользователей, у которых роль не является «subscriber» или «contributor». Мы создаем массив $args с параметром 'role__not_in', указывающим на роли, которые нужно исключить. Затем мы передаем этот массив в функцию get_users() и сохраняем результат в переменную $users.

Затем мы проходимся по каждому пользователю в массиве $users и выводим их ID и имя пользователя.

Вопросы и ответы

Как получить список всех пользователей?

Для получения списка всех пользователей в WordPress можно использовать функцию get_users(). Она принимает необязательный аргумент $args, который позволяет задать дополнительные параметры для выборки пользователей. По умолчанию функция возвращает массив со списком пользователей.

$users = get_users();
foreach ($users as $user) {
    echo $user->display_name;
}

Как получить список пользователей с определенной ролью?

Для получения списка пользователей с определенной ролью можно использовать параметр role функции get_users(). Этот параметр принимает строку или массив строк с названиями ролей, которым должны соответствовать пользователи.

$args = array(
    'role' => 'author'
);
$users = get_users($args);
foreach ($users as $user) {
    echo $user->display_name;
}

Как получить список пользователей с определенным мета-ключом и значением?

Для получения списка пользователей с определенным мета-ключом и значением можно использовать параметры meta_key и meta_value функции get_users(). Эти параметры принимают строки или массивы строк с названиями мета-ключей и значениями, которым должны соответствовать пользователи.

$args = array(
    'meta_key' => 'city',
    'meta_value' => 'New York'
);
$users = get_users($args);
foreach ($users as $user) {
    echo $user->display_name;
}

Как получить список пользователей, у которых есть определенная возможность?

Для получения списка пользователей, у которых есть определенная возможность, можно использовать параметр capability функции get_users(). Этот параметр принимает массив или строку с именами возможностей, которые должны соответствовать пользователям, чтобы они были включены в результаты.

$args = array(
    'capability' => 'edit_posts'
);
$users = get_users( $args );

Как получить список пользователей, исключая определенные роли?

Для получения списка пользователей, исключая определенные роли, можно использовать параметр role__not_in функции get_users(). Этот параметр принимает массив с именами ролей, которые должны быть исключены из результатов.

$args = array(
    'role__not_in' => array( 'editor', 'author' )
);
$users = get_users( $args );

Как получить список пользователей, исключая определенные мета-ключи и значения?

Для получения списка пользователей, исключая определенные мета-ключи и значения, можно использовать параметр meta_query функции get_users(). Этот параметр принимает ассоциативный массив с аргументами WP_Meta_Query, которые определяют фильтры для мета-данных пользователей.

$args = array(
    'meta_query' => array(
        array(
            'key'     => 'favorite_color',
            'value'   => 'blue',
            'compare' => '!='
        )
    )
);
$users = get_users( $args );

Как получить список пользователей, у которых есть определенные ID?

Для получения списка пользователей, у которых есть определенные ID, можно использовать функцию get_users() с параметром include, который принимает массив идентификаторов пользователей.


$users = get_users( array(
    'include' => array( 1, 2, 3 )
) );

Как получить список пользователей, у которых есть определенный поисковый запрос?

Для получения списка пользователей, у которых есть определенный поисковый запрос, можно использовать функцию get_users() с параметром search, который принимает строку с ключевым словом для поиска.


$users = get_users( array(
    'search' => 'john'
) );

Как получить список пользователей, отсортированных по определенному полю?

Для получения списка пользователей, отсортированных по определенному полю, можно использовать функцию get_users() с параметром orderby, который принимает строку или массив полей для сортировки.


$users = get_users( array(
    'orderby' => 'user_registered'
) );

Функция get_users() позволяет получить список пользователей, соответствующих определенным критериям. Она принимает массив параметров, с помощью которых можно настроить запрос. Возвращаемым значением является массив, содержащий список пользователей.

Связанные элементы

  • Функция get_current_user_id(): Возвращает идентификатор текущего пользователя.
  • Функция get_userdata(): Возвращает данные пользователя по его идентификатору.
  • Функция wp_get_current_user(): Возвращает объект текущего пользователя.
  • Функция wp_insert_user(): Создает нового пользователя в базе данных.
  • Функция wp_update_user(): Обновляет данные существующего пользователя в базе данных.
  • Функция wp_delete_user(): Удаляет пользователя из базы данных.
  • Хук pre_get_users: Позволяет изменить аргументы запроса перед выполнением функции get_users.
  • Класс WP_User_Query: Используется для создания и выполнения запросов на получение пользователей с заданными параметрами.
  • Класс WP_User: Представляет отдельного пользователя WordPress и предоставляет методы для работы с его данными.
Пользователи
Обсуждение

Этот сайт использует cookie для хранения данных. Продолжая использовать сайт, Вы принимаете условия пользовательского соглашения и даете свое согласие на использование cookie.