get_comment

（2.0.0以降）
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

関連

参考

Code Reference: get_comment

お勧め

個人データのエクスポートメール向けに追加された新フィルター（2020年4月2日 更新）

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群（2018年5月27日 更新）

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで（2011年7月14日 更新）

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる！？（2020年2月25日 更新）

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。