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

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

「関数リファレンス/get post custom values」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get post custom values 13:12, 9 November 2009 GeertDD)
 
(原文リンク修正。マージ不要分を削除。)
 
(2人の利用者による、間の3版が非表示)
1行目: 1行目:
== Description ==
+
<div id="Description">
 +
== 説明 ==
 +
</div>
  
This function is useful if you wish to access a custom field that is not unique, i.e. has more than 1 value associated with it. Otherwise, you might wish to look at [[Function_Reference/get_post_meta|get_post_meta()]].
+
この関数は、1 つのキーに複数の値が割り付けられているカスタムフィールドの値を取得するのに便利です。他の場合は [[関数リファレンス/get_post_meta|get_post_meta()]] がよいかもしれません。
  
Returns an array containing all the values of the custom fields with a particular key (<tt>$key</tt>) of a post with ID <tt>$post_id</tt> (defaults to the current post if unspecified).
+
<tt>$post_id</tt> で指定した ID の投稿(未指定の場合は現在の投稿)から、<tt>$key</tt> で指定したキーを持つすべてのカスタムフィールドの値を配列で取得します。
  
Returns nothing if no such key exists, or none is entered.
+
指定したキーを持つカスタムフィールドが存在しない場合は、<tt>null</tt> を返します。
  
See also [[Function_Reference/get_post_custom|get_post_custom()]] and [[Function_Reference/get_post_custom_keys|get_post_custom_keys()]].
+
[[関数リファレンス/get_post_custom|get_post_custom()]] [[関数リファレンス/get_post_custom_keys|get_post_custom_keys()]] も見てください。
  
== Usage ==
+
<div id="Usage">
 +
== 使い方 ==
 +
</div>
  
%%% <?php get_post_custom_values($key, $post_id); ?> %%%
+
<?php get_post_custom_values( $key, $post_id ); ?>
  
== Parameters ==
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
  
{{Parameter|$key|string|The key whose values you want returned.|required}}
+
{{Parameter|$key|文字列|カスタムフィールドのキー|必須}}
{{Parameter|$post_id|integer|The post ID whose custom fields will be retrieved.|optional|Current post}}
+
{{Parameter|$post_id|整数|カスタムフィールドの値を取得したい投稿の ID。|オプション|現在の投稿}}
  
== Examples ==
+
<div id="Examples">
 +
== 用例 ==
 +
</div>
  
=== Default Usage ===
+
<div id="Default_Usage">
 +
===デフォルトの使い方===
 +
</div>
  
Let's assume the current post has 3 values associated with the (custom) field <tt>my_key</tt>.
+
以下のサンプルでは、現在の投稿に <tt>my_key</tt> というキーを持つカスタムフィールドが3つあるとします。
  
You could show them through:
 
 
<pre><?php
 
<pre><?php
  
   $mykey_values = get_post_custom_values('my_key');
+
   $mykey_values = get_post_custom_values( 'my_key' );
 
   foreach ( $mykey_values as $key => $value ) {
 
   foreach ( $mykey_values as $key => $value ) {
     echo "$key  => $value ('my_key')<br />";  
+
     echo "$key  => $value ( 'my_key' )<br />";  
 
   }
 
   }
  
 
?></pre>
 
?></pre>
  
0 => First value ('my_key')
+
出力結果:
1 => Second value ('my_key')
+
<div style="border:1px solid blue; width:50%; padding:0 20px"><tt>
2 => Third value ('my_key')
+
0 => First value ( 'my_key' )<br />
 +
1 => Second value ( 'my_key' )<br />
 +
2 => Third value ( 'my_key' )
 +
</tt></div>
  
== Related ==
+
== ソースコード ==
 +
 
 +
<tt>get_post_custom_values()</tt> は {{Trac|wp-includes/post.php}} にあります。
 +
 
 +
== 更新履歴 ==
 +
 
 +
* 新規導入 [[Version 1.5|1.5.0]]
 +
 
 +
<div id="Related">
 +
== 関連資料 ==
 +
</div>
  
 
{{Post Meta Tags}}
 
{{Post Meta Tags}}
  
 
{{Tag Footer}}
 
{{Tag Footer}}
{{原文|Function Reference/get post custom values|75380}}<!-- 13:12, 9 November 2009 GeertDD -->
+
 
[[Category:Functions]]
+
{{原文|Function Reference/get post custom values|142571}} <!-- 13:31, 9 April 2014 Jobinma 版 -->
 +
 
 +
{{DEFAULTSORT:Get_post_custom_values}}
 +
[[Category:関数]]
 +
 
 
[[en:Function Reference/get post custom values]]
 
[[en:Function Reference/get post custom values]]

2015年8月25日 (火) 21:33時点における最新版

この関数は、1 つのキーに複数の値が割り付けられているカスタムフィールドの値を取得するのに便利です。他の場合は get_post_meta() がよいかもしれません。

$post_id で指定した ID の投稿(未指定の場合は現在の投稿)から、$key で指定したキーを持つすべてのカスタムフィールドの値を配列で取得します。

指定したキーを持つカスタムフィールドが存在しない場合は、null を返します。

get_post_custom()get_post_custom_keys() も見てください。

使い方

<?php get_post_custom_values( $key, $post_id ); ?>

パラメータ

$key
文字列) (必須) カスタムフィールドのキー
初期値: なし
$post_id
整数) (オプション) カスタムフィールドの値を取得したい投稿の ID。
初期値: 現在の投稿

用例

デフォルトの使い方

以下のサンプルでは、現在の投稿に my_key というキーを持つカスタムフィールドが3つあるとします。

<?php

  $mykey_values = get_post_custom_values( 'my_key' );
  foreach ( $mykey_values as $key => $value ) {
    echo "$key  => $value ( 'my_key' )<br />"; 
  }

?>

出力結果:

0 => First value ( 'my_key' )
1 => Second value ( 'my_key' )
2 => Third value ( 'my_key' )

ソースコード

get_post_custom_values()wp-includes/post.php にあります。

更新履歴


カスタムフィールド: 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/get post custom values最新版との差分