WP_GET_SITES() │ WP 3.7.0
Функция wp_get_sites()
была устарела в версии 4.6.0. Она больше не поддерживается и может быть удалена в будущих версиях. Вместо неё используйте функцию get_sites()
.
Что делает функция
Эта функция возвращает массив сайтов для одной или нескольких сетей.
Возврат Значений
- Array[]: Если установка считается "большой" (это проверяется с помощью функции
wp_is_large_network()
), возвращается пустой массив. В противном случае возвращается ассоциативный массив данных о сайтахWP_Site
.
Использование
Синтаксис
wp_get_sites( $args );
Параметры
Параметр $args
— это массив настроек для запроса (опционально).
По умолчанию он пустой (array()
).
-
network_id (int|int[]): ID сети или массив ID сетей. Установите в null, чтобы получить сайты из всех сетей.
- По умолчанию: текущий ID сети.
-
public (int): Получить публичные или непубличные сайты.
- По умолчанию: null, для любых.
-
archived (int): Получить архивированные или не архивированные сайты.
- По умолчанию: null, для любых.
-
mature (int): Получить зрелые или незрелые сайты.
- По умолчанию: null, для любых.
-
spam (int): Получить спам-сайты или не спам-сайты.
- По умолчанию: null, для любых.
-
deleted (int): Получить удалённые или не удалённые сайты.
- По умолчанию: null, для любых.
-
limit (int): Ограничение на количество возвращаемых сайтов.
- По умолчанию: 100.
-
offset (int): Пропустить первые x сайтов. Используйте вместе с параметром
$limit
.
Примеры
Пример 1: Получение всех сайтов в сети
$array = wp_get_sites( array(
'network_id' => null,
'public' => null,
'archived' => null,
'mature' => null,
'spam' => null,
'deleted' => null,
'limit' => 100,
'offset' => 0,
) );
print_r( $array );
Этот код выведет массив, который может выглядеть следующим образом:
Array(
[0] => Array(
[blog_id] => 1
[site_id] => 1
[domain] => example.com
[path] => /
[registered] => 2013-11-08 17:56:46
[last_updated] => 2013-11-08 18:57:19
[public] => 1
[archived] => 0
[mature] => 0
[spam] => 0
[deleted] => 0
[lang_id] => 0
)
[1] => Array(
[blog_id] => 2
[site_id] => 1
[domain] => example.com
[path] => /examplesubsite/
[registered] => 2013-11-08 18:07:22
[last_updated] => 2013-11-08 18:13:40
[public] => 1
[archived] => 0
[mature] => 0
[spam] => 0
[deleted] => 0
[lang_id] => 0
)
)
Примечания
- Для получения информации о текущем сайте используйте функцию
get_sites()
.
Журнал изменений
- С версии 3.7.0: Введена в использование.
- С версии 4.6.0: Устарела. Используйте
get_sites()
.