• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

「関数リファレンス/get comment」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en:Function Reference/get_comment 12:16, 11 November 2013 MichaelH 版を流し込みました。)
 
(和訳しました。)
 
1行目: 1行目:
== Description ==
+
{{CheckTrans}}
  
Retrieves comment data given a comment ID or comment object. You can specify, by means of the <tt>$output</tt> parameter, how you would like the results returned.
+
== 説明<span id="Description"></span> ==
  
If an object is passed then the comment data will be cached and then returned after being passed through a filter. If the comment is empty, then the global comment variable will be used, if it is set.
+
コメント ID またはコメントオブジェクトを指定してコメントデータを取得します。戻り値の形式を <tt>$output</tt> パラメータで指定できます。
  
==Usage==
+
オブジェクトを渡すと、コメントデータがキャッシュされ、それにフィルターが適用された後に返されます。渡したコメントが空の場合は、グローバルの <tt>comment</tt> オブジェクトが使われます(セットされている場合のみ)。
  
  <?php get_comment( $id, $output ); ?>  
+
== 使い方<span id="Usage"></span> ==
 +
 
 +
  <?php get_comment( $comment, $output ); ?>  
 
   
 
   
==Parameters==
+
== パラメータ<span id="Parameters"></span> ==
 +
 
 +
{{Parameter|$comment|オブジェクト/文字列/整数|取得するコメントを指定。|オプション|<code>null</code>}}
 +
:以下のどれかを指定します。
 +
:* [https://developer.wordpress.org/reference/classes/wp_comment/ WP_Comment] オブジェクト
 +
:* 文字列|整数 &ndash; コメント ID
 +
:* <tt>null</tt> &ndash; グローバルの <tt>comment</tt> オブジェクト。
  
{{Parameter|$comment|integer|The ID of the comment you'd like to fetch. '''You must pass a variable containing an integer''' (e.g. <tt>$id</tt>). A literal integer (e.g. <tt>7</tt>) will cause a fatal error (''Only variables can be passed for reference'' or ''Cannot pass parameter 1 by reference'').}}
+
{{Parameter|$output|文字列|戻り値の形式。|オプション|<code>'OBJECT'</code>}}
{{Parameter|$output|string|How you'd like the result. ''OBJECT'' <nowiki>=</nowiki> an object, ''ARRAY_A'' <nowiki>=</nowiki> an associative array of keys to values, and ''ARRAY_N'' <nowiki>=</nowiki> a numerically indexed array of values.|optional|OBJECT}}
+
:以下のどれかを指定します。
 +
:* <tt>'OBJECT'</tt> &ndash; [https://developer.wordpress.org/reference/classes/wp_comment/ WP_Comment] オブジェクト
 +
:* <tt>'ARRAY_A'</tt> &ndash; 連想配列
 +
:* <tt>'ARRAY_N'</tt> &ndash; 数値をインデックスとする配列
  
== Return ==
+
== 戻り値<span id="Return"></span> ==
  
{{Return||object&#124;array|On success, it returns the database fields for this comment from the <tt>[[Database_Description#Table:_wp_comments | wp_comments]]</tt> table, in the format specified. On failure, <tt>null</tt> is returned. The fields returned are:}}
+
{{Return||オブジェクト/配列/null|成功すると、指定されたコメントのデータベースフィールド (<tt>[[データベース構造#Table:_wp_comments|wp_comments]]</tt> テーブル内) を指定された形式で返します。失敗すると <tt>null</tt> を返します。}}
; <tt>comment_ID</tt> : (''integer'') The comment ID
+
以下のコメントフィールドが返されます:
; <tt>comment_post_ID</tt> : (''integer'') The post ID of the associated post
+
; <tt>comment_ID</tt> : (''整数'') コメント ID
; <tt>comment_author</tt> : (''string'') The comment author's name
+
; <tt>comment_post_ID</tt> : (''整数'') コメントが付けられた投稿の ID
; <tt>comment_author_email</tt> : (''string'') The comment author's email
+
; <tt>comment_author</tt> : (''文字列'') コメント作成者の名前
; <tt>comment_author_url</tt> : (''string'') The comment author's webpage
+
; <tt>comment_author_email</tt> : (''文字列'') コメント作成者のメールアドレス
; <tt>comment_author_IP</tt> : (''string'') The comment author's IP
+
; <tt>comment_author_url</tt> : (''文字列'') コメント作成者の URL
; <tt>comment_date</tt> : (''string'') The datetime of the comment (<tt>YYYY-MM-DD HH:MM:SS</tt>)
+
; <tt>comment_author_IP</tt> : (''文字列'') コメント作成者の IPv4 アドレス
; <tt>comment_date_gmt</tt> : (''string'') The GMT datetime of the comment (<tt>YYYY-MM-DD HH:MM:SS</tt>)
+
; <tt>comment_date</tt> : (''文字列'') コメントの日時 (<tt>YYYY-MM-DD HH:MM:SS</tt>)
; <tt>comment_content</tt> : (''string'') The comment's contents
+
; <tt>comment_date_gmt</tt> : (''文字列'') GMT で表したコメントの日時 (<tt>YYYY-MM-DD HH:MM:SS</tt>)
; <tt>comment_karma</tt> : (''integer'') The comment's karma
+
; <tt>comment_content</tt> : (''文字列'') コメントの本文
; <tt>comment_approved</tt> : (''string'') The comment approbation (0, 1 or 'spam')
+
; <tt>comment_karma</tt> : (''整数'') karma は使われていないフィールドです。
; <tt>comment_agent</tt> : (''string'') The comment's agent (browser, Operating System, etc.)
+
; <tt>comment_approved</tt> : (''文字列'') コメントの承認状態 (<tt>0, 1</tt> または <tt>'spam'</tt>)
; <tt>comment_type</tt> : (''string'') The comment's type if meaningfull (<tt>pingback|trackback</tt>), and empty for normal comments
+
; <tt>comment_agent</tt> : (''文字列'') コメント作成者の HTTP ユーザーエージェント (Web ブラウザーや OS など)
; <tt>comment_parent</tt> : (''string'') The parent comment's ID
+
; <tt>comment_type</tt> : (''文字列'') コメントの種類 (<tt>'pingback'</tt> または <tt>'trackback'</tt>)。空文字列なら普通のコメント。
; <tt>user_id</tt> : (''integer'') The comment author's ID if he is registered (0 otherwise)
+
; <tt>comment_parent</tt> : (''文字列'') 親コメントの ID
 +
; <tt>user_id</tt> : (''整数'') コメント作成者の ID (登録されていれば)。0なら未登録。
  
==Example==
+
== 用例<span id="Example"></span> ==
  
To get the author's name of a comment with ID 7:
+
ID 7 のコメントについて、作成者の名前を取得します:
  
 
<pre><?php
 
<pre><?php
43行目: 55行目:
 
?> </pre>
 
?> </pre>
  
Alternatively, specify the <tt>$output</tt> parameter:
+
同じ例ですが <tt>$output</tt> パラメータを使った場合:
  
 
<pre><?php
 
<pre><?php
51行目: 63行目:
 
?></pre>
 
?></pre>
  
 +
<!-- 原文にあった例ですが、現行バージョンでは未確認のため、コメントアウトしておきます。5-July-2017 gblsm
 
<pre><?php
 
<pre><?php
 
// Correct: pass a dummy variable as post_id
 
// Correct: pass a dummy variable as post_id
59行目: 72行目:
 
// Fatal error: 'Only variables can be passed for reference' or 'Cannot pass parameter 1 by reference'
 
// Fatal error: 'Only variables can be passed for reference' or 'Cannot pass parameter 1 by reference'
 
?></pre>
 
?></pre>
 +
-->
  
== Notes ==
+
== 参考<span id="Notes"></span> ==
  
* Uses: <tt>[[Class_Reference/wpdb | $wpdb]]</tt>
+
* 内部で <tt>[[Class_Reference/wpdb | $wpdb]]</tt> を使います。
  
== Change Log ==
+
== 変更履歴<span id="Change_Log"></span> ==
  
Since: [[Version 2.0|2.0.0]]
+
新規導入: [[Version 2.0|2.0.0]]
  
== Source File ==
+
== ソースファイル<span id="Source_File"></span> ==
  
<tt>get_comment()</tt> is located in {{Trac|wp-includes/comment.php}}
+
<tt>get_comment()</tt> {{Trac|wp-includes/comment.php}} にあります。
  
== Related ==
+
== 関連項目<span id="Related"></span> ==
&nbsp;
+
フィルター: [https://developer.wordpress.org/reference/hooks/get_comment/ <tt>'get_comment'</tt>]
  
 
{{Tag Footer}}
 
{{Tag Footer}}
{{Copyedit}}
 
  
 
{{原文|Function Reference/get_comment|138006}} <!-- 12:16, 11 November 2013 MichaelH 版 -->
 
{{原文|Function Reference/get_comment|138006}} <!-- 12:16, 11 November 2013 MichaelH 版 -->

2017年7月5日 (水) 23:54時点における最新版

この項目「関数リファレンス/get comment」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

説明

コメント ID またはコメントオブジェクトを指定してコメントデータを取得します。戻り値の形式を $output パラメータで指定できます。

オブジェクトを渡すと、コメントデータがキャッシュされ、それにフィルターが適用された後に返されます。渡したコメントが空の場合は、グローバルの comment オブジェクトが使われます(セットされている場合のみ)。

使い方

<?php get_comment( $comment, $output ); ?> 

パラメータ

$comment
オブジェクト/文字列/整数) (オプション) 取得するコメントを指定。
初期値: null
以下のどれかを指定します。
  • WP_Comment オブジェクト
  • 文字列|整数 – コメント ID
  • null – グローバルの comment オブジェクト。
$output
文字列) (オプション) 戻り値の形式。
初期値: 'OBJECT'
以下のどれかを指定します。
  • 'OBJECT'WP_Comment オブジェクト
  • 'ARRAY_A' – 連想配列
  • 'ARRAY_N' – 数値をインデックスとする配列

戻り値

(オブジェクト/配列/null) 
成功すると、指定されたコメントのデータベースフィールド (wp_comments テーブル内) を指定された形式で返します。失敗すると null を返します。

以下のコメントフィールドが返されます:

comment_ID 
(整数) コメント ID
comment_post_ID 
(整数) コメントが付けられた投稿の ID
comment_author 
(文字列) コメント作成者の名前
comment_author_email 
(文字列) コメント作成者のメールアドレス
comment_author_url 
(文字列) コメント作成者の URL
comment_author_IP 
(文字列) コメント作成者の IPv4 アドレス
comment_date 
(文字列) コメントの日時 (YYYY-MM-DD HH:MM:SS)
comment_date_gmt 
(文字列) GMT で表したコメントの日時 (YYYY-MM-DD HH:MM:SS)
comment_content 
(文字列) コメントの本文
comment_karma 
(整数) karma は使われていないフィールドです。
comment_approved 
(文字列) コメントの承認状態 (0, 1 または 'spam')
comment_agent 
(文字列) コメント作成者の HTTP ユーザーエージェント (Web ブラウザーや OS など)
comment_type 
(文字列) コメントの種類 ('pingback' または 'trackback')。空文字列なら普通のコメント。
comment_parent 
(文字列) 親コメントの ID
user_id 
(整数) コメント作成者の ID (登録されていれば)。0なら未登録。

用例

ID 7 のコメントについて、作成者の名前を取得します:

<?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id ); 
$name = $comment_id_7->comment_author;
?> 

同じ例ですが $output パラメータを使った場合:

<?php
$my_id = 7;
$comment_id_7 = get_comment( $my_id, ARRAY_A );
$name = $comment_id_7['comment_author'];
?>


参考

  • 内部で $wpdb を使います。

変更履歴

新規導入: 2.0.0

ソースファイル

get_comment()wp-includes/comment.php にあります。

関連項目

フィルター: 'get_comment'


関数リファレンステンプレートタグ目次もご覧ください。


最新英語版: WordPress Codex » Function Reference/get_comment最新版との差分