Displays the edit comment link with formatting.
Parameters
$text
stringoptional- Anchor text. If null, default is ‘Edit This’.
Default:
null
$before
stringoptional- Display before edit link.
Default:
''
$after
stringoptional- Display after edit link.
Default:
''
Source
function edit_comment_link( $text = null, $before = '', $after = '' ) {
$comment = get_comment();
if ( ! current_user_can( 'edit_comment', $comment->comment_ID ) ) {
return;
}
if ( null === $text ) {
$text = __( 'Edit This' );
}
$link = '<a class="comment-edit-link" href="' . esc_url( get_edit_comment_link( $comment ) ) . '">' . $text . '</a>';
/**
* Filters the comment edit link anchor tag.
*
* @since 2.3.0
*
* @param string $link Anchor tag for the edit link.
* @param string $comment_id Comment ID as a numeric string.
* @param string $text Anchor text.
*/
echo $before . apply_filters( 'edit_comment_link', $link, $comment->comment_ID, $text ) . $after;
}
Hooks
- apply_filters( ‘edit_comment_link’,
string $link ,string $comment_id ,string $text ) Filters the comment edit link anchor tag.
Changelog
Version | Description |
---|---|
1.0.0 | Introduced. |
Examples
Displays edit comment link using defaults.
Displays edit comment link, with link text “edit comment”, in a paragraph () tag.