• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get metadata

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「関数リファレンス/get metadata」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

指定されたオブジェクトからメタデータを取得します。

使い方

<?php get_metadata( $meta_type, $object_id, $meta_key, $single ) ?>

パラメータ

$meta_type
文字列) (必須) メタデータがついたオブジェクトの種類(例えばコメントなら 'comment'、投稿なら 'post'、ユーザーなら 'user')。
初期値: なし
$object_id
整数) (必須) メタデータがついたオブジェクトの ID。
初期値: なし
$meta_key
文字列) (オプション) メタデータのキー。指定しなければ、オブジェクトについたすべてのメタデータを取得する。
初期値: ''
$single
真偽値) (オプション) true の場合、指定されたキーの最初の値だけを返す。$meta_key を指定しない場合、このパラメータは無視される。
初期値: false

戻り値

(文字列/配列/真偽値) 
単一のメタデータの値、または値の配列。もし $meta_type または $object_id が無効なら false を返す。もしメタデータの値がセットされていなければ空の文字列または配列が返される。

参考

  • apply_filters() を使って 'get_{$meta_type}_metadata' /en フィルターを呼び出します。引数は null$object_id$meta_key$single です。そしてフィルターの戻り値が null でなければその値が返され、データベースとキャッシュはクエリされません。注意: フィルターから返したい値が配列なら、それをもう一つの配列へ入れて返す必要があります。ticket #22342 を見てください。
  • maybe_unserialize() /en を使って、返す前にメタデータを非シリアル化します。
  • データが非シリアル化できないために false を返す場合があります。これはメタデータの値が手作業で変更されたときによく発生します(例えばデータベースを新しいドメイン名へ引っ越すためにすべての URL を置換するとき)。

変更履歴

新規導入: 2.9

ソースファイル

get_metadata()wp-includes/meta.php にあります。

メタデータ API: add_metadata(), get_metadata() /en, update_metadata() /en, delete_metadata() /en


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function_Reference/get_metadata最新版との差分