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

お勧め

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

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

ブロックエディターの文字サイズ設定を変えてみる（2019年12月12日 更新）

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

4.2で始まるiOSの絵文字ケア（2018年5月27日 更新）

WordPress 4.2のベータ1、ベータ2が立て続けにリリースされ、4.2の正式版リリースが近づいています。4.2のポイントの1つは絵文字のクロスブラウザ対応です。ここでの絵文字とは、UTF-8で4バイトのコードが割り当てられている（基本的にはiOSの）絵文字を指します。この絵文字を含んだ投稿が正しく保存できなかったり、iOS以外の環境で意図した通りに表示できないといった問題があり、4.2ではそのような問題を対処をコードが組み込まれています。

「不明な書式」って何ですか。（2024年11月13日 更新）

オートコンプリート機能を利用して四字熟語を挿入するプラグインを作った際、ツールバーに「不明な書式をクリア（Clear Unknown Formatting）」ボタンが表示されるようになった。この「書式」、何を指しているのかわからないんだが。

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

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