Contents

Code Reference Functions bbp_get_topic_excerpt()

bbp_get_topic_excerpt( int $topic_id, int $length = 100 )

Return the excerpt of the topic

Description

Parameters

$topic_id

(Optional) topic id

$length

(Optional) Length of the excerpt. Defaults to 100 letters

Default value: 100

Return

(string) topic Excerpt

Source

File: bp-forums/topics/template.php

765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
function bbp_get_topic_excerpt( $topic_id = 0, $length = 100 ) {
    $topic_id = bbp_get_topic_id( $topic_id );
    $length   = (int) $length;
    $excerpt  = get_post_field( 'post_excerpt', $topic_id );
 
    if ( empty( $excerpt ) ) {
        $excerpt = bbp_get_topic_content( $topic_id );
    }
 
    $excerpt = trim( strip_tags( $excerpt ) );
 
    // Multibyte support
    if ( function_exists( 'mb_strlen' ) ) {
        $excerpt_length = mb_strlen( $excerpt );
    } else {
        $excerpt_length = strlen( $excerpt );
    }
 
    if ( !empty( $length ) && ( $excerpt_length > $length ) ) {
        $excerpt  = substr( $excerpt, 0, $length - 1 );
        $excerpt .= '…';
    }
 
    return apply_filters( 'bbp_get_topic_excerpt', $excerpt, $topic_id, $length );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2780) Introduced.
Used By
Used By Description
bp-forums/topics/template.php: bbp_topic_excerpt()

Output the excerpt of the topic

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.