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



お勧め

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)

今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。

テーマから投稿画像のサイズを指定する(2012年3月15日 更新)

投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。

ログインページを変える(2014年9月12日 更新)

WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。