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を直接指定することはできず(指定するとエラーになるため)、必ず変数に格納し、その変数を指定しなければならない。

パラメータ$commentnullの場合は、グローバル変数$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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。