WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

get_post_meta() WP 1.5.0

Возвращает значение указанного произвольного поля записи (поста). Можно получить массив всех полей записи (поста).

Для того, чтобы получить значение всех произвольных полей определенного поста, нужно оставить пустым параметр $key. Также для этого можно воспользоваться функцией get_post_custom().

Если в данных содержится сериализованный массив (serialize), то он автоматом будет обработан функцией unserialize(), т.е. чтобы получить сериализованные данные их не нужно отдельно обрабатывать функцией unserialize().

Работает на основе: get_metadata()
✈ 1 раз = 0.00013с = быстро | 50000 раз = 1.0с = очень быстро

Хуков нет.

Возвращает

Строку/массив.

  • Вернет false, если неправильно переданы $meta_type или $object_id.

  • При $single = true

    • строка/массив — когда метаполе есть.
    • '' — когда метаполя нет.
  • При $single = false
    • массив значений метаполей — когда метаполе есть.
    • array() — когда метаполя нет.

Если в значении метаполя храниться число оно будет возвращено в виде строки, например, "54"...

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

$meta_values = get_post_meta( $post_id, $key, $single );
$post_id(число) (обязательный)
ID поста, произвольные поля которого нужно получить.
По умолчанию: нет
$key(строка) 
Название произвольного поля, значение которого нужно получить. Если оставить поле пустым, будут получены все произвольные поля поста.
По умолчанию: ''
$single(логический)

true - вернет значение метаполя (если полей несколько то вернет значение первого метаполя).
false - вернет массив всех значений мета полей с указанным ключом.

Если в значении произвольного поля находится сериализованный массив, то значение true вернет, нормальный массив, а если указать false, то вернется массив в элементе "[0]" которого будет все тот же сериализованный массив.

По умолчанию: false

Примеры

#1. Получим массив значений произвольных полей

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

$values = get_post_meta( 76, 'key_1' );
/*
Array
(
	[0] => значение 1
	[1] => значение 2
)
*/

#1.1. Получим все произвольные поля записи

Если не указать ключ произвольного поля для функции, то она получит все поля сразу:

$metas = get_post_meta( 76 );
/*
Array
(
	[_edit_lock] => Array
		(
			[0] => 1517175359:1
		)

	[_edit_last] => Array
		(
			[0] => 1
		)

	[views] => Array
		(
			[0] => 10164
		)

	[_thumbnail_id] => Array
		(
			[0] => 9556
		)

	[photo] => Array
		(
			[0] => https://wp-kama.ru/wp-content/uploads/2010/03/Quicktags-API.png
			[1] => https://wp-kama.ru/wp-content/uploads/2017/07/image.png
		)

)
*/

#2. Получим только одно произвольное поле

Чтобы получить только первое (или единственное) значение произвольного поля в виде строки, используем такой вызов функции:

$value = get_post_meta( 76, 'key_1', true ); //> значение 1

#3. Объединение всех метаполей в объект

Этот пример показывает как можно удобно объединить все произвольные поля записи.

Нужно это, когда в коде предполагается использовать много разных полей записи. Получать каждое с помощью этой функции не удобно, удобнее получить один раз все поля, создать из них объект и брать данные из объекта - это и работает быстрее, и кода меньше, и понятнее.

Подразумевается, что ключи произвольных полей не в кириллице и у поля с одним ключом предусмотрено только одно значение - все это обычное явление:

// соберем все метаполя в объект $meta
$meta = new stdClass;
foreach( (array) get_post_meta( $post->ID ) as $k => $v ) $meta->$k = $v[0];

// Теперь, допустим у записи есть метаполе 'book'
// Получаем его так:
echo $meta->book;

В WordPress есть незадокументированная возможность получать метаполе записи так: $post->my_meta_key, где $post - объект WP_Post, а my_meta_key - название метаполя, которое нужно получить.

#4. Пример использования get_post_meta() внутри Цикла WordPress.

Этот код пример того, как использовать функцию для того, чтобы получить значение произвольного поля thumb, в значении которого сохраняется ссылка на картинку-миниатюру, для того чтобы получить эту ссылку и использовать её в шаблоне.

<?php if ( get_post_meta($post->ID, 'thumb', true) ) : ?>
	<a href="<?php the_permalink() ?>" rel="bookmark">
		<img class="thumb" src="<?php echo get_post_meta($post->ID, 'thumb', true) ?>" alt="<?php the_title(); ?>" />
	</a>
<?php endif; ?>

#5. Проверим существование указанного метаполя

Когда нужно проверить существует ли поле, с любым значением: пустая строка или 0:

$metas = get_post_meta( $post->ID );
if( isset($metas['key_name']) ){
	echo 'Мета поле "key_name" существует, не важно какое там значение.';
}

#6. Использования функций произвольных полей на примере авторской функции

/**
 * Эта функция обрабатывает два мета тега (произвольных поля): `mood` и `listening_to`.
 * Она может быть вызвана тремя разными вариантами (действиями): update, delete и get (по умолчанию).
 * Когда функция работает как update (обновление), оба параметра $mood и $listening_to должны быть указаны.
 * Пример вызова: mood_music( $post->ID, 'update', 'Happy', 'Bon Jovi - It's My Life' );
 */
function mood_music( $post_id, $action = 'get', $mood = 0, $listening_to = 0 ){

	// Проверка (switch) какое из действий нужно выполнять update, delete или get
	switch( $action ){

		case 'update' :
			// Если не переданы данные для обновления, останавливаемся
			if( ! $mood && ! $listening_to ){
				return false;
			}

			// Использование функции add_post_meta():
			// add_post_meta( $post_id, $meta_key, $meta_value, $unique = false )

			// Если передана переменная $mood, создаем произвольное
			// поле 'mood', со значением этой переменной.
			// Если такое произвольное поле уже существует,
			// то эта команда создаст еще одну мета запись
			if( $mood ){
				add_post_meta( $post_id, 'mood', $mood );

				return true;
			}
			// Использование функции update_post_meta():
			// update_post_meta( $post_id, $meta_key, $meta_value )

			// Если передана переменная $listening_to, создаем произвольное
			// поле 'listening_to', со значением этой переменной.
			// Если такое произвольное поле уже существует, то эта команда
			// обновит его данные на новое значение переданное в переменной $listening_to.
			if( $listening_to ){
				add_post_meta( $post_id, 'listening_to', $listening_to, true ) or
				update_post_meta( $post_id, 'listening_to', $listening_to );

				return true;
			}

		case 'delete' :
			// Использование функции delete_post_meta:
			// delete_post_meta( $post_id, $meta_key, $prev_value = "" )

			// Удаляем все произвольные поля с ключами mood и listening_to у указанного поста.
			delete_post_meta( $post_id, 'mood' );
			delete_post_meta( $post_id, 'listening_to' );

			// Если нужно удалить только поле 'mood' со значением "sad", используем такой код:
			// delete_post_meta( $post_id, 'mood', 'sad' );
			break;

		case 'get' :
			// Использование функции get_post_custom():
			// get_post_meta( $post_id, $meta_key, $single value = false )

			// $stored_moods будет массивом содержащим все значения произвольных полей с ключом 'mood'
			$stored_moods = get_post_meta( $post_id, 'mood' );
			// $stored_listening_to будет значением первого произвольного поля 'listening_to'
			// (подразумевается, что таких полей несколько)
			$stored_listening_to = get_post_meta( $post_id, 'listening_to', true );

			// Теперь нам нужно вывести на экран настроение (mood), для этого
			// мы должны вызвать эту функцию в шаблоне так:
			// пример: echo mood_music( $post->ID, 'get' );

			$return = '<div class="mood-music">';
			if( ! empty( $stored_moods ) ){
				$return .= '<strong>Мое Настроение</strong>: ';
			}
			foreach( $stored_moods as $mood ){
				$return .= "$mood, ";
			}
			$return .= '<br/>';

			if( ! empty( $stored_listening_to ) ){
				$return .= '<strong>Сейчас я слушаю</strong>: ';
				$return .= $stored_listening_to;
			}
			$return .= '</div>';

			return $return;

		default :
			return false;
			break;

	} // Конец проверки switch

}

7. Вывод всех произвольных полей всех записей

Этот пример показывает как одним запросом вывести все уникальные произвольные поля и посчитать сколько всего их используется в БД. Такой запрос может пригодится для профилирования произвольных полей записей:

global $wpdb;
$data = $wpdb->get_results("SELECT meta_key, count(*) as count FROM $wpdb->postmeta WHERE meta_key NOT LIKE '\_oembed%' GROUP BY meta_key");
print_r( $data );
/*
Array (
	[0] => stdClass Object (
			[meta_key] => _edit_lock
			[count] => 2300
		)

	[1] => stdClass Object (
			[meta_key] => _edit_last
			[count] => 2123
		)
	...
)
*/

Код get_post_meta: wp-includes/post.php VER 5.0.1

<?php
function get_post_meta( $post_id, $key = '', $single = false ) {
	return get_metadata('post', $post_id, $key, $single);
}

Cвязанные функции

Из метки: metadata (метаданные)

54 коммента
Полезные 1 Вопросы 2 Все
  • @ Макс

    Здравствуйте, у меня поля выдает плагин wp-job-manager, получается редактировать нужно код данного плагина, вы беретесь за такую работу? help

    Ответить2 мес назад #
Здравствуйте, !     Войти . Зарегистрироваться