bbp_get_topic_tag_description( array $args = array() )

Return the description of the current tag

Description

Parameters

$args

(Optional) before|after|tag

Default value: array()

Return

(string) Term Name

Source

File: bp-forums/topics/template.php

function bbp_get_topic_tag_description( $args = array() ) {
 
    // Parse arguments against default values
    $r = bbp_parse_args( $args, array(
        'before' => '<div class="bbp-topic-tag-description"><p>',
        'after'  => '</p></div>',
        'tag'    => ''
    ), 'get_topic_tag_description' );
 
    // Get the term
    if ( ! empty( $r['tag'] ) ) {
        $term = get_term_by( 'slug', $r['tag'], bbp_get_topic_tag_tax_id() );
    } else {
        $tag      = get_query_var( 'term' );
        $r['tag'] = $tag;
        $term     = get_queried_object();
    }
 
    // Add before and after if description exists
    if ( !empty( $term->description ) ) {
        $retval = $r['before'] . $term->description . $r['after'];
 
    // No description, no HTML
    } else {
        $retval = '';
    }
 
    return apply_filters( 'bbp_get_topic_tag_description', $retval, $r );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3109)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic_tag_tax_id()	Return the unique id of the topic tag taxonomy
bp-forums/common/functions.php: bbp_parse_args()	Merge user defined arguments into defaults array.

Used By
Used By	Description
bp-forums/topics/template.php: bbp_topic_tag_description()	Output the description of the current tag

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.

Contents