
目次
cancel_comment_reply_link()の用途
cancel_comment_reply_link()
は、コメントの「返信モード(リプライモード)」に入ったときに表示される「返信をキャンセルするリンク」を表示する関数です。
コメント返信を選択すると、コメントフォームが親コメントの下に移動し「◯◯に返信中…」という状態になります。その状態を解除するリンクを出力します。
cancel_comment_reply_link()の構文
cancel_comment_reply_link( string $text = '' )
cancel_comment_reply_link()のパラメータ
$text
リンクに表示するテキスト(省略するとデフォルトは「クリックして返信をキャンセル」)
cancel_comment_reply_link()の戻り値
- 何も返さず、リンクを直接出力します。
cancel_comment_reply_link()の基本例
デフォルトのテキストで表示する例
<?php cancel_comment_reply_link(); ?>
返信モードの場合
[クリックして返信をキャンセル]
テキストを変更する例
<?php cancel_comment_reply_link('返信を取り消す'); ?>
出力例
[返信を取り消す]
cancel_comment_reply_link()の注意点
- 返信モード(コメントフォームが親コメントの下にある状態)のときのみリンクが表示されます。
- 通常の新規コメントフォームのときは何も出力されません。
- リンクをクリックするとJavaScriptで返信モードがキャンセルされ、フォームが元の位置に戻ります。
cancel_comment_reply_link()の使用例
コメントフォーム周辺のテンプレートで comment_form()
と一緒に配置するのが一般的です。
<div class="comment-form-wrapper">
<?php comment_form(); ?>
<?php cancel_comment_reply_link('返信をキャンセル'); ?>
</div>
関連する関数
関数 | 役割 |
---|---|
comment_form() | コメントフォームを出力する |
comment_reply_link() | 各コメントに「返信リンク」を表示する |
cancel_comment_reply_link() | 返信モードを解除するリンクを表示する |
cancel_comment_reply_link()の使い分けのポイント
- 各コメントの下に「返信リンク」をつける →
comment_reply_link()
- フォームが返信モードに入っているとき「キャンセルリンク」をつける →
cancel_comment_reply_link()
- フォーム全体を表示する →
comment_form()