get_comment

説明

mixedWP_Comment | array get_comment( [ mixed & WP_Comment | string | int $comment = null [ , string $output = OBJECT ] ] )
コメント情報を取得する。

パラメータ

  • $comment
    コメントIDまたはコメント情報を指定(省略時はnull)。
  • $output
    取得データ形式としてOBJECT、ARRAY_A、ARRAY_Nの何れかを指定(省略時はOBJECT)。

返り値

コメント情報をパラメータ$outputで指定された形式で返す。パラメータ$commentに該当するコメント情報がない場合はNULLを返す。コメント情報のプロパティは次の通り。
プロパティ名データ型意味
comment_IDintコメントID
comment_post_IDintコメントされた投稿情報のID
comment_authorstringコメント投稿者
comment_author_emailstringコメント投稿者のメールアドレス
comment_author_urlstringコメント投稿者のURL
comment_author_IPstringコメント投稿者のIPアドレス
comment_datestringコメント投稿日時(ローカル)
comment_date_gmtstringコメント投稿日時(世界標準時)
comment_contentintコメント内容
comment_karmaintカルマ
comment_approvedint許諾状況(許諾されている場合は1)
comment_agentstringエージェント
comment_typestringコメントタイプ
comment_parentint親コメントID
user_idintユーザID

注意

パラメータ$commentには、コメントIDを直接指定することはできず(指定するとエラーになるため)、必ず変数に格納し、その変数を指定しなければならない。

パラメータ$commentがnullの場合は、グローバル変数$commentの内容が適用される。


使用例

  • コメントIDが10のコメント情報をオブジェクト形式で取得する。
    <?php $data = get_comment( $comment = 10 ); ?>
  • コメントIDが10のコメント情報を連想配列形式で取得する。
    <?php $data = get_comment( $comment = 10, ARRAY_A ); ?>

フィルター

[2.3.0]'get_comment'フィルターを呼び出す。パラメータ$_commentには本関数が受け取ったパラメータ$commentに応じたコメント情報が格納されている。
$_comment = apply_filters( 'get_comment', $_comment );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/comment.php

最終更新 : 2024年06月01日 11:57



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。