get_post_meta с версии 1.5.0

Описание

Возвращает значение(я) определенного произвольного поля, указанного поста.

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

get_post_meta() используется в: get_post_thumbnail_id().

get_post_meta() работает на базе get_metadata().

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

<?php $meta_values = get_post_meta($post_id, $key, $single); ?>

Параметры

$post_id (число) (обязательный)

ID поста, произвольные поля которого нужно получить.
По умолчанию: нет

$key (строка) (обязательный)

Название произвольного поля, заначение которого нужно получить.
По умолчанию: нет

$single (логический)

Если выставить параметр в ture, то функция вернет единственное значение в виде строки. Если параметр будет равен false или не будет установлен, то функция вернет массив значений произвольных полей.
Однако, если в значении произвольного поля находится серриализованный массив, то занчение true вернет, нормальный массив, а если указать false, то вернется массив в элементе (например [0]) которого будет все тот же серриализованный массив. Т.е. в этом случае параметр работает "наоборот".
По умолчанию: false

Примеры

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

<?php $key_1_values = get_post_meta(76, 'key_1'); ?>

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

<?php $key_1_value = get_post_meta(76, 'key_1', true); ?>

3. Простой пример использования 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; ?>

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

<?php
/*******************
Эта функция обрабатывает два мета тега (произвольных поля): 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
} //Конец функции
?>

get_post_meta()

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

Связанные Функции

Ещё из раздела

Смотрите также: Функции WordPress и Теги Шаблона.