get_metadata() - 指定したオブジェクトのメタデータを取得する

公開日: 2016/12/22

get_metadata()は、指定したオブジェクトとIDのコンテンツに紐付けられたカスタムフィールドなどのメタデータを取得する関数です。

構文

mixed get_metadata( string $meta_type, int $object_id, string $meta_key = '', bool $single = false )

パラメータ

$meta_type

オブジェクトの種類。投稿や固定ページだったらpost、ユーザーだったらuser、コメントだったらcommentなど。

$object_id

対象コンテンツのID。

$meta_key

初期値: ''

取得するカスタムフィールドのキー名。指定しない場合、全てのカスタムフィールドを取得する。

$single

初期値: false

通常、各カスタムフィールドの値は配列形式になっているが、第3引数でtrueを指定すると、文字列で返す。ケースによっては、取得した値をそのまま利用できる利点などがある。

返り値

mixed

キー名を指定した場合、そのキー名のメタデータを取得する。

第3引数でキー名を指定しなかった場合、オブジェクトに紐付けられている全てのメタデータを含んだ配列を取得する。

第4引数でtrueを指定した場合、値は配列ではなく文字列で返る。

関数

この関数内で利用している、別のWordPress関数です。

absint() - 数字を絶対値に変換する。
apply_filters() - フィルターイベントを発火する。
maybe_unserialize()
update_meta_cache()
wp_cache_get()

フック

関数内で呼び出されるイベントです。

フィルター

get_{$meta_type}_metadata

サンプルコード

投稿

投稿オブジェクト(post)の、IDが11(リンク)のコンテンツに紐付けられたメタデータを取得します。

php

<?php
	// 実行
	$result = get_metadata( "post", 11 ) ;

	// 結果
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.13

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

    [_edit_lock] => Array
        (
            [0] => 1481696435:1
        )

    [enclosure] => Array
        (
            [0] => https://wp.syncer.jp/wp-content/uploads/2016/12/cute-dog.mp4
244970
video/mp4

        )

)

ユーザー

IDが1のユーザー(user)に紐付けられたメタデータを取得します。

php

<?php
	// 実行
	$result = get_metadata( "user", 1 ) ;

	// 結果
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.13

特定のメタデータ

第3引数でキー名を指定することで、特定のメタデータだけを取得できます。

php

<?php
	// 実行
	$result = get_metadata( "user", 1, "nickname" ) ;

	// 結果
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.13

Array
(
    [0] => syncer
)

文字列で取得

先ほどと同じメタデータですが、第4引数にtrueを指定することで、配列ではなく文字列で値を取得します。

php

<?php
	// 実行
	$result = get_metadata( "user", 1, "nickname", true ) ;

	// 結果
	print_r( $result ) ;

結果 (出力内容) - PHP7.0.13

syncer

ソースコード

wp-includes/meta.php

/**
 * Retrieve metadata for the specified object.
 *
 * @since 2.9.0
 *
 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
 * @param int    $object_id ID of the object metadata is for
 * @param string $meta_key  Optional. Metadata key. If not specified, retrieve all metadata for
 * 		                    the specified object.
 * @param bool   $single    Optional, default is false.
 *                          If true, return only the first value of the specified meta_key.
 *                          This parameter has no effect if meta_key is not specified.
 * @return mixed Single metadata value, or array of values
 */
function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
	if ( ! $meta_type || ! is_numeric( $object_id ) ) {
		return false;
	}

	$object_id = absint( $object_id );
	if ( ! $object_id ) {
		return false;
	}

	/**
	 * Filters whether to retrieve metadata of a specific type.
	 *
	 * The dynamic portion of the hook, `$meta_type`, refers to the meta
	 * object type (comment, post, or user). Returning a non-null value
	 * will effectively short-circuit the function.
	 *
	 * @since 3.1.0
	 *
	 * @param null|array|string $value     The value get_metadata() should return - a single metadata value,
	 *                                     or an array of values.
	 * @param int               $object_id Object ID.
	 * @param string            $meta_key  Meta key.
	 * @param bool              $single    Whether to return only the first value of the specified $meta_key.
	 */
	$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );
	if ( null !== $check ) {
		if ( $single && is_array( $check ) )
			return $check[0];
		else
			return $check;
	}

	$meta_cache = wp_cache_get($object_id, $meta_type . '_meta');

	if ( !$meta_cache ) {
		$meta_cache = update_meta_cache( $meta_type, array( $object_id ) );
		$meta_cache = $meta_cache[$object_id];
	}

	if ( ! $meta_key ) {
		return $meta_cache;
	}

	if ( isset($meta_cache[$meta_key]) ) {
		if ( $single )
			return maybe_unserialize( $meta_cache[$meta_key][0] );
		else
			return array_map('maybe_unserialize', $meta_cache[$meta_key]);
	}

	if ($single)
		return '';
	else
		return array();
}

参考リンク

WordPress 関数リファレンス - 公式マニュアル。