当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/add metadata」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(パラメータ: 一部訳)
(パラメータ: $meta_value 誤記訂正。)
 
(2人の利用者による、間の3版が非表示)
1行目: 1行目:
 +
{{CheckTrans}}
 +
 +
<div id="Description">
 
== 説明 ==
 
== 説明 ==
 +
</div>
  
WordPressで指定されたオブジェクトのメタデータを追加します。
+
WordPress 内の指定されたオブジェクトへメタデータを追加します。
  
'''NOTE''': This is a generic, low level function and should '''not''' be used directly by plugins or themes. Instead, use the corresponding meta functions for the object type you're working with:
+
<div class="information">
 +
'''''': これは汎用でローレベルの関数であり、プラグインやテーマにより直接使用することは'''避けてください'''。 その代わりに、作業しているオブジェクトタイプに対応するメタ関数を使用してください。
  
* [[関数リファレンス/add_post_meta|add_post_meta()]] 投稿、ページとカスタム投稿タイプに
+
* [[関数リファレンス/add_post_meta|add_post_meta()]] &ndash; 投稿、固定ページとカスタム投稿タイプ
* [[関数リファレンス/add_user_meta|add_user_meta()]] ユーザーに
+
* [[関数リファレンス/add_user_meta|add_user_meta()]] /[[:en:Function_Reference/add_user_meta|en]] &ndash; ユーザー
* [[関数リファレンス/add_comment_meta|add_comment_meta()]] コメントに
+
* [[関数リファレンス/add_comment_meta|add_comment_meta()]] /[[:en:Function_Reference/add_comment_meta|en]] &ndash; コメント
 +
</div>
  
 +
<div id="Usage">
 
== 使い方 ==
 
== 使い方 ==
 +
</div>
  
 
  <?php add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique ); ?>
 
  <?php add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique ); ?>
  
 +
<div id="Parameters">
 
== パラメータ ==
 
== パラメータ ==
 +
</div>
  
{{Parameter|$meta_type|string|Type of object the metadata is for (e.g., コメント, 投稿, またはユーザー).常に単数。}}
+
{{Parameter|$meta_type|文字列|メタデータをつけるオブジェクトの種類(例えば、コメントなら <tt>'comment'</tt>、投稿なら <tt>'post'</tt>、ユーザーなら <tt>'user'</tt>)。常に単数形。}}
{{Parameter|$object_id|integer|The ID of the object metadata is for.}}
+
{{Parameter|$object_id|整数|メタデータをつけるオブジェクトの ID。}}
{{Parameter|$meta_key|string|メタデータキー。 ('key'&#61;>'value'として).}}
+
{{Parameter|$meta_key|文字列|メタデータのキー('キー' &#61;> '' として)。}}
{{Parameter|$meta_value|string|メタデータキー。 ('key'&#61;>'value'として).}}
+
{{Parameter|$meta_value|文字列|メタデータの値('キー' &#61;> '' として)。スカラー値でないときはシリアル化しなければならない。}}
{{Parameter|$unique|boolean|This determines whether the specified key can have multiple entries for the specified object id. If false, <tt>add_metadata()</tt> will add duplicate keys to the object. If true, nothing will be added if the specified key already exists for the specified id.|オプション|False}}
+
{{Parameter|$unique|真偽値|指定された ID のオブジェクトについて、このキーを持つメタデータがユニークであるかどうか。true の場合、指定された ID のオブジェクトに同じキーのメタデータが既にあれば追加しない。false の場合、同じキーで複数追加する。|オプション|false}}
  
 +
<div id="Return Values">
 
== 戻り値 ==
 
== 戻り値 ==
 +
</div>
  
{{Return||boolean&#124;integer|Returns <tt>false</tt> on failure. On success, returns the ID of the inserted row. However, note that the return value may instead be the result of the <tt>'add_{$meta_type}_metadata'</tt> filter.}}
+
{{Return||真偽値&#124;整数|失敗すると <tt>false</tt> を返します。成功すると、挿入された行(メタデータ)の ID を返します。ただし、戻り値は <tt>'add_{$meta_type}_metadata'</tt> フィルターの結果になる場合があります。}}
  
== ==
+
<div id="Notes">
 +
== 参考 ==
 +
</div>
  
* Uses: <tt>[[Class_Reference/wpdb | $wpdb]]</tt>
+
* <tt>[[関数リファレンス/wpdb Class|$wpdb]]</tt> /[[:en:Class_Reference/wpdb|en]] を使用します。
* Uses: <tt>[[関数リファレンス/apply_filters | apply_filters()]]</tt> - Calls <tt>'add_{$meta_type}_metadata'</tt> with <tt>null</tt> and each of the parameters passed to the function. If the result of this filter call is anything other than <tt>null</tt>, the function will be short-circuited and the result will be returned.
+
* <tt>[[関数リファレンス/apply_filters|apply_filters()]]</tt> を使って <tt>'add_{$meta_type}_metadata'</tt> フィルターを呼び出します。引数は <tt>null</tt> と、この関数へ渡されたパラメータです。そしてフィルターの戻り値が <tt>null</tt> でなければ、この関数はそれ以上なにもせずに、その値を返します。
* Uses: <tt>[[Function_Reference/do_action | do_action()]]</tt> - Calls <tt>'added_{$meta_type}_meta'</tt> if the metadata was added successfully with the ID of the new row in the meta table and the first three function parameters.
+
* メタデータの追加に成功すると、<tt>[[関数リファレンス/do_action|do_action()]]</tt> を使って <tt>'added_{$meta_type}_meta'</tt> アクションを呼び出します。パラメータは meta テーブルの新しい行の ID と、この関数のパラメータの先頭から 3 つです。
  
== 更新履歴 ==
+
<div id="Change Log">
 +
== 変更履歴 ==
 +
</div>
  
 
* 新規導入: [[Version 2.9|2.9.0]]
 
* 新規導入: [[Version 2.9|2.9.0]]
  
 +
<div id="Source File">
 
== ソースファイル ==
 
== ソースファイル ==
 +
</div>
  
<tt>add_metadata()</tt> は {{Trac|wp-includes/meta.php}}にあります。
+
<tt>add_metadata()</tt> は {{Trac|wp-includes/meta.php}} にあります。
  
== 関連 ==
+
<div id="Related">
 +
== 関連項目 ==
 +
</div>
  
 
{{Metadata API}}
 
{{Metadata API}}
45行目: 65行目:
 
{{Tag Footer}}
 
{{Tag Footer}}
  
{{NeedTrans}}
+
{{原文|Function Reference/add_metadata|153482}} <!-- 02:19, 18 August 2015 Miccweb 版 -->
  
{{原文|Function Reference/add_metadata|149887}} <!-- 19:31, 2 March 2015‎ Thenbrent  版 -->
+
[[en:Function_Reference/add metadata]]

2015年8月29日 (土) 11:06時点における最新版

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

WordPress 内の指定されたオブジェクトへメタデータを追加します。

: これは汎用でローレベルの関数であり、プラグインやテーマにより直接使用することは避けてください。 その代わりに、作業しているオブジェクトタイプに対応するメタ関数を使用してください。

使い方

<?php add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique ); ?>

パラメータ

$meta_type
文字列) (必須) メタデータをつけるオブジェクトの種類(例えば、コメントなら 'comment'、投稿なら 'post'、ユーザーなら 'user')。常に単数形。
初期値: なし
$object_id
整数) (必須) メタデータをつけるオブジェクトの ID。
初期値: なし
$meta_key
文字列) (必須) メタデータのキー('キー' => '値' として)。
初期値: なし
$meta_value
文字列) (必須) メタデータの値('キー' => '値' として)。スカラー値でないときはシリアル化しなければならない。
初期値: なし
$unique
真偽値) (オプション) 指定された ID のオブジェクトについて、このキーを持つメタデータがユニークであるかどうか。true の場合、指定された ID のオブジェクトに同じキーのメタデータが既にあれば追加しない。false の場合、同じキーで複数追加する。
初期値: false

戻り値

(真偽値|整数) 
失敗すると false を返します。成功すると、挿入された行(メタデータ)の ID を返します。ただし、戻り値は 'add_{$meta_type}_metadata' フィルターの結果になる場合があります。

参考

  • $wpdb /en を使用します。
  • apply_filters() を使って 'add_{$meta_type}_metadata' フィルターを呼び出します。引数は null と、この関数へ渡されたパラメータです。そしてフィルターの戻り値が null でなければ、この関数はそれ以上なにもせずに、その値を返します。
  • メタデータの追加に成功すると、do_action() を使って 'added_{$meta_type}_meta' アクションを呼び出します。パラメータは meta テーブルの新しい行の ID と、この関数のパラメータの先頭から 3 つです。

変更履歴

ソースファイル

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

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



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


最新英語版: WordPress Codex » Function Reference/add_metadata最新版との差分