comments_template() の使い方|説明・引数・注意点

説明

comments_template() は、コメント一覧とコメントフォームのテンプレートを読み込む関数です。

基本構文

comments_template( string $file = '/comments.php', bool $separate_comments = false ): void

引数

  • $file:テンプレートファイル
  • $separate_comments:コメントとピンバックを分けるか

戻り値

戻り値はありません。

使い方(サンプル)

if ( comments_open() || get_comments_number() ) {
	comments_template();
}

注意点

  • コメントを受け付けていないとき、表示するか判定します。

実務での使いどころ

  • 個別ページ(single.php・page.php)で、コメント欄(一覧とフォーム)を、読み込むとき。

よくあるミスと対処

  • ループの外で呼び、意図した投稿の、コメントにならない。
  • コメントが閉じていて、コメントも0件のときも、読み込んでいる。comments_open() や get_comments_number() で、確認してから呼ぶ。
  • comments.php が、テーマに、存在しない。

NG例

comments_template(); // コメントが閉じていて、0件でも読み込まれる

OK例

if ( comments_open() || get_comments_number() ) {
	comments_template();
}

使い分け早見表

やりたいこと 使うもの
コメント欄を、読み込む comments_template()
コメントの一覧を、配列で取得 get_comments()
コメントを、プログラムで追加 wp_insert_comment()

関連項目

comments_open()、get_comments_number()、get_comments()

公式リファレンス:comments_template() | Function | WordPress Developer Resources

コメント

タイトルとURLをコピーしました