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

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

関数リファレンス/get comment

提供: WordPress Codex 日本語版
移動先: 案内検索

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

説明

コメント ID またはコメントオブジェクトを指定してコメントデータを取得します。戻り値の形式を $output パラメータで指定できます。

オブジェクトを渡すと、コメントデータがキャッシュされ、それにフィルターが適用された後に返されます。渡したコメントが空の場合は、グローバルの comment オブジェクトが使われます(セットされている場合のみ)。

使い方

<?php get_comment( $comment, $output ); ?> 

パラメータ

$comment
オブジェクト/文字列/整数) (オプション) 取得するコメントを指定。
初期値: null
以下のどれかを指定します。
  • WP_Comment オブジェクト
  • 文字列|整数 – コメント ID
  • null – グローバルの comment オブジェクト。
$output
文字列) (オプション) 戻り値の形式。
初期値: 'OBJECT'
以下のどれかを指定します。
  • 'OBJECT'WP_Comment オブジェクト
  • 'ARRAY_A' – 連想配列
  • 'ARRAY_N' – 数値をインデックスとする配列

戻り値

(オブジェクト/配列/null) 
成功すると、指定されたコメントのデータベースフィールド (wp_comments テーブル内) を指定された形式で返します。失敗すると null を返します。

以下のコメントフィールドが返されます:

comment_ID 
(整数) コメント ID
comment_post_ID 
(整数) コメントが付けられた投稿の ID
comment_author 
(文字列) コメント作成者の名前
comment_author_email 
(文字列) コメント作成者のメールアドレス
comment_author_url 
(文字列) コメント作成者の URL
comment_author_IP 
(文字列) コメント作成者の IPv4 アドレス
comment_date 
(文字列) コメントの日時 (YYYY-MM-DD HH:MM:SS)
comment_date_gmt 
(文字列) GMT で表したコメントの日時 (YYYY-MM-DD HH:MM:SS)
comment_content 
(文字列) コメントの本文
comment_karma 
(整数) karma は使われていないフィールドです。
comment_approved 
(文字列) コメントの承認状態 (0, 1 または 'spam')
comment_agent 
(文字列) コメント作成者の HTTP ユーザーエージェント (Web ブラウザーや OS など)
comment_type 
(文字列) コメントの種類 ('pingback' または 'trackback')。空文字列なら普通のコメント。
comment_parent 
(文字列) 親コメントの ID
user_id 
(整数) コメント作成者の ID (登録されていれば)。0なら未登録。

用例

ID 7 のコメントについて、作成者の名前を取得します:

<?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id ); 
$name = $comment_id_7->comment_author;
?> 

同じ例ですが $output パラメータを使った場合:

<?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id, ARRAY_A );
$name = $comment_id_7['comment_author'];
?>


参考

  • 内部で $wpdb を使います。

変更履歴

新規導入: 2.0.0

ソースファイル

get_comment()wp-includes/comment.php にあります。

関連項目

フィルター: 'get_comment'


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


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