comment_author_rss()

comment_author_rss()
目次

comment_author_rss()の用途

comment_author_rss()の概要

comment_author_rss()

  • コメント投稿者の名前を RSS フィードに適した形式で出力します。
  • 通常のコメントテンプレートで使う comment_author() に似ていますが、RSS フィード用に文字をエスケープ(無害化)する処理が含まれています。

comment_author_rss()の用途

コメントを含む RSS フィード(例: コメントフィード)を出力する際、投稿者名が HTML や XML に影響しないようにエスケープが必要です。
comment_author_rss() はこのエスケープ処理を自動で行ってくれるので、RSS テンプレートで安心して使えます。

comment_author_rss()の使用例

コメントフィード用テンプレート(comments-rss2.phpなど)で次のように使います。

<author><?php comment_author_rss(); ?></author>

このようにすると、たとえばコメント投稿者が John & Mary のように特殊文字を含む名前でも

<author>John & Mary</author>

と出力され、XML が壊れません。

関連する関数

関数名用途
comment_author()コメント投稿者名をHTMLページに表示(通常のテンプレート用)
get_comment_author()投稿者名を文字列として取得(出力しない)
get_comment_author_rss()投稿者名をRSS用にエスケープした文字列で取得(comment_author_rss()と同じ動作だがechoしない)

「取得だけして自分で加工したい」場合は get_comment_author_rss() を使います。

comment_author_rss()の処理内容

comment_author_rss() の中では実際に

echo ent2ncr(esc_html(get_comment_author()));

と同等の処理が行われています。

  • get_comment_author()で名前を取得
  • esc_html()でHTMLエスケープ
  • ent2ncr()で文字参照に変換(XML対応)

このため、RSS フィードに最適な形にしてから出力されます。

comment_author_rss()のまとめ

  • comment_author_rss() は「コメント投稿者の名前をRSS向けに安全に出力する関数」
  • 通常のテンプレートでは comment_author() を使い、RSS用テンプレートでは comment_author_rss() を使う
  • 出力ではなく取得したいときは get_comment_author_rss() を使う
よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

この記事を書いた人

初めてホームページを作成したのは1996年。
2000年よりフリーランスで主に中小企業、学校、各種公的団体、個人事業主のWordPressを活用したホームページ制作を行っています。WordPressテーマはそれぞれのクライアントに合わせて作成しています。
WordPressを活用したサイト運営のための情報発信をしていきます。

目次