Функция GET_POST_CUSTOM_KEYS() в WordPress: описание и примеры

Функция GET_POST_CUSTOM_KEYS() │ WP 1.2.0

Эта функция позволяет получить имена метаполей для поста в WordPress. Если у поста нет метаполей, функция вернет значение null.

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

Функция get_post_custom_keys() используется вместе с другой функцией get_post_custom().

Возвращаемое значение

Функция возвращает массив или null. В случае успешного выполнения возвратится массив ключей метаполей.

Синтаксис

get_post_custom_keys( $post_id );
  • $post_id (int) — Идентификатор поста. По умолчанию используется ID глобального $post.

Примеры использования

Пример 1: Получение ключей метаполей текущего поста

В этом примере создается переменная $custom_field_keys, которая будет содержать массив с ключами пользовательских полей текущего поста. Затем эти ключи выводятся на экран.

$custom_field_keys = get_post_custom_keys();

foreach ( $custom_field_keys as $key => $value ) {

    $val = trim( $value );
    if ( '_' === $val[0] ) {
        continue; // Пропустить скрытые поля
    }

    echo "$key => $value
"; } /* Результат: Предположим, что у поста есть пользовательские поля с именами 'mykey' и 'yourkey', тогда на экране будет выведено: 0 => mykey 1 => yourkey */

Примечание: Если убрать условие if ( '_' === $val[0] ) из цикла, то также будут показываться внутренние поля поста, которые использует WordPress, такие как _edit_last и _edit_lock. Это условие необходимо, чтобы исключить такие ключи метаполей.

Изменения

  • С версии 1.2.0 — Функция была представлена в WordPress.

Код функции

function get_post_custom_keys( $post_id = 0 ) {
    $custom = get_post_custom( $post_id );

    if ( ! is_array( $custom ) ) {
        return;
    }

    $keys = array_keys( $custom );
    if ( $keys ) {
        return $keys;
    }
}

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

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

  • add_post_meta()
  • get_post_meta()
  • delete_post_meta()
  • get_post_custom()
  • get_post_custom_values()

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

Leave a Reply

Ваш адрес email не будет опубликован. Обязательные поля помечены *