WordPress как на ладони
wordpress jino

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
)
*/

#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 4.9.4

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

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

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

Еще из раздела: Произвольные поля (postmeta)

get_post_meta 51 коммент
Полезные 1 Вопросы 2 Все
  • Дмитрий

    Здравствуйте! А есть возможность передать значение произвольного поля в php обработчик формы обратной связи. Там у меня email адреса хранятся и нужно чтобы по клику "Написать сообщение" email подставлялся в обработчик и письмо отправлялось указанному адресату. В каждой записи email в произвольном поле разный. Спасибо!

    Ответить2.5 года назад #
    • Kama5064

      Я думаю это не очень безопасно, лучше передать ID поста и уже в самом обработчике получить email из поля зная ID поста с помощью get_post_meta():

      get_post_meta( $post_id, 'Ключ_где_email', 1 );
      1
      Ответить2.5 года назад #
  • Алёна

    Здравствуйте!
    Спасибо за статью, пол дела сделано.

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

    Пыталась как-то так, но дальше не могу сообразить.

    <?php
    	$key_1_value = get_post_meta(get_the_ID(), 'thumbs_rating_up', true);
    
    	$array = explode(' ', $key_1_value);
    	print_r($array);
    ?>

    В переменной $key_1_value появляется строка "50 50" значение поля из каждого поста через пробел. Хотела разбить строку используя пробел и сложить цифры что бы получилось 100.

    Можете помочь? куда капать smile

    Ответить2 года назад #
    • Kama5064
      $key_1_value = get_post_meta(get_the_ID(), 'thumbs_rating_up', true);
      
      $array = explode(' ', $key_1_value );
      $sum = array_sum( $array );
      echo $sum; //> 100
      1
      Ответить2 года назад #
  • avense5 cайт: videovegas.ru

    Не пойму как проверить существование произвольного поля у заданного поста:

    if( get_post_meta(54, 'custom_key_1', true) ) {...}

    Данное условие сработает выдаст false если такого поля нету, но в то же время выдаст и false если такое поле есть, но оно пустое или содержит ноль "0".
    А как модно проверить есть ли такое поле у заданного поста вообще, хоть пустое, хоть какое?

    1
    Ответить1.7 года назад #
    • Kama5064
      $metas = get_post_meta(1);
      if( isset($metas['custom_key_1']) ){
      	echo 'Мета поле существует, не важно какое там значение.';
      }
      2
      Ответить1.7 года назад #
      • Встречный вопрос - если, допустим, я уверен, что поле есть, оно текстовое, но выводить html необходимо только в случае, если это поле содержит какое то значение.

        Есть чтото типа такого

        if(has_post_meta_content('wordicon')){
        	$content .= '<mnogokoda><img src="/wp-content/uploads/icons/'. get_post_meta(get_the_ID(), 'wordicon', true)  .'"></mnogokoda>'
        }

        тоесть по сути, я хочу сделать проверку на наличие внутри метаданных какого либо значения/ Есть ли такая функция?

        1
        Ответить4 месяца назад #
        • Я правильно понимаю, что достаточно сделать вот такую проверку

          if (get_post_meta($post->ID, 'wordicon', true) !== '') 
          Ответить4 месяца назад #
          • campusboy2657 cайт: www.youtube.com/c/wpplus

            Пустая строка автоматом даёт false. Это же php smile так что можно просто:

            if ( get_post_meta($post->ID, 'wordicon', true) ) 
            2
            Ответить4 месяца назад #
  • @ Ян cайт: codyshop.ru

    Делаю как вы говорите:<?php echo get_post_meta($post->ID, 'price', true); ?>, но произвольные поля не выводитsad
    Если так:<?php echo the_meta($post->ID, 'price', true); ?>, то выводит все целиком

    Ответить1.7 года назад #
    • Kama5064

      Первый вариант правильный, там либо $post->ID не тот либо такого метаполя нет у записи... Другого быть не может...

      Ответить1.7 года назад #
  • @ Ян cайт: codyshop.ru

    Добрый день. У меня к записи прикреплено порядка 20 произвольных полей. get_post_meta() - это единственный способ вывода данных полей по отдельности? Изучаю, как оптимизировать запросы к бд.

    Ответить1.7 года назад #
    • Kama5064

      Во-первых get_post_meta() не создает запросы, а берет все из кэша. Кэш создается при первом вызове. Дальше все очень быстро работает.

      Во-вторых, можно получить сразу все поля так:

      $all_metas = get_post_meta( $post_id );

      Но там все во вложенных массивах, не очень удобно, поэтмоу удобнее еще обработать. Как? Смотрите пример 3...

      Ответить1.7 года назад #
  • Геннадий

    Здравствуйте Кама!

    Сайт у Вас великолепный

    Не давно занимаюсь WP. Очень нужна помощь!!!

    Собираю одностраничник
    Вопрос по теме - нужно вывести на страницу вопросник,
    через произвольные поля: вопрос - ответ - текст произвольный
    получается 3 произвольные поля с разными ключами и значением

    Я, от незнания, вывожу через get_post_meta( $post_id, $key, true)
    Получается сколько вопросов - столько и записей/постов
    Записи привязаны к рубрике, выводятся через цикл

    Вопрос: Как вывести через массив, (третий параметр - false)
    чтоб можно было написать на одной странице, а не на 15-20

    Так как я новичок (пока), по возможности, можно поподробнее
    Или может есть статья на Вашем сайте, а я ее просто не нашел
    Желательно с конкретным примером, т.к. уверен что многие
    "утопают" именно в таких вещах

    За ранее спасибо!

    Ответитьгод назад #
    • campusboy2657 cайт: www.youtube.com/c/wpplus

      Привет! А зачем было создавать запись ради дополнительного поля в ней? smile Надо было хотя бы сделать Заголовок записи - это вопрос, контент записи - это ответ. И не надо произвольных полей тогда.

      Насчёт вопроса, я бы посоветовал новичку использовать плагин ACF PRO, который имеет произвольное поле типа повторитель (repeater) - видео с примерами кода.

      1
      Ответитьгод назад #
      • Геннадий

        Спасибо за ответ,НО, мне нужно понять как работают мета поля, а про плагин ACF и ACF PRO - я знаю. Мне на много проще понять по конкретному примеру
        Позвольте повторить вопрос:

        Есть 3 произвольных поля с разными ключами (обычные ПП WP):
        1) вопрос
        2) ответ
        3) текст - какой-то произвольный текст

        и 15-20 значения для каждого ключа

        Вопрос: Как вывести через массив, так, чтоб они стали корректно -
        ВОПРОС --- ОТВЕТ --- ТЕКСТ
        ВОПРОС --- ОТВЕТ --- ТЕКСТ
        и т.д все 15 шт.

        Ну, типа FAQ, т.е. все уже написано на сайт
        НЕ посетитель пишет - это не опрос

        Например: тема сайта подвесные потолки
        Вопрос: Как сильно опустится потолок?
        Ответ: Потолок опустится незначительно
        Текст: мелким текстом - Подробности посмотрите на ...
        (иногда есть поле ТЕКСТ, а иногда его нету)

        Поля будут меняться, удалятся в процессе работы
        Поэтому хочется 1 раз написать и управлять из админки (т.е ПП страницы)

        Заранее спасибо!

        Ответитьгод назад #
        • Kama5064

          Если я все правильно понял. Тут возможно проще в одно произвольное поле добавлять массив: вопрос - ответ - текст. Далее сделать это поле мульти. И потом просто получать мульти поле и обрабатывать все это для вывода...

          Минус массива данных в поле - это не возможность потом сортировать по значению. Но тут это вроде бы и не нужно...

          Ответитьгод назад #
  • Руслан

    Доброго времени суток.

    Есть изначальный код:
    $address = get_post_meta($post->ID, 'google', true);

    То есть он берет данные из произвольного поля поста, которое назывется google

    Суть в том, что у меня уже есть поле c названием Google_maps в посте, не в поле с произвольными полями, а в основной части.

    Когда я пишу код:
    $address = get_post_meta($post->ID, 'Google_maps', true);
    ничего не происходит, почему-то не вытаскиваются данные из этого поля.

  • Добрый день. Помогите пожалуйста решить один вопрос.
    Столкнулся с такой проблемой:
    У меня есть отдельный php файл в котором необходимо получить данные из базы содержащиеся в post_meta, формируя переменную
    $color = get_post_meta( $post->ID, '_color' );
    Все дело в том что в этом файле не работает $post->ID и соответственно у меня не получается извлечь необходимую мне информаци. Если я подставляю вместо $post->ID, ID определенной страницы то информация извлекается на отлично. Проблема в том что страницы могут быть разными и значения данного поля будет тоже отличаться(( Как то можно передать ID страницы, в отдельный PHP файл?

  • Здравствуйте !
    На моем сайте есть плагин Advanced Custom Fields произвольные поля им созданные и они прекрасно работают и выводятся в нужном месте шаблона с помощью такого кода

    <?php the_field('preview_images'); ?>

    Прошу подскажите как мне заполнить данное поле ?
    В обработчике событий есть код которые заполняет стандартные поля !

    <?php
    if(isset($_POST['send']) == '1') {
     $post_title = $_POST['title'];
     $post_category = $_POST['cat'];
     $post_content = $_POST['description'];
    
     $new_post = array(
     'ID' => '',
     'post_author' => $user->ID,
     'post_category' => array($post_category),
     'post_content' => $post_content,
     'post_title' => $post_title,
     'post_status' => 'publish'
     );
    
     $post_id = wp_insert_post($new_post);
    
     // This will redirect you to the newly created post
     $post = get_post($post_id);
     wp_redirect($post->guid);
    }
    ?>

    Подскажите новичку что нужно добавить в обработчик чтобы заполнить кастомное поле плагина через форму ввода !? scratch_one-s_head

    Ответить4 месяца назад #
  • Илья

    А как подобный объект сделать глобальным?

    // соберем все метаполя в объект $meta
    $meta = new stdClass;
    foreach( (array) get_post_meta( $post->ID ) as $k => $v ) $meta->$k = $v[0];
    
    // Теперь, допустим у записи есть метаполе 'book'
    // Получаем его так:
    echo $meta->book;

    К примеру, я описываю функцию, в которой хочу использовать echo $meta->book.

    function create_book( $one ){
    	global $post;
    	if ( empty($meta->book) ) {
    		update_post_meta( $post->ID, 'book', $one );
    	}
    }
    

    И таких функций от 10 и больше. Как сделать так, чтобы не класть внутрь каждой функции конструкцию:

    $meta = new stdClass;
    foreach( (array) get_post_meta( $post->ID ) as $k => $v ) $meta->$k = $v[0];
    

    А вывести её один раз вверху страницы, а затем echo $meta->book; была видна внутри этих функций? Полдня потратил, не понял, возможно ли такое вообще.

    Ответить3 месяца назад #
    • Илья

      Намучился с этим кодом и чего мне не нравился стандартный вывод smile

      Код иногда приводит к фатальным ошибкам:
      Fatal error: Cannot access empty property in.

      Похоже не нравится это место:
      $meta->$k = $v[0]

      Как я понял, с точки зрения классов это неверная конструкция, потому что во втором значении ожидается без доллара $meta->$k, но тогда код не будет работать.

      Ответить3 месяца назад #
      • Kama5064

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

        Ответить3 месяца назад #

Здравствуйте, !

Ваш комментарий
Предпросмотр