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

「クラスリファレンス/WP Comment Query」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(返り値)
(関連: {{DEFAULTSORT:WP_Comment_Query}} 追加。)
 
(他の1人の利用者による、間の4版が非表示)
2行目: 2行目:
 
== 説明 ==
 
== 説明 ==
  
<tt>WP_Comment_Query</tt> is a class, defined in {{Trac|wp-includes/comment.php}}, that allows querying [[Database_Description|WordPress database]] tables '<tt>[[Database_Description#Table:_wp_comments|wp_comments]]</tt>' and '<tt>[[Database_Description#Table:_wp_commentmeta|wp_commentmeta]]</tt>'. The class was introduced in [[Version 3.1]].
+
<tt>WP_Comment_Query</tt>は、[[Database_Description|WordPress データベース]] テーブル '<tt>[[Database_Description#Table:_wp_comments|wp_comments]]</tt>' '<tt>[[Database_Description#Table:_wp_commentmeta|wp_commentmeta]]</tt>'を照会することができる、 {{Trac|wp-includes/comment.php}}で定義されたクラスです。
 +
このクラスは、[[Version 3.1|バージョン3.1]]で導入されました。
  
 
== 用例 ==
 
== 用例 ==
48行目: 49行目:
 
'post_author__in' => '',
 
'post_author__in' => '',
 
'post_author__not_in' => '',
 
'post_author__not_in' => '',
'post_ID' => '',
 
 
'post_id' => 0,
 
'post_id' => 0,
 
'post__in' => '',
 
'post__in' => '',
84行目: 84行目:
 
== パラメータ ==
 
== パラメータ ==
  
{{Parameter|$status|string|このステータスのコメントのみを返します。<ul><li><tt>'hold'</tt> - 未承認のコメント</li><li><tt>'approve'</tt> - 承認されたコメント</li><li><tt>'spam'</tt> - スパムコメント</li><li><tt>'trash'</tt> - ゴミ箱のコメント</li></ul>|オプション}}
+
{{Parameter|$status|文字列|このステータスのコメントのみを返します。<ul><li><tt>'hold'</tt> - 未承認のコメント</li><li><tt>'approve'</tt> - 承認されたコメント</li><li><tt>'spam'</tt> - スパムコメント</li><li><tt>'trash'</tt> - ゴミ箱のコメント</li></ul>|オプション}}
  
{{Parameter|$orderby|string|コメントをソートするために使用するフィールドを設定します。|オプション|comment_date_gmt}}
+
{{Parameter|$orderby|文字列|コメントをソートするために使用するフィールドを設定します。|オプション|comment_date_gmt}}
  
{{Parameter|$order|string|<tt>$orderby</tt>でどのようにソートするか。有効値:<ul><li><tt>'ASC'</tt> - 昇順 (低から高).</li><li><tt>'DESC'</tt> - 降順 (高から低).</li></ul>|オプション|DESC}}
+
{{Parameter|$order|文字列|<tt>$orderby</tt>でどのようにソートするか。有効値:<ul><li><tt>'ASC'</tt> - 昇順 (低から高).</li><li><tt>'DESC'</tt> - 降順 (高から低).</li></ul>|オプション|DESC}}
  
{{Parameter|$number|integer|コメント数を返す。すべてのコメントを返すには空白のままにします。|オプション|unlimited}}
+
{{Parameter|$number|整数|コメント数を返す。すべてのコメントを返すには空白のままにします。|オプション|unlimited}}
  
{{Parameter|$offset|integer|最新コメントのオフセット。 You must include $number along with this.|オプション|0}}
+
{{Parameter|$offset|整数|最新コメントのオフセット。 You must include $number along with this.|オプション|0}}
  
{{Parameter|$post_id|integer|特定の投稿や固定ページのコメントのみ返します。||オプション}}
+
{{Parameter|$post_id|整数|特定の投稿や固定ページのコメントのみ返します。||オプション}}
  
{{Parameter|$user_id|integer|特定のユーザーのコメントのみ返します。|オプション}}
+
{{Parameter|$user_id|整数|特定のユーザーのコメントのみ返します。|オプション}}
  
{{Parameter|$count|integer|コメントの合計数のみ返す。|オプション}}
+
{{Parameter|$count|整数|コメントの合計数のみ返す。|オプション}}
  
  
{{Parameter|$type__in|array| 特定のコメントの種類を指定できます。|オプション}}
+
{{Parameter|$type__in|配列| 特定のコメントの種類を指定できます。|オプション}}
  
{{Parameter|$type__not_in|array| 配列内を除くすべてのコメントの種類を指定できます。|オプション}}
+
{{Parameter|$type__not_in|配列| 配列内を除くすべてのコメントの種類を指定できます。|オプション}}
  
{{Parameter|$meta_key|string|カスタムメタフィールドのキー。|オプション}}
+
{{Parameter|$meta_key|文字列|カスタムメタフィールドのキー。|オプション}}
  
{{Parameter|$meta_value|string|カスタムメタフィールドの値。|オプション}}
+
{{Parameter|$meta_value|文字列|カスタムメタフィールドの値。|オプション}}
  
{{Parameter|$meta_query|array|高度なメタクエリパラメータ([[Version 3.5]]で導入)。|オプション}}
+
{{Parameter|$meta_query|配列|高度なメタクエリパラメータ([[Version 3.5]]で導入)。|オプション}}
  
{{Parameter|$fields|string|Which fields to return ([[Version 4.0]]で導入。)<ul><li><tt>'ids'</tt> -コメントのID</li><li><tt>'*'</tt> - すべてのコメントフィールド。</li></ul>|オプション|*}}
+
{{Parameter|$fields|文字列|返すためフィールド ([[Version 4.0]]で導入。)<ul><li><tt>'ids'</tt> -コメントのID</li><li><tt>'*'</tt> - すべてのコメントフィールド。</li></ul>|オプション|*}}
  
 
=== カスタムフィールドのパラメータ ===
 
=== カスタムフィールドのパラメータ ===
117行目: 117行目:
 
特定のカスタムフィールドに関連付けられたコメントを表示します。
 
特定のカスタムフィールドに関連付けられたコメントを表示します。
  
* '''<tt>meta_key</tt>''' (''string'') - カスタムフィールドのキー。
+
* '''<tt>meta_key</tt>''' (''文字列'') - カスタムフィールドのキー。
* '''<tt>meta_value</tt>''' (''string'') - カスタムフィールドの値。
+
* '''<tt>meta_value</tt>''' (''文字列'') - カスタムフィールドの値。
  
* '''<tt>meta_query</tt>''' (''array'') - カスタムフィールドのパラメータ ([[Version 3.5]]で導入)。
+
* '''<tt>meta_query</tt>''' (''配列'') - カスタムフィールドのパラメータ ([[Version 3.5]]で導入)。
** '''<tt>key</tt>''' (''string'') - カスタムフィールドのキー。
+
** '''<tt>key</tt>''' (''文字列'') - カスタムフィールドのキー。
** '''<tt>value</tt>''' (''string''|''array'') - カスタムフィールドの値。 (''注'': Array support is limited to a compare value of 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' or 'NOT EXISTS')
+
** '''<tt>value</tt>''' (''文字列''|''array'') - カスタムフィールドの値。 (''注'': 配列のサポートが次の比較値に制限されます。 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' 'NOT EXISTS')
** '''<tt>compare</tt>''' (''string'') - Operator to test. 指定可能な値は、 '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS', and 'NOT EXISTS'. デフォルト値は '='.
+
** '''<tt>compare</tt>''' (''文字列'') - Operator to test. 指定可能な値は、 '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS'. デフォルト値は '='.
** '''<tt>type</tt>''' (''string'') - カスタムフィールドの型。指定可能な値は、 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'. デフォルト値は 'CHAR'.
+
** '''<tt>type</tt>''' (''文字列'') - カスタムフィールドの型。指定可能な値は、 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'. デフォルト値は 'CHAR'.
  
 
'''コメント欄の表示'''
 
'''コメント欄の表示'''
166行目: 166行目:
 
; <tt>comment_agent</tt> : (''文字列'') コメント投稿者のユーザーエージェント (ブラウザ, OS等)
 
; <tt>comment_agent</tt> : (''文字列'') コメント投稿者のユーザーエージェント (ブラウザ, OS等)
 
; <tt>comment_type</tt> : (''文字列'')意味のある場合に、コメントの種類 (<tt>pingback|trackback</tt>), 通常のコメント時は空。
 
; <tt>comment_type</tt> : (''文字列'')意味のある場合に、コメントの種類 (<tt>pingback|trackback</tt>), 通常のコメント時は空。
; <tt>comment_parent</tt> : (''文字列'')ネストされたコメントの親コメントのID (0 for top level)
+
; <tt>comment_parent</tt> : (''文字列'')ネストされたコメントの親コメントのID (トップレベルは 0 )
; <tt>user_id</tt> : (''整数'') The comment author's ID if s/he is registered (0 otherwise)
+
; <tt>user_id</tt> : (''整数'') 登録されている場合、コメント投稿者の ID (あるいは 0 )
  
 
== 改訂履歴 ==
 
== 改訂履歴 ==
181行目: 181行目:
 
== 関連 ==
 
== 関連 ==
  
* [[Class_Reference/WP_Query | WP_Query]] - Class for post-related queries
+
* [[Class_Reference/WP_Query | WP_Query]] - 投稿関連のクエリのためのクラス
* [[Class_Reference/WP_User_Query | WP_User_Query]] - Class for user-related queries
+
* [[Class_Reference/WP_User_Query | WP_User_Query]] - ユーザー関連のクエリのためのクラス
  
 
{{Class Footer}}
 
{{Class Footer}}
  
{{原文|Class_Reference/WP_Comment_Query|149853}}<!-- 2015-02-27T18:35:49‎ Dshanske 版 -->
+
{{原文|Class_Reference/WP_Comment_Query|151979}}<!-- 13:39, 9 June 2015‎ Andreuka 版 -->
[[Category:未翻訳]]
+
 
 +
{{DEFAULTSORT:WP_Comment_Query}}
 
[[Category:クラス]]
 
[[Category:クラス]]
 
[[Category:wp3.1]]
 
[[Category:wp3.1]]
 
[[Category:wp4.2]]
 
[[Category:wp4.2]]

2015年9月5日 (土) 17:46時点における最新版

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

説明

WP_Comment_Queryは、WordPress データベース テーブル 'wp_comments' と 'wp_commentmeta'を照会することができる、 wp-includes/comment.phpで定義されたクラスです。 このクラスは、バージョン3.1で導入されました。

用例

<?php
$args = array(
   // args here
);

// The Query
$comments_query = new WP_Comment_Query;
$comments = $comments_query->query( $args );

// Comment Loop
if ( $comments ) {
	foreach ( $comments as $comment ) {
		echo '<p>' . $comment->comment_content . '</p>';
	}
} else {
	echo 'No comments found.';
}
?>

デフォルトの例

<?php
		$args = array(
			'author_email' => '',
			'author__in' => '',
			'author__not_in' => '',
			'include_unapproved' => '',
			'fields' => '',
			'ID' => '',
			'comment__in' => '',
			'comment__not_in' => '',
			'karma' => '',
			'number' => '',
			'offset' => '',
			'orderby' => '',
			'order' => 'DESC',
			'parent' => '',
			'post_author__in' => '',
			'post_author__not_in' => '',
			'post_id' => 0,
			'post__in' => '',
			'post__not_in' => '',
			'post_author' => '',
			'post_name' => '',
			'post_parent' => '',
			'post_status' => '',
			'post_type' => '',
			'status' => 'all',
			'type' => '',
			'type__in' => '',
			'type__not_in' => '',
			'user_id' => '',
			'search' => '',
			'count' => false,
			'meta_key' => '',
			'meta_value' => '',
			'meta_query' => '',
			'date_query' => null, // See WP_Date_Query
		);
?>

メソッドとプロパティ

プロパティ

メソッド

パラメータ

$status
文字列) (オプション) このステータスのコメントのみを返します。
  • 'hold' - 未承認のコメント
  • 'approve' - 承認されたコメント
  • 'spam' - スパムコメント
  • 'trash' - ゴミ箱のコメント
初期値: なし
$orderby
文字列) (オプション) コメントをソートするために使用するフィールドを設定します。
初期値: comment_date_gmt
$order
文字列) (オプション$orderbyでどのようにソートするか。有効値:
  • 'ASC' - 昇順 (低から高).
  • 'DESC' - 降順 (高から低).
初期値: DESC
$number
整数) (オプション) コメント数を返す。すべてのコメントを返すには空白のままにします。
初期値: unlimited
$offset
整数) (オプション) 最新コメントのオフセット。 You must include $number along with this.
初期値: 0
$post_id
整数) (') 特定の投稿や固定ページのコメントのみ返します。
初期値: オプション
$user_id
整数) (オプション) 特定のユーザーのコメントのみ返します。
初期値: なし
$count
整数) (オプション) コメントの合計数のみ返す。
初期値: なし


$type__in
配列) (オプション) 特定のコメントの種類を指定できます。
初期値: なし
$type__not_in
配列) (オプション) 配列内を除くすべてのコメントの種類を指定できます。
初期値: なし
$meta_key
文字列) (オプション) カスタムメタフィールドのキー。
初期値: なし
$meta_value
文字列) (オプション) カスタムメタフィールドの値。
初期値: なし
$meta_query
配列) (オプション) 高度なメタクエリパラメータ(Version 3.5で導入)。
初期値: なし
$fields
文字列) (オプション) 返すためフィールド (Version 4.0で導入。)
  • 'ids' -コメントのID
  • '*' - すべてのコメントフィールド。
初期値: *

カスタムフィールドのパラメータ

特定のカスタムフィールドに関連付けられたコメントを表示します。

  • meta_key (文字列) - カスタムフィールドのキー。
  • meta_value (文字列) - カスタムフィールドの値。
  • meta_query (配列) - カスタムフィールドのパラメータ (Version 3.5で導入)。
    • key (文字列) - カスタムフィールドのキー。
    • value (文字列|array) - カスタムフィールドの値。 (: 配列のサポートが次の比較値に制限されます。 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS' 'NOT EXISTS')
    • compare (文字列) - Operator to test. 指定可能な値は、 '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN', 'EXISTS', 'NOT EXISTS'. デフォルト値は '='.
    • type (文字列) - カスタムフィールドの型。指定可能な値は、 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'. デフォルト値は 'CHAR'.

コメント欄の表示

$comment_query = new WP_Comment_Query( array( 'meta_key' => 'featured', 'meta_value' => '1' ) );

複数のメタフィールドの取扱い

$args = array(
	'meta_query' => array(
		'relation' => 'AND',
		array(
			'key' => 'featured',
			'value' => '1'
		),
		array(
			'key' => 'buried',
			'value' => '1',
			'type' => 'numeric',
			'compare' => '!='
		)
	)
 );
$comment_query = new WP_Comment_Query( $args );

返り値

(Array) 
以下のインデックスキーを有するコメントフィールド (or an empty array if there are no comments):
comment_ID 
(整数) コメントのID
comment_post_ID 
(整数) 投稿/固定ページのID、このコメントは応答します
comment_author 
(文字列) コメント投稿者の名前
comment_author_email 
(文字列) コメント投稿者のメールアドレス
comment_author_url 
(文字列) コメント投稿者のWebサイトアドレス
comment_author_IP 
(文字列) コメント投稿者のIPアドレス
comment_date 
(文字列) コメントが投稿された日時 (YYYY-MM-DD HH:MM:SS)
comment_date_gmt 
(文字列) コメントが投稿された日時(GMT) (YYYY-MM-DD HH:MM:SS)
comment_content 
(文字列) コメント内容
comment_karma 
(整数) 使われていないパラメータ
comment_approved 
(文字列) コメントが承認されているかどうか (0, 1 または "spam")
comment_agent 
(文字列) コメント投稿者のユーザーエージェント (ブラウザ, OS等)
comment_type 
(文字列)意味のある場合に、コメントの種類 (pingback|trackback), 通常のコメント時は空。
comment_parent 
(文字列)ネストされたコメントの親コメントのID (トップレベルは 0 )
user_id 
(整数) 登録されている場合、コメント投稿者の ID (あるいは 0 )

改訂履歴

  • 3.1.0にて導入されました。

ソースファイル

WP_Comment_Querywp-includes/comment.phpにあります。

リソース

関連

  • WP_Query - 投稿関連のクエリのためのクラス
  • WP_User_Query - ユーザー関連のクエリのためのクラス
クラスリファレンス関数リファレンスの各インデックスも参照してください。

最新英語版: WordPress Codex » Class_Reference/WP_Comment_Query最新版との差分