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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(パラメータ: 一部訳)
3行目: 3行目:
 
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:
+
'''''': これは一般的な、ローレベルの関数であり、プラグインやテーマにより直接使用することはできません。 その代わりに、作業しているオブジェクトタイプに対応するメタ関数を使用します。
  
 
* [[関数リファレンス/add_post_meta|add_post_meta()]] 投稿、ページとカスタム投稿タイプに
 
* [[関数リファレンス/add_post_meta|add_post_meta()]] 投稿、ページとカスタム投稿タイプに
* [[関数リファレンス/add_user_meta|add_user_meta()]] ユーザーに
+
* [[関数リファレンス/add_user_meta|add_user_meta()]] /[[:en:Function_Reference/add_user_meta|en]] ユーザーに
* [[関数リファレンス/add_comment_meta|add_comment_meta()]] コメントに
+
* [[関数リファレンス/add_comment_meta|add_comment_meta()]] /[[:en:Function_Reference/add_comment_meta|en]] コメントに
  
 
== 使い方 ==
 
== 使い方 ==
23行目: 23行目:
 
== 戻り値 ==
 
== 戻り値 ==
  
{{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||boolean&#124;integer|失敗時に<tt>false</tt>を返します。成功すると、挿入された行のIDを返します。 However, note that the return value may instead be the result of the <tt>'add_{$meta_type}_metadata'</tt> filter.}}
  
 
== 注 ==
 
== 注 ==
29行目: 29行目:
 
* Uses: <tt>[[Class_Reference/wpdb | $wpdb]]</tt>
 
* Uses: <tt>[[Class_Reference/wpdb | $wpdb]]</tt>
 
* 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.
 
* 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.
* 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.
+
* Uses: <tt>[[関数リファレンス/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.
  
 
== 更新履歴 ==
 
== 更新履歴 ==

2015年6月21日 (日) 20:46時点における版

説明

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

: これは一般的な、ローレベルの関数であり、プラグインやテーマにより直接使用することはできません。 その代わりに、作業しているオブジェクトタイプに対応するメタ関数を使用します。

使い方

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

パラメータ

$meta_type
string) (必須) Type of object the metadata is for (e.g., コメント, 投稿, またはユーザー).常に単数。
初期値: なし
$object_id
integer) (必須) The ID of the object metadata is for.
初期値: なし
$meta_key
string) (必須) メタデータキー。 ('key'=>'value'として).
初期値: なし
$meta_value
string) (必須) メタデータキー。 ('key'=>'value'として).
初期値: なし
$unique
boolean) (オプション) This determines whether the specified key can have multiple entries for the specified object id. If false, add_metadata() will add duplicate keys to the object. If true, nothing will be added if the specified key already exists for the specified id.
初期値: False

戻り値

(boolean|integer) 
失敗時にfalseを返します。成功すると、挿入された行のIDを返します。 However, note that the return value may instead be the result of the 'add_{$meta_type}_metadata' filter.

  • Uses: $wpdb
  • Uses: apply_filters() - Calls 'add_{$meta_type}_metadata' with null and each of the parameters passed to the function. If the result of this filter call is anything other than null, the function will be short-circuited and the result will be returned.
  • Uses: do_action() - Calls 'added_{$meta_type}_meta' if the metadata was added successfully with the ID of the new row in the meta table and the first three function parameters.

更新履歴

ソースファイル

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

関連

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



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


このページ「関数リファレンス/add metadata」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

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