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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/add post meta 13:18, 9 November 2009 GeertDD)
 
(全体を和訳)
1行目: 1行目:
==Description==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
'''add_post_meta''' adds a custom (meta) field to the specified post (or page).
+
'''add_post_meta''' は、指定した記事や固定ページにカスタム(メタ)フィールドを追加します。
  
If the <tt>$unique</tt> parameter is set to <var>true</var> and the specified meta key already exists, the function returns <var>false</var> and makes no changes; otherwise, it returns <var>true</var>.
+
<tt>$unique</tt> パラメータに <var>true</var> を指定しており、そのメタキーが既に存在している場合、この関数は <var>false</var> を返し何もしません。それ以外の場合は、カスタムフィールドを追加し <var>true</var> を返します。
  
==Usage==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
%%% <?php add_post_meta($post_id, $meta_key, $meta_value, $unique); ?> %%%
+
<?php add_post_meta($post_id, $meta_key, $meta_value, $unique); ?>
  
==Parameters==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$post_id|integer|The ID of the post to which you will add a custom field.}}
+
{{Parameter|$post_id|整数|カスタムフィールドを追加する投稿の ID。}}
{{Parameter|$meta_key|string|The key of the custom field you will add.}}
+
{{Parameter|$meta_key|文字列|カスタムフィールドのキー。}}
{{Parameter|$meta_value|string|The value of the custom field you will add.}}
+
{{Parameter|$meta_value|文字列|カスタムフィールドの値。}}
{{Parameter|$unique|boolean|Whether or not you want the key to be unique. When set to true, this will ensure that there is not already a custom field attached to the post with <tt>$meta_key</tt> as it's key, and, if such a field already exists, the key will not be added.|optional|false}}
+
{{Parameter|$unique|真偽値|キーをユニークにするかどうか。<var>true</var> のときは、指定した投稿に <tt>$meta_key</tt> を持つカスタムフィールドが無いときのみ追加し、すでにカスタムフィールドが存在していれば追加されません。|optional|false}}
  
==Examples==
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
===Default Usage===
+
<div id="Default_Usage">
 +
===デフォルトの使い方===
 +
</div>
  
 +
ID が68の投稿に、キーが <tt>my_key</tt> で値が47のカスタムフィールドを追加します。
 
  <?php add_post_meta(68, 'my_key', 47); ?>
 
  <?php add_post_meta(68, 'my_key', 47); ?>
  
===Adding or updating a unique field===
+
既に <tt>my_key</tt> というキーを持つカスタムフィールドが存在していても追加します。
  
Adds a new field if the key doesn't exist, or updates the existing field.
+
===ユニークなカスタムフィールドの追加と更新===
(UPDATE: If the fourth parameter of add_post_meta is set to true, the field will not be updated if it already exists (tested on WP 2.6.2). Use <tt>if (!update_post_meta(...)) add_post_meta(...))</tt>.
+
  
   <?php add_post_meta(7, 'fruit', 'banana', true) or update_post_meta(7, 'fruit', 'banana'); ?>
+
キーが存在しない場合は新しくカスタムフィールドを追加し、キーが存在する場合はカスタムフィールドを更新します。
 +
   <?php if ( !add_post_meta(7, 'fruit', 'banana', true) ) update_post_meta(7, 'fruit', 'banana'); ?>
  
===Other Examples===
+
===その他の例===
  
If you wanted to make sure that there were no fields with the key ''"my_key"'', before adding it:
+
''"my_key"'' キーを持つカスタムフィールドが存在しないときだけ追加する:
 
  <?php add_post_meta(68, 'my_key', '47', true); ?>
 
  <?php add_post_meta(68, 'my_key', '47', true); ?>
To add several values to the key ''"my_key"'':
+
 
 +
''"my_key"'' キーを持つカスタムフィールドを複数追加する:
 
<pre><?php add_post_meta(68, 'my_key', '47'); ?>
 
<pre><?php add_post_meta(68, 'my_key', '47'); ?>
 
<?php add_post_meta(68, 'my_key', '682'); ?>
 
<?php add_post_meta(68, 'my_key', '682'); ?>
 
<?php add_post_meta(68, 'my_key', 'The quick, brown fox jumped over the lazy dog.'); ?>
 
<?php add_post_meta(68, 'my_key', 'The quick, brown fox jumped over the lazy dog.'); ?>
 
...</pre>
 
...</pre>
For a more detailed example, go to the [[Function Reference/post meta Function Examples|post_meta Functions Examples]] page.
 
  
=== Making a "Hidden" Custom Field ===
+
さらに詳しい例は [[関数リファレンス/post meta 関数の例|post meta 関数の例]] を見てください。
 +
 
 +
=== ''見えない'' カスタムフィールドを作る ===
  
If you are a plugin/theme developer and you are planning to use custom fields to store parameters related to your plugin or template, it is interesting to note that WordPress won't show keys starting with an "_" (underscore) in the custom fields list at the page/post editing page. That being said, it is a good practice to use an underscore as the first character in your custom parameters, that way your settings are stored as custom fields, but they won't display in the custom fields list in the admin UI.
+
プラグインやテーマの開発者なら、カスタムフィールドをプラグインやテーマ用のパラメータを保存するために使いたいことがあるかもしれません。"_" (アンダースコア)で始まるキーを持つカスタムフィールドは記事や固定ページの編集画面に表示されないので、そのような内部的な ''見えない'' パラメータを扱うのに適しています。
  
The following example:
+
以下の例は、キーが ''_color'' で値が ''red'' のユニークなカスタムフィールドを追加しますが、記事や固定ページの編集画面には表示されません。
 
  <?php add_post_meta(68, '_color', 'red', true); ?>
 
  <?php add_post_meta(68, '_color', 'red', true); ?>
will add a unique custom field with the key name "_color" and the value "red" but this custom field will not display in the page/post editing page.
 
  
==Related==
+
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
 
{{Post Meta Tags}}
 
{{Post Meta Tags}}

2010年4月22日 (木) 00:33時点における版

add_post_meta は、指定した記事や固定ページにカスタム(メタ)フィールドを追加します。

$unique パラメータに true を指定しており、そのメタキーが既に存在している場合、この関数は false を返し何もしません。それ以外の場合は、カスタムフィールドを追加し true を返します。

使い方

<?php add_post_meta($post_id, $meta_key, $meta_value, $unique); ?>

パラメータ

$post_id
整数) (必須) カスタムフィールドを追加する投稿の ID。
初期値: なし
$meta_key
文字列) (必須) カスタムフィールドのキー。
初期値: なし
$meta_value
文字列) (必須) カスタムフィールドの値。
初期値: なし
$unique
真偽値) (optional) キーをユニークにするかどうか。true のときは、指定した投稿に $meta_key を持つカスタムフィールドが無いときのみ追加し、すでにカスタムフィールドが存在していれば追加されません。
初期値: false

用例

デフォルトの使い方

ID が68の投稿に、キーが my_key で値が47のカスタムフィールドを追加します。

<?php add_post_meta(68, 'my_key', 47); ?>

既に my_key というキーを持つカスタムフィールドが存在していても追加します。

ユニークなカスタムフィールドの追加と更新

キーが存在しない場合は新しくカスタムフィールドを追加し、キーが存在する場合はカスタムフィールドを更新します。

 <?php if ( !add_post_meta(7, 'fruit', 'banana', true) ) update_post_meta(7, 'fruit', 'banana'); ?>

その他の例

"my_key" キーを持つカスタムフィールドが存在しないときだけ追加する:

<?php add_post_meta(68, 'my_key', '47', true); ?>

"my_key" キーを持つカスタムフィールドを複数追加する:

<?php add_post_meta(68, 'my_key', '47'); ?>
<?php add_post_meta(68, 'my_key', '682'); ?>
<?php add_post_meta(68, 'my_key', 'The quick, brown fox jumped over the lazy dog.'); ?>
...

さらに詳しい例は post meta 関数の例 を見てください。

見えない カスタムフィールドを作る

プラグインやテーマの開発者なら、カスタムフィールドをプラグインやテーマ用のパラメータを保存するために使いたいことがあるかもしれません。"_" (アンダースコア)で始まるキーを持つカスタムフィールドは記事や固定ページの編集画面に表示されないので、そのような内部的な 見えない パラメータを扱うのに適しています。

以下の例は、キーが _color で値が red のユニークなカスタムフィールドを追加しますが、記事や固定ページの編集画面には表示されません。

<?php add_post_meta(68, '_color', 'red', true); ?>


カスタムフィールド: the_meta(), get_post_meta(), add_post_meta(), update_post_meta(), delete_post_meta(), get_post_custom(), get_post_custom_values(), get_post_custom_keys() (post_meta 関数の例 /en も参照)


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

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