get_site_meta()
Получает значение метаполя сайта в сети мультисайт. Позволяет также получить все метаполя.
Работает с таблицей wp_blogmeta
появившейся в версии 5.1.
Это обёртка для функции get_metadata().
Хуков нет.
Возвращает
Разное
.
Если в значении метаполя хранится число оно будет возвращено в виде строки, например, "54"
...
- Вернет
false
, если неправильно передан $site_id. - При $single = true
строка/массив
— когда метаполе есть.''
— когда метаполя нет.
- При $single = false
массив значений метаполей
— когда метаполе есть.array()
— когда метаполя нет.
Использование
get_site_meta( $site_id, $key, $single );
- $site_id(число) (обязательный)
- ID сайта/блога.
- $key(строка)
- Название метаполя. Если не указать этот параметр, будут возвращены все значения всех метаполей объекта.
По умолчанию: '' - $single(true/false)
Вернуть ли единственное значение или нет?
true
— вернет значение метаполя в виде строки или массива (если в значении метаполя находится сериализованный массив). При наличии нескольких метаполей с одинаковым ключом, вернется значение первого метаполя.false
— вернет массив со значениями всех метаполей указанного ключа. В этом случае все значения будет строками, даже когда в значении находится сериализованный массив (преобразовывать его в массив нужно вручную).По умолчанию: false
Примеры
#1 Как использовать
// получим мета поле сайта с ID 17, сразу в переменную $blog_meta = get_site_meta( 17, 'mykey', true ); // Получим все значения метаполя (с одинаковым ключом) в виде массива $blog_meta = get_site_meta( 14, 'mykey' ); // Получим все метаданные сайта с ID 115, в виде массива $blog_metas = get_site_meta( 115 );
#2 Еще примеры
Смотрите в описании get_post_meta().
Список изменений
С версии 5.1.0 | Введена. |
Код get_site_meta() get site meta WP 6.8.1
function get_site_meta( $site_id, $key = '', $single = false ) { return get_metadata( 'blog', $site_id, $key, $single ); }