bbp_get_forum_archive_title( string $title = '' )

Return the forum archive title

Description

Parameters

$title

(string) (Optional) Default text to use as title

Default value: ''

Return

(string) The forum archive title

Source

File: bp-forums/forums/template.php

	function bbp_get_forum_archive_title( $title = '' ) {

		// If no title was passed
		if ( empty( $title ) ) {

			// Set root text to page title
			$page = bbp_get_page_by_path( bbp_get_root_slug() );
			if ( !empty( $page ) ) {
				$title = get_the_title( $page->ID );

			// Default to forum post type name label
			} else {
				$fto    = get_post_type_object( bbp_get_forum_post_type() );
				$title  = $fto->labels->name;
			}
		}

		return apply_filters( 'bbp_get_forum_archive_title', $title );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r3249)	Introduced.

Uses

Uses
Uses	Description
bp-forums/core/options.php: bbp_get_root_slug()	Return the root slug
bp-forums/forums/template.php: bbp_get_forum_post_type()	Return the unique id of the custom post type for forums
bp-forums/common/functions.php: bbp_get_page_by_path()	Used to guess if page exists at requested path

Used By
Used By	Description
bp-forums/core/theme-compat.php: bbp_template_include_theme_compat()	Reset main query vars and filter ‘the_content’ to output a Forums template part as needed.
bp-forums/forums/template.php: bbp_forum_archive_title()	Output the forum archive title
bp-forums/common/template.php: bbp_title()	Custom page title for Forums pages
bp-forums/common/template.php: bbp_get_breadcrumb()	Return a breadcrumb ( forum -> topic -> reply )

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