get_comment_excerpt

函式
get_comment_excerpt ( $comment_ID = 0 )
引數
  • (int|WP_Comment) $comment_ID WP_Comment or ID of the comment for which to get the excerpt. Default current comment.
    Required:
返回值
  • (string) The possibly truncated comment excerpt.
定義位置
相關方法
comment_excerptget_comment_textget_comment_metaget_comment_countget_the_excerpt
引入
1.5.0
棄用
-

get_comment_excerpt – 這個函式返回一個評論的簡短摘錄。預設情況下,它返回評論文字的前20個字,但你可以用過濾器定製字數和”更多”文字。它把評論的ID作為一個引數。

檢索給定評論的摘錄。

最多返回20個字,必要時附加省略號。

function get_comment_excerpt( $comment_ID = 0 ) {
	$comment = get_comment( $comment_ID );

	if ( ! post_password_required( $comment->comment_post_ID ) ) {
		$comment_text = strip_tags( str_replace( array( "n", "r" ), ' ', $comment->comment_content ) );
	} else {
		$comment_text = __( 'Password protected' );
	}

	/* translators: Maximum number of words used in a comment excerpt. */
	$comment_excerpt_length = (int) _x( '20', 'comment_excerpt_length' );

	/**
	 * Filters the maximum number of words used in the comment excerpt.
	 *
	 * @since 4.4.0
	 *
	 * @param int $comment_excerpt_length The amount of words you want to display in the comment excerpt.
	 */
	$comment_excerpt_length = apply_filters( 'comment_excerpt_length', $comment_excerpt_length );

	$excerpt = wp_trim_words( $comment_text, $comment_excerpt_length, '…' );

	/**
	 * Filters the retrieved comment excerpt.
	 *
	 * @since 1.5.0
	 * @since 4.1.0 The `$comment_ID` and `$comment` parameters were added.
	 *
	 * @param string     $excerpt    The comment excerpt text.
	 * @param string     $comment_ID The comment ID as a numeric string.
	 * @param WP_Comment $comment    The comment object.
	 */
	return apply_filters( 'get_comment_excerpt', $excerpt, $comment->comment_ID, $comment );
}

常見問題

FAQs
檢視更多 >