Documentation
Theme & Plugin developers can use these functions :
Tip : Hit Ctrl + F in your browser and search for the function you are looking for.
functions.bb-template.php
bb_load_template()
Description
Required to load the template file.
The globals are set up for the template file to ensure that the bbPress environment is available from within the function.
Usage
<?php bb_load_template( $files, $globals = false, $action_arg = null ); ?>
Parameters
$files
(string)(required)Path name to file.
$globals
(boolean)Uses global variables:
$bb
$bbdb
$bb_current_user
$page
$bb_cache
$posts
$bb_post
$post_id
$topics
$topic
$topic_id
$forums
$forum
$forum_id
$tags
$tag
$tag_name
$user
$user_id
$view
$del_class
$bb_alt
$action_arg
(unknown type)
Return Values
(void)
This function does not return a value.
Filters
‘bb_template’:
apply_
Filters
( ‘bb_template’, $template, $file_used )
Source File
bb_load_template() is located in bb-includes/functions.bb-template.php
bb_get_template()
Description
retrieve name of the current theme.
Usage
<?php bb_get_template( $file, $default = true ); ?>
Parameters
$file
(string)Path name to file.
$default
(boolean)Default template file values.
Return Values
(string)
Returns template name.
Filters
No Filters.
Source File
bb_get_template() is located in bb-includes/functions.bb-template.php
bb_get_default_template()
Description
Retrieve path of default theme file.
Usage
<?php bb_get_default_template( $file ); ?>
[/php]
Parameters
$file
(string)Path name to file.
Return Values
(string)
Returns default theme file path.
Filters
No Filters.
Source File
bb_get_default_template() is located in bb-includes/functions.bb-template.php
bb_get_header()
Description
Includes the header.php template file from your current theme’s directory.If a name is specified then a specialised header header-{name}.php will be included.If the theme contains no header.php file then the header from the default theme will be included.
Usage
<?php bb_get_header(); ?>
Parameters
No
Parameters
.
Return Values
(void)
This function does not return any value.
Filters
No Filters.
Source File
bb_get_header() is located in bb-includes/functions.bb-template.php
bb_language_attributes()
Description
Retrieve attributes of the language used.
Usage
<?php bb_language_attributes( $xhtml = 0 ); ?>
Parameters
$xhtml
(integer)Language identifier with initial value as 0.
Return Values
(void)
This function does not return any value.
Filters
No Filters.
Source File
bb_language_attributes() is located in bb-includes/functions.bb-template.php
bb_generator()
Description
Generates the meta line in head section containing the version number.
Usage
<?php bb_generator( $type = 'xhtml' ); ?>
Parameters
$type
(string)Initialised as xhtml.
Return Values
(void)
This function does not return any value.
Filters
‘bb_generator’:
apply_
Filters
( ‘bb_generator’, bb_get_generator( $type ) . “\n”, $type )
Source File
bb_generator() is located in bb-includes/functions.bb-template.php
bb_get_generator()
Description
Includes the meta line in head section containing the version number.
Usage
<?php bb_get_generator( $type = 'xhtml' ); ?>
Parameters
$type
(string)Initialised as xhtml.
Return Values
(void)
This function does not return any value.
Filters
‘bb_get_generator’:
apply_
Filters
( ‘bb_get_generator’, $gen, $type )
Source File
bb_get_generator() is located in bb-includes/functions.bb-template.php
bb_stylesheet_uri()
Description
Displays URI of current theme stylesheet.
Usage
<?php bb_stylesheet_uri( $stylesheet = '' ); ?>
Parameters
$stylesheet
(string)URI of theme.
Return Values
(void)
This function does not return any value.
Filters
No Filters.
Source File
bb_stylesheet_uri() is located in bb-includes/functions.bb-template.php
bb_get_stylesheet_uri()
Description
Retrieve URI of current theme stylesheet.The stylesheet file name is ‘style.css’.
Usage
<?php bb_get_stylesheet_uri( $stylesheet = '' ); ?>
Parameters
$stylesheet
(string)URI of theme.
Return Values
(string)
Returns URI of current theme stylesheet.
Filters
‘bb_get_stylesheet_uri’:
apply_
Filters
( ‘bb_get_stylesheet_uri’, $r, $stylesheet )
Source File
bb_get_stylesheet_uri() is located in bb-includes/functions.bb-template.php
bb_active_theme_uri()
Description
Displays active theme URI.
Usage
<?php bb_active_theme_uri(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No Filters.
Source File
bb_active_theme_uri() is located in bb-includes/functions.bb-template.php
bb_get_active_theme_uri()
Description
Retrieve active theme URI.
Usage
<?php bb_get_active_theme_uri(); ?>
Parameters
No parameter.
Return Values
(string|null)
Null, if theme name does not exist. Theme URI, if exists.
Filters
‘bb_get_active_theme_uri’:
apply_
Filters
( ‘bb_get_active_theme_uri’, $active_theme_uri )
Source File
bb_get_active_theme_uri() is located in bb-includes/functions.bb-template.php
bb_get_theme_uri()
Description
Retrieve URI of a theme file.
Usage
<?php bb_get_theme_uri( $theme = false ); ?>
Parameters
$theme
(boolean)Initialised as false.
Return Values
(string)
Returns URI of a theme file.
Filters
‘bb_get_theme_uri’:
apply_
Filters
( ‘bb_get_theme_uri’, $theme_uri, $theme )
Source File
bb_get_theme_uri() is located in bb-includes/functions.bb-template.php
bb_get_footer()
Description
Includes the footer.php template file from your current theme’s directory. if a name is specified then a specialised footer footer-{name}.php will be included.If the theme contains no footer.php file then the footer from the default theme will be included.
Usage
<?php bb_get_footer(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No Filters.
Source File
bb_get_footer() is located in bb-includes/functions.bb-template.php
bb_head()
Description
Fires the ‘bb_head’ action.
Usage
<?php bb_head(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
bb_head() is located in bb-includes/functions.bb-template.php
bb_rsd_link()
Description
Display the link to the Really Simple Discovery service endpoint.
Usage
<?php bb_rsd_link(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_rsd_link() is located in bb-includes/functions.bb-template.php
bb_pingback_link()
Description
Display the link to the pingback service endpoint found in a post.
Usage
<?php bb_pingback_link(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
bb_pingback_link() is located in bb-includes/functions.bb-template.php
profile_menu()
Description
Displays menu on the profile page of the user.
Usage
<?php profile_menu(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
profile_menu() is located in bb-includes/functions.bb-template.php
login_form()
Description
Includes login-form.php from the template files.
Usage
<?php login_form(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
login_form() is located in bb-includes/functions.bb-template.php
search_form()
Description
Display search form using searchform.php theme file.
Usage
<?php search_form( $q = '' ); ?>
Parameters
$q
(string)Query to extract data.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
search_form() is located in bb-includes/functions.bb-template.php
bb_post_template()
Description
Include post.php from theme file.
Usage
<?php bb_post_template(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
bb_post_template() is located in bb-includes/functions.bb-template.php
post_form()
Description
Fires ‘pre_post_form’,'post_form’ and ‘post_post_form’ actions.
Usage
<?php post_form( $args = array() ); ?>
Parameters
$args
(array)Attributes of a post.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
post_form() is located in bb-includes/functions.bb-template.php
edit_form()
Description
Fires ‘pre_edit_form’,'edit_form’ and’post_edit_form’ actions.
Usage
<?php edit_form(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
edit_form() is located in bb-includes/functions.bb-template.php
alt_class()
Description
Displays alt class at odd iterations.
Usage
<?php alt_class( $key, $others = '' ); ?>
Parameters
$key
(string)Identifier for alt class.
$others
(string)Identifier for other classes.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
alt_class() is located in bb-includes/functions.bb-template.php
get_alt_class()
Description
Useful in adding alt class at odd iterations.
Usage
<?php get_alt_class( $key, $others = '' ); ?>
Parameters
$key
(string)Identifier for alt class.
$others
(string)Identifier for other classes.
Return Values
Returns either alt class or other class.
Filters
No filter.
Source File
get_alt_class() is located in bb-includes/functions.bb-template.php
bb_location()
Description
Displays location of the file.
Usage
<?php bb_location(); ?>
Parameters
No parameter.
Return Values
(void)
This function does not return any value.
Filters
‘bb_location’:
apply_
Filters
( ‘bb_location’, bb_get_location() )
Source File
bb_location() is located in bb-includes/functions.bb-template.php
bb_get_location()
Description
Retrieves path of file starting from the root directory in bbPress.
Usage
<?php $loc = bb_get_location(); ?>
Parameters
No parameter.
Return Values
Returns path where the file is located.
Filters
‘bb_get_location’:
apply_
Filters
( ‘bb_get_location’, ”, $file )
Source File
bb_get_location() is located in bb-includes/functions.bb-template.php
bb_is_front()
Description
Retrieves path of file and uses it as front page.
Usage
<?php bb_is_front(); ?>
Parameters
No parameter.
Return Values
Returns located page as front page.
Filters
No filter.
Source File
bb_is_front() is located in bb-includes/functions.bb-template.php
bb_is_forum()
Description
Retrieve path of file and uses it as forum page.
Usage
<?php bb_is_forum(); ?>
Parameters
No parameter.
Return Values
Returns located page as forum page.
Filters
No Filters.
Source File
bb_is_forum() is located in bb-includes/functions.bb-template.php
bb_is_login_required()
Description
Whether a user is required to log in in order to create posts and forums.
Usage
<?php bb_is_login_required(); ?>
Parameters
No parameter.
Return Values
(boolean)
Whether a user must be logged in.
Filters
No filter.
Source File
bb_is_login_required() is located in bb-includes/functions.bb-template.php
bb_is_tags()
Description
Retrieve path of file and uses it as tag page.
Usage
<?php bb_is_tags(); ?>
Parameters
No parameter.
Return Values
Returns located page as tag page.
Filters
No filter.
Source File
bb_is_tags() is located in bb-includes/functions.bb-template.php
bb_is_tag()
Description
Retrieve information about a tagged page.
Usage
<?php bb_is_tag(); ?>
Parameters
No parameter.
Return Values
Returns tag id,tag name and located page as tag page.
Filters
No filter.
Source File
bb_is_tag() is located in bb-includes/functions.bb-template.php
bb_is_topic_edit()
Description
Retrieves path name and uses it as topic edit page.
Usage
<?php bb_is_topic_edit(); ?>
Parameters
No parameter.
Return Values
Returns located page as topic edit page.
Filters
No filter.
Source File
bb_is_topic_edit() is located in bb-includes/functions.bb-template.php
bb_is_topic()
Description
Retrieves path name and uses it as topic page.
Usage
<?php bb_is_topic(); ?>
Parameters
No parameter.
Return Values
Returns located page as topic page.
Filters
No filter.
Source File
bb_is_topic() is located in bb-includes/functions.bb-template.php
bb_is_feed()
Description
Retrieves path name and uses it as feed page.
Usage
<?php bb_is_feed(); ?>
Parameters
No parameter.
Return Values
Returns located page as feed page.
Filters
No filter.
Source File
bb_is_feed() is located in bb-includes/functions.bb-template.php
bb_is_search()
Description
Retrieves path name and uses it as search page.
Usage
<?php bb_is_search(); ?>
Parameters
No parameter.
Return Values
Returns located page as search page.
Filters
No filter.
Source File
bb_is_search() is located in bb-includes/functions.bb-template.php
bb_is_profile()
Description
Retrieves path name and uses it as profile page.
Usage
<?php bb_is_profile(); ?>
Parameters
No parameter.
Return Values
Returns located page as profile page.
Filters
No filter.
Source File
bb_is_profile() is located in bb-includes/functions.bb-template.php
bb_is_favorites()
Description
Retrieves path name and uses it as favorites page.
Usage
<?php bb_is_favorites(); ?>
Parameters
No parameter.
Return Values
Returns located page as favorites page.
Filters
No filter.
Source File
bb_is_favorites() is located in bb-includes/functions.bb-template.php
bb_is_view()
Description
Retrieves path name and uses it as view page.
Usage
<?php bb_is_view(); ?>
Parameters
No parameter.
Return Values
Returns located page as view page.
Filters
No filter.
Source File
bb_is_view() is located in bb-includes/functions.bb-template.php
bb_is_statistics()
Description
Retrieves path name and uses it as statistics page.
Usage
<?php bb_is_statistics(); ?>
Parameters
No parameter.
Return Values
Returns located page as statistics page.
Filters
No filter.
Source File
bb_is_statistics() is located in bb-includes/functions.bb-template.php
bb_is_admin()
Description
Checks whether the user is admin or not.
Usage
<?php bb_is_admin(); ?>
Parameters
No parameter.
Return Values
Returns BB_IS_ADMIN if user is admin else false.
Filters
No filter.
Source File
bb_is_admin() is located in bb-includes/functions.bb-template.php
bb_title()
Description
Displays title of the page.
Usage
<?php bb_title( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
(void)
This function does not return any value.
Filters
‘bb_title’:
apply_
Filters
( ‘bb_title’, bb_get_title( $args ), $args )
Source File
bb_title() is located in bb-includes/functions.bb-template.php
bb_get_title()
Description
Retrieves title of the page.
Usage
<?php bb_get_title( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns title of the page with separators, if present.
Filters
‘bb_get_title’:
apply_
Filters
( ‘bb_get_title’, implode( $args['separator'], $title ), $args, $title )
Source File
bb_get_title() is located in bb-includes/functions.bb-template.php
bb_feed_head()
Description
Displays the link of the feed.
Usage
<?php bb_feed_head(); ?>
Parameters
No parameter.
Return Values
Returns the link of the feed according to the page.
Filters
‘bb_feed_head’:
apply_
Filters
(‘bb_feed_head’, $feed_links)
Source File
bb_feed_head() is located in bb-includes/functions.bb-template.php
bb_get_posts_rss_link()
Description
Retrieves the rss link to the posts.
Usage
<?php bb_get_posts_rss_link($context = 0); ?>
Parameters
$context
Return Values
Returns link.
Filters
‘bb_get_posts_rss_link’:
apply_
Filters
( ‘bb_get_posts_rss_link’, $link, $context )
Source File
bb_get_posts_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_topics_rss_link()
Description
Retrieves the rss link to the topics.
Usage
<?php bb_get_topics_rss_link($context = 0); ?>
Parameters
$context
Return Values
Returns link.
Filters
‘bb_get_topics_rss_link’:
apply_
Filters
( ‘bb_get_topics_rss_link’, $link, $context )
Source File
bb_get_topics_rss_link() is located in bb-includes/functions.bb-template.php
bb_view_rss_link()
Description
Displays view of rss link on the basis of different conditions.
Usage
<?php bb_view_rss_link($view = null, $context = 0); ?>
Parameters
$view
(array)Based on conidition.
$context
Return Values
This function does not return any value.
Filters
‘bb_view_rss_link’:
apply_
Filters
( ‘bb_view_rss_link’, bb_get_view_rss_link($view, $context), $context)
Source File
bb_view_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_view_rss_link()
Description
Retrieves view of rss link on the basis of different conditions.
Usage
<?php bb_get_view_rss_link($view = null, $context = 0); ?>
Parameters
$view
(array)Based on conidition.
$context
Return Values
Returns view and context of rss link.
Filters
‘bb_get_view_rss_link’:
apply_
Filters
( ‘bb_get_view_rss_link’, $link, $context )
Source File
bb_get_view_rss_link() is located in bb-includes/functions.bb-template.php
bb_latest_topics_pages()
Description
Retrieves and displays information about the latest topics on the page.
Usage
<?php bb_latest_topics_pages( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_latest_topics_pages’:
apply_
Filters
( ‘bb_latest_topics_pages’, get_page_number_links( $page, $bb_latest_topics_count ), $bb_latest_topics_count )
Source File
bb_latest_topics_pages() is located in bb-includes/functions.bb-template.php
forum_id()
Description
Displays forum id of a forum.
Usage
<?php forum_id( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘forum_id’:
apply_
Filters
( ‘forum_id’, get_forum_id( $forum_id ) )
Source File
forum_id() is located in bb-includes/functions.bb-template.php
get_forum_id()
Description
Retrieves forum id of a forum.
Usage
<?php get_forum_id( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns forum id.
Filters
No filter.
Source File
get_forum_id() is located in bb-includes/functions.bb-template.php
forum_link()
Description
Displays links to a forum.
Usage
<?php forum_link( $forum_id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
$page
(integer)Number of pages linked in the forum.
$context
Return Values
This function does not return any value.
Filters
‘forum_link’:
apply_
Filters
(‘forum_link’, get_forum_link( $forum_id, $page, $context ), $forum_id, $context )
Source File
forum_link() is located in bb-includes/functions.bb-template.php
get_forum_link()
Description
Retrieves links to a forum.
Usage
<?php get_forum_link( $forum_id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
$page
(integer)Number of pages linked in the forum initialised to 1.
$context
Return Values
Returns link.
Filters
‘get_forum_link’:
apply_
Filters
( ‘get_forum_link’, $link, $forum->forum_id, $context )
Source File
get_forum_link() is located in bb-includes/functions.bb-template.php
forum_name()
Description
Displays forum name of a forum using its forum id.
Usage
<?php forum_name( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
This function does not have any return value.
Filters
‘forum_name’:
apply_
Filters
( ‘forum_name’, get_forum_name( $forum_id ), $forum_id )
Source File
forum_name() is located in bb-includes/functions.bb-template.php
get_forum_name()
Description
Retrieves forum name of a forum using its forum id.
Usage
<?php get_forum_name( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the forum name.
Filters
‘get_forum_name’:
apply_
Filters
( ‘get_forum_name’, $forum->forum_name, $forum->forum_id )
Source File
get_forum_name() is located in bb-includes/functions.bb-template.php
forum_
Description
()
Description
Displays
Description
of a forum.
Usage
<?php forum_<h3>Description</h3>( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not have any return value.
Filters
‘forum_
Description
‘:
apply_
Filters
( ‘forum_
Description
‘, get_forum_
Description
( $args['id'] ), $args['id'], $args )
Source File
forum_
Description
() is located in bb-includes/functions.bb-template.php
get_forum_
Description
()
Description
Retrieves
Description
of a forum.
Usage
<?php get_forum_<h3>Description</h3>( $forum_id=0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the
Description
of the forum.
Filters
‘get_forum_
Description
‘:
apply_
Filters
( ‘get_forum_
Description
‘, $forum->forum_desc, $forum->forum_id )
Source File
get_forum_
Description
() is located in bb-includes/functions.bb-template.php
get_forum_parent()
Description
Retrieves parent of a forum.
Usage
<?php get_forum_parent( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the parent of the forum.
Filters
‘get_forum_parent’:
apply_
Filters
( ‘get_forum_parent’, $forum->forum_parent, $forum->forum_id)
Source File
get_forum_parent() is located in bb-includes/functions.bb-template.php
get_forum_position()
Description
Retrieves position of a forum.
Usage
<?php get_forum_position( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the position of the forum.
Filters
‘get_forum_position’:
apply_
Filters
( ‘get_forum_position’, $forum->forum_order, $forum->forum_id )
Source File
get_forum_position() is located in bb-includes/functions.bb-template.php
bb_get_forum_is_category()
Description
Retrieves category of a forum.
Usage
<?php bb_get_forum_is_category( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the category of the forum.
Filters
‘bb_get_forum_is_category’:
apply_
Filters
( ‘bb_get_forum_is_category’, isset($forum->forum_is_category) ? $forum->forum_is_category : false, $forum->forum_id )
Source File
bb_get_forum_is_category() is located in bb-includes/functions.bb-template.php
forum_topics()
Description
Displays topics in a forum.
Usage
<?php forum_topics( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘forum_topics’:
apply_
Filters
( ‘forum_topics’, get_forum_topics( $forum_id ), $forum_id )
Source File
forum_topics() is located in bb-includes/functions.bb-template.php
get_forum_topics()
Description
Retrieves topics started by a user in a forum.
Usage
<?php get_forum_topics( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns topics in a forum.
Filters
‘get_forum_topics’:
apply_
Filters
( ‘get_forum_topics’, $forum->topics, $forum->forum_id )
Source File
get_forum_topics() is located in bb-includes/functions.bb-template.php
forum_posts()
Description
Displays posts posted by a user in a forum.
Usage
<?php forum_posts( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘forum_posts’:
apply_
Filters
( ‘forum_posts’, get_forum_posts( $forum_id ), $forum_id )
Source File
forum_posts() is located in bb-includes/functions.bb-template.php
get_forum_posts()
Description
Retrieves posts posted by a user in a forum.
Usage
<?php get_forum_posts( $forum_id = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
Return Values
Returns the posts of the forum.
Filters
‘get_forum_posts’:
apply_
Filters
( ‘get_forum_posts’, $forum->posts, $forum->forum_id )
Source File
get_forum_posts() is located in bb-includes/functions.bb-template.php
forum_pages()
Description
Retrieves and displays forum pages.
Usage
<?php forum_pages( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘forum_pages’:
apply_
Filters
( ‘forum_pages’, get_page_number_links( $page, $forum->topics ), $forum->topics )
Source File
forum_pages() is located in bb-includes/functions.bb-template.php
bb_forum_posts_rss_link()
Description
Displays rss link found in posts in a forum.
Usage
<?php bb_forum_posts_rss_link( $forum_id = 0, $context = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
$context
Return Values
This function does not return any value.
Filters
‘bb_forum_posts_rss_link’:
apply_
Filters
(‘bb_forum_posts_rss_link’, bb_get_forum_posts_rss_link( $forum_id, $context ), $context )
Source File
bb_forum_posts_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_forum_posts_rss_link()
Description
Retrieves rss ( Rich Site Summary) link found in posts in a forum.
Usage
<?php bb_get_forum_posts_rss_link( $forum_id = 0, $context = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
$context
Return Values
Returns the rss links found in a post.
Filters
‘bb_get_forum_posts_rss_link’:
apply_
Filters
(‘bb_get_forum_posts_rss_link’, $link, $forum->forum_id, $context )
Source File
bb_get_forum_posts_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_forum_topics_rss_link()
Description
Retrieves rss ( Really Simple Syndication) link found in topics in a forum.
Usage
<?php bb_get_forum_topics_rss_link( $forum_id = 0, $context = 0 ); ?>
Parameters
$forum_id
(integer)Forum identifier initialised to 0.
$context
Return Values
Returns the rss links found in a topic.
Filters
‘bb_get_forum_topics_rss_link’:
apply_
Filters
( ‘bb_get_forum_topics_rss_link’, $link, $forum->forum_id, $context )
Source File
bb_get_forum_topics_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_forum_bread_crumb()
Description
Retrieves user’s position in form of hierarchy in a forum.
Usage
<?php bb_get_forum_bread_crumb($args = ''); ?>
Parameters
$args
(array)Default values.
Return Values
Returns the position in hierarchical order.
Filters
‘bb_get_forum_bread_crumb’:
apply_
Filters
(‘bb_get_forum_bread_crumb’, $trail, $forum_id )
Source File
bb_get_forum_bread_crumb()is located in bb-includes/functions.bb-template.php
bb_forum_bread_crumb()
Description
Displays user’s position in form of hierarchy in a forum.
Usage
<?php bb_forum_bread_crumb($args = ''); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_forum_bread_crumb’:
apply_
Filters
(‘bb_forum_bread_crumb’, bb_get_forum_bread_crumb( $args ) )
Source File
bb_forum_bread_crumb()is located in bb-includes/functions.bb-template.php
&bb_forums()
Description
Used for checking forum loop,that is, whether the forum is flat or nested.Default type is flat.
Usage
<?php &bb_forums($args = ''); ?>
Parameters
$args
(array)Default values.
Return Values
(boolean)
Whether loop exist or not.
Filters
No filter.
Source File
&bb_forums()is located in bb-includes/functions.bb-template.php
bb_forum()
Description
Retrieves current depth using forum loop.
Usage
<?php bb_forum(); ?>
Parameters
No parameter.
Return Values
Returns current depth.
Filters
No filter.
Source File
bb_forum()is located in bb-includes/functions.bb-template.php
bb_forum_pad()
Description
This function is for adding padding.Specifically for faking a heirarchical tree view in a parent/child relationship.
Usage
<?php bb_forum_pad( $pad, $offset = 0 ); ?>
Parameters
$pad
$offset
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_forum_pad()is located in bb-includes/functions.bb-template.php
bb_forum_class()
Description
Displays class of the forum.
Usage
<?php bb_forum_class( $args = null ); ?>
Parameters
$args
(boolean)Default values.
Return Values
This function does not return any value.
Filters
‘bb_forum_class’:
apply_
Filters
( ‘bb_forum_class’, get_alt_class( ‘forum’, bb_get_forum_class_names( $args ) ), $args )
Source File
bb_forum_class()is located in bb-includes/functions.bb-template.php
bb_get_forum_class()
Description
Retrieves class of the forum.
Usage
<?php bb_get_forum_class( $args = null ); ?>
Parameters
$args
(boolean)Default values.
Return Values
Returns class.
Filters
‘bb_get_forum_class’:
apply_
Filters
(‘bb_get_forum_class’, $classes, $args)
Source File
bb_get_forum_class()is located in bb-includes/functions.bb-template.php
b_get_forum_class_names()
Description
Retrieves class name of the forum.
Usage
<?php bb_get_forum_class_names( $args = null ); ?>
Parameters
$args
(boolean)Default values.
Return Values
Returns class name.
Filters
‘bb_get_forum_class’:
apply_
Filters
(‘bb_get_forum_class’, $classes, $args)
Source File
bb_get_forum_class_names()is located in bb-includes/functions.bb-template.php
topic_id()
Description
Displays topic id.
Usage
<?php topic_id( $id = 0 ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘topic_id’:
apply_
Filters
( ‘topic_id’, get_topic_id( $id ) )
Source File
topic_id() is located in bb-includes/functions.bb-template.php
get_topic_id()
Description
Retrieves topic id.
Usage
<?php get_topic_id( $id = 0 ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
(integer)
Returns topic id.
Filters
No Filters.
Source File
get_topic_id() is located in bb-includes/functions.bb-template.php
topic_link()
Description
Displays link to a topic.
Usage
<?php topic_link( $id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$page
(integer)Initialsed to 1.
$context
Return Values
This function does not return any value.
Filters
‘topic_link’:
apply_
Filters
( ‘topic_link’, get_topic_link( $id, $page, $context ), $id, $page, $context )
Source File
topic_link() is located in bb-includes/functions.bb-template.php
get_topic_link()
Description
Retrieves link to the topic.
Usage
<?php get_topic_link( $id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$page
(integer)Initialsed to 1.
$context
Return Values
Returns link.
Filters
‘get_topic_link’:
apply_
Filters
( ‘get_topic_link’, $link, $topic->topic_id, $context )
Source File
get_topic_link() is located in bb-includes/functions.bb-template.php
topic_rss_link()
Description
Displays rss link in the topic.
Usage
<?php topic_rss_link( $id = 0, $context = 0 ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$context
Return Values
This function does not return any value.
Filters
‘topic_rss_link’:
apply_
Filters
(‘topic_rss_link’, get_topic_rss_link($id, $context), $id, $context )
Source File
topic_rss_link() is located in bb-includes/functions.bb-template.php
get_topic_rss_link()
Description
Retrieves rss link in the topic.
Usage
<?php get_topic_rss_link( $id = 0, $context = 0 ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$context
Return Values
Returns rss link.
Filters
‘get_topic_rss_link’:
apply_
Filters
( ‘get_topic_rss_link’, $link, $topic->topic_id, $context )
Source File
get_topic_rss_link() is located in bb-includes/functions.bb-template.php
bb_topic_labels()
Description
Displays labels of the topic.
Usage
<?php bb_topic_labels(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
‘bb_topic_labels’:
apply_
Filters
( ‘bb_topic_labels’, null )
Source File
bb_topic_labels() is located in bb-includes/functions.bb-template.php
topic_title()
Description
Displays title of the topic.
Usage
<?php topic_title($id=0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘topic_title’:
apply_
Filters
( ‘topic_title’, get_topic_title( $id ), get_topic_id( $id ) )
Source File
topic_title() is located in bb-includes/functions.bb-template.php
get_topic_title()
Description
Retrieves title of the topic.
Usage
<?php get_topic_title($id=0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
(string)
Returns title.
Filters
‘get_topic_title’:
apply_
Filters
( ‘get_topic_title’, $topic->topic_title, $topic->topic_id )
Source File
get_topic_title() is located in bb-includes/functions.bb-template.php
get_topic_title()
Description
Retrieves title of the topic.
Usage
<?php get_topic_title($id=0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
(string)
Returns title.
Filters
‘get_topic_title’:
apply_
Filters
( ‘get_topic_title’, $topic->topic_title, $topic->topic_id )
Source File
get_topic_title() is located in bb-includes/functions.bb-template.php
topic_page_links()
Description
Displays links to the topic page.
Usage
<?php topic_page_links( $id = 0, $args = null ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘topic_page_links’:
apply_
Filters
( ‘topic_page_links’, get_topic_page_links( $id, $args ), get_topic_id( $id ) )
Source File
topic_page_links() is located in bb-includes/functions.bb-template.php
get_topic_page_links()
Description
Retrieves links to the topic page.
Usage
<?php get_topic_page_links( $id = 0, $args = null ); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
$args
(array)Default values.
Return Values
Returns links.
Filters
‘get_topic_page_links’:
apply_
Filters
( ‘get_topic_page_links’, $r, $_links, $topic->topic_id )
Source File
get_topic_page_links() is located in bb-includes/functions.bb-template.php
bb_topic_voices()
Description
Displays number of voices (people invovled in discussion) in the topic.
Usage
<?php bb_topic_voices( $id = 0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘bb_topic_voices’:
apply_
Filters
( ‘bb_topic_voices’, bb_get_topic_voices( $id ), get_topic_id( $id ) )
Source File
bb_topic_voices() is located in bb-includes/functions.bb-template.php
bb_get_topic_voices()
Description
Retrieves number of voices (people invovled in discussion) in the topic.
Usage
<?php bb_get_topic_voices( $id = 0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
(interger)
Returns count of voices.
Filters
‘bb_get_topic_voices’:
apply_
Filters
( ‘bb_get_topic_voices’, $voices, $topic->topic_id )
Source File
bb_get_topic_voices() is located in bb-includes/functions.bb-template.php
topic_posts()
Description
Displays posts in the topic.
Usage
<?php topic_posts( $id = 0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘topic_posts’:
apply_
Filters
( ‘topic_posts’, get_topic_posts( $id ), get_topic_id( $id ) )
Source File
topic_posts() is located in bb-includes/functions.bb-template.php
get_topic_posts()
Description
Retrieves posts in the topic.
Usage
<?php get_topic_posts( $id = 0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
Returns posts.
Filters
‘get_topic_posts’:
apply_
Filters
( ‘get_topic_posts’, $topic->topic_posts, $topic->topic_id )
Source File
get_topic_posts() is located in bb-includes/functions.bb-template.php
get_topic_deleted_posts()
Description
Retrieves deleted posts in the topic.
Usage
<?php get_topic_deleted_posts( $id = 0); ?>
Parameters
$id
(integer)Topic identifier initialised to 0.
Return Values
Returns deleted posts.
Filters
‘get_topic_deleted_posts’:
apply_
Filters
( ‘get_topic_deleted_posts’, isset($topic->deleted_posts) ? $topic->deleted_posts : 0, $topic->topic_id )
Source File
get_topic_deleted_posts() is located in bb-includes/functions.bb-template.php
topic_noreply()
Description
Retrieves title for the topic which has got no reply.
Usage
<?php topic_noreply( $title ); ?>
Parameters
$title
(string)Title of the topic.
Return Values
Returns title.
Filters
No filter.
Source File
topic_noreply() is located in bb-includes/functions.bb-template.php
topic_last_poster()
Description
Displays id of the last poster in a topic.
Usage
<?php topic_last_poster( $id=0); ?>
Parameters
$id
(integer)Identifier initialsed to 0.
Return Values
This function does not return any value.
Filters
‘topic_last_poster’:
apply_
Filters
( ‘topic_last_poster’, get_topic_last_poster( $id ), $topic->topic_last_poster, $topic->topic_id )
Source File
topic_last_poster() is located in bb-includes/functions.bb-template.php
get_topic_last_poster()
Description
Retrieves user display name of the last poster in a topic.
Usage
<?php get_topic_last_poster( $id=0); ?>
Parameters
$id
(integer)Identifier initialsed to 0.
Return Values
Returns user display name.
Filters
‘get_topic_last_poster’:
apply_
Filters
( ‘get_topic_last_poster’, $user_display_name, $topic->topic_last_poster, $topic->topic_id )
Source File
get_topic_last_poster() is located in bb-includes/functions.bb-template.php
topic_author()
Description
Displays id of the author of the topic.
Usage
<?php topic_author( $id=0); ?>
Parameters
$id
(integer)Identifier initialsed to 0.
Return Values
This function does not return any value.
Filters
‘topic_author’:
apply_
Filters
( ‘topic_author’, get_topic_author( $id ), $topic->topic_poster, $topic->topic_id )
Source File
topic_author() is located in bb-includes/functions.bb-template.php
get_topic_author()
Description
Retrieves user dispaly name of the author of the topic.
Usage
<?php get_topic_author( $id=0); ?>
Parameters
$id
(integer)Identifier initialsed to 0.
Return Values
Returns user display name.
Filters
‘get_topic_author’:
apply_
Filters
(‘get_topic_author’, $user_display_name, $topic->topic_poster, $topic->topic_id )
Source File
get_topic_author() is located in bb-includes/functions.bb-template.php
topic_time()
Description
Displays the total time since when the topic existed.
Usage
<?php topic_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘topic_time’:
apply_
Filters
(‘topic_time’, get_topic_time( array(‘format’ => ‘mysql’) + $args), $args )
Source File
topic_time() is located in bb-includes/functions.bb-template.php
get_topic_time()
Description
Retrieves the total time since when the topic existed.
Usage
<?php get_topic_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns total time.
Filters
‘get_topic_time’:
apply_
Filters
(‘get_topic_time’, $topic->topic_time, $args)
Source File
get_topic_time() is located in bb-includes/functions.bb-template.php
topic_start_time()
Description
Displays the starting time of the topic.
Usage
<?php topic_start_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘topic_start_time’:
apply_
Filters
(‘topic_start_time’, get_topic_start_time( array(‘format’ => ‘mysql’) + $args), $args )
Source File
topic_start_time() is located in bb-includes/functions.bb-template.php
get_topic_start_time()
Description
Retrieves the starting time of the topic.
Usage
<?php get_topic_start_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns starting time.
Filters
‘get_topic_start_time’:
apply_
Filters
(‘get_topic_start_time’, $topic->topic_start_time, $args, $topic->topic_id )
Source File
get_topic_start_time() is located in bb-includes/functions.bb-template.php
topic_last_post_link()
Description
Displays the link to last post of the topic.
Usage
<?php topic_last_post_link( $id=0); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘topic_last_post_link’:
apply_
Filters
( ‘topic_last_post_link’, get_topic_last_post_link( $id ), $id)
Source File
topic_last_post_link() is located in bb-includes/functions.bb-template.php
get_topic_last_post_link()
Description
Retrieves the link to last post of the topic.
Usage
<?php get_topic_last_post_link( $id=0); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns link.
Filters
‘get_post_link’:
apply_
Filters
( ‘get_post_link’, get_topic_link( $topic->topic_id, $page ) . “#post-$topic->topic_last_post_id”, $topic->topic_last_post_id, $topic->topic_id )
Source File
get_topic_last_post_link() is located in bb-includes/functions.bb-template.php
topic_pages()
Description
Displays topic pages.
Usage
<?php topic_pages( $args = null); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘topic_pages’:
apply_
Filters
( ‘topic_pages’, get_page_number_links( $page, $topic->topic_posts + $add ), $topic->topic_id )
Source File
topic_pages() is located in bb-includes/functions.bb-template.php
topic_pages_add()
Description
Displays added pages to the topic.
Usage
<?php topic_pages_add( $id = 0); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns added pages.
Filters
‘topic_pages_add’:
apply_
Filters
( ‘topic_pages_add’, $add, isset($topic->topic_id) ? $topic->topic_id : 0 )
Source File
topic_pages_add() is located in bb-includes/functions.bb-template.php
get_page_number_links()
Description
Retrieves links to page number.
Usage
<?php get_page_number_links( $args ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns links.
Filters
No filter.
Source File
get_page_number_links() is located in bb-includes/functions.bb-template.php
bb_topic_admin()
Description
Gives admin options to delete,close,move or stick the topic.
Usage
<?php bb_topic_admin( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns links.
Filters
‘bb_topic_admin’:
apply_
Filters
( ‘bb_topic_admin’, $parts, $args )
Source File
bb_topic_admin() is located in bb-includes/functions.bb-template.php
topic_delete_link()
Description
Displays link to delete the topic.
Usage
<?php topic_delete_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_delete_link() is located in bb-includes/functions.bb-template.php
bb_get_topic_delete_link()
Description
Retrieves link to delete the topic.
Usage
<?php bb_get_topic_delete_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
No filter.
Source File
bb_get_topic_delete_link() is located in bb-includes/functions.bb-template.php
topic_close_link()
Description
Displays link to close the topic.
Usage
<?php topic_close_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_close_link() is located in bb-includes/functions.bb-template.php
bb_get_topic_close_link()
Description
Retrieves link to close the topic.
Usage
<?php bb_get_topic_close_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
No filter.
Source File
bb_get_topic_close_link() is located in bb-includes/functions.bb-template.php
topic_sticky_link()
Description
Displays link to stick the topic.
Usage
<?php topic_sticky_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_sticky_link() is located in bb-includes/functions.bb-template.php
bb_get_topic_sticky_link()
Description
Retrieves link to stick the topic.
Usage
<?php bb_get_topic_sticky_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
No filter.
Source File
bb_get_topic_sticky_link() is located in bb-includes/functions.bb-template.php
topic_show_all_link()
Description
Displays all links present for the topic.
Usage
<?php topic_show_all_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_show_all_link() is located in bb-includes/functions.bb-template.php
topic_posts_link()
Description
Displays all links present for the posts in a topic.
Usage
<?php topic_posts_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_posts_link() is located in bb-includes/functions.bb-template.php
get_topic_posts_link()
Description
Retrieves all links present for the posts in a topic.
Usage
<?php get_topic_posts_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns link.
Filters
No filter.
Source File
get_topic_posts_link() is located in bb-includes/functions.bb-template.php
topic_move_dropdown()
Description
Displays move to options below the topic.
Usage
<?php topic_move_dropdown( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_move_dropdown() is located in bb-includes/functions.bb-template.php
bb_get_topic_move_dropdown()
Description
Retrieves move to options below the topic.
Usage
<?php bb_get_topic_move_dropdown( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns options.
Filters
No filter.
Source File
bb_get_topic_move_dropdown() is located in bb-includes/functions.bb-template.php
topic_class()
Description
Stores the status of the topic as ‘Deleted’ or ‘Closed’ or ‘Bozo’ or ‘Sticky’ or ‘Sticky Super-sticky’.
Usage
<?php topic_class( $class = '', $key = 'topic', $id = 0 ); ?>
Parameters
$class
Stores the status of the topic.
$key
Initialised as ‘topic’
$id
(integer)Identifier initialised to 0.
Return Values
This function does not have any return value.
Filters
‘topic_class’:
apply_
Filters
( ‘topic_class’, $class, $topic->topic_id )
Source File
topic_class() is located in bb-includes/functions.bb-template.php
bb_get_new_topic_link()
Description
Get the link to the form for a new topic.
Usage
<?php bb_get_new_topic_link( $args = null ); ?>
Parameters
$args
(arrray)Default values.
Return Values
(string)
The link to the new topic form.
Filters
‘new_topic_url’:
apply_
Filters
( ‘new_topic_url’, $url, $args )
Source File
bb_get_new_topic_link() is located in bb-includes/functions.bb-template.php
bb_new_topic_link()
Description
Displays the link to the form for a new topic.
Usage
<?php bb_new_topic_link( $args = null ); ?>
Parameters
$args
(arrray)Default values.
Return Values
This function does not return any value.
Filters
No Filters.
Source File
bb_new_topic_link() is located in bb-includes/functions.bb-template.php
bb_new_topic_forum_dropdown()
Description
Displays dropdown list for a new topic.
Usage
<?php bb_new_topic_forum_dropdown( $args = '' ); ?>
Parameters
$args
(arrray)Default values.
Return Values
This function does not return any value.
Filters
No Filters.
Source File
bb_new_topic_forum_dropdown() is located in bb-includes/functions.bb-template.php
bb_topic_search_form()
Description
Used for search form.
Usage
<?php bb_topic_search_form( $args = null, $query_obj = null ); ?>
Parameters
$args
(arrray)Default values.
$query_obj
(string)Holds search query.
Return Values
This function does not return any value.
Filters
No Filters.
Source File
bb_topic_search_form() is located in bb-includes/functions.bb-template.php
bb_search_pages()
Description
Displays search pages.
Usage
<?php bb_search_pages( $args = null ); ?>
Parameters
$args
(arrray)Default values.
Return Values
This function does not return any value.
Filters
‘bb_search_pages’:
apply_
Filters
( ‘bb_search_pages’, get_page_number_links( array( ‘page’ => $page, ‘total’ => $search_count, ‘per_page’ => $per_page, ‘mod_rewrite’ => false ) ) )
Source File
bb_search_pages() is located in bb-includes/functions.bb-template.php
bb_topic_pagecount()
Description
Print the total page count for a topic.
Usage
<?php bb_topic_pagecount( $topic_id = 0 ); ?>
Parameters
$topic_id
(integer)Topic identifier initialised to 0 for the topic being queried.
Return Values
(void)
This function does not return any value.
Filters
No filter.
Source File
bb_topic_pagecount() is located in bb-includes/functions.bb-template.php
bb_get_topic_pagecount()
Description
Get the total page count for a topic.
Usage
<?php bb_get_topic_pagecount( $topic_id = 0 ); ?>
Parameters
$topic_id
(integer)Topic identifier initialised to 0 for the topic being queried.
Return Values
( integer)
The total number of pages in the topic.
Filters
No filter.
Source File
bb_get_topic_pagecount() is located in bb-includes/functions.bb-template.php
bb_is_topic_lastpage()
Description
Report whether the current page is the last page of a given topic.
Usage
<?php bb_is_topic_lastpage( $topic_id = 0 ); ?>
Parameters
$topic_id
(integer)Topic identifier initialised to 0 for the topic being queried.
Return Values
(boolean)
True if called on the last page of a topic, otherwise false.
Filters
No filter.
Source File
bb_is_topic_lastpage() is located in bb-includes/functions.bb-template.php
post_id()
Description
Displays post id.
Usage
<?php post_id( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_id() is located in bb-includes/functions.bb-template.php
get_post_id()
Description
Retrieves post id.
Usage
<?php get_post_id( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
(integer)
Returns post id of the post.
Filters
No filter.
Source File
get_post_id() is located in bb-includes/functions.bb-template.php
post_link()
Description
Displays link to post.
Usage
<?php post_link( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This funciton does not return any value.
Filters
‘post_link’:
apply_
Filters
( ‘post_link’, get_post_link( $post_id ), get_post_id( $post_id ) )
Source File
post_link() is located in bb-includes/functions.bb-template.php
get_post_link()
Description
Retrieves link to post.
Usage
<?php get_post_link( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
(string)
Returns link.
Filters
‘get_post_link’:
apply_
Filters
( ‘get_post_link’, get_topic_link( $bb_post->topic_id, $page ) . “#post-$bb_post->post_id”, $bb_post->post_id )
Source File
get_post_link() is located in bb-includes/functions.bb-template.php
post_anchor_link()
Description
Displays anchor link to post.
Usage
<?php post_anchor_link( $force_full = false ); ?>
Parameters
$force_full
(boolean)Initialised to false.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_anchor_link() is located in bb-includes/functions.bb-template.php
post_position()
Description
Displays position of post.
Usage
<?php post_position($post_id = 0); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘post_position’:
apply_
Filters
( ‘post_position’, get_post_position( $post_id ), get_post_id( $post_id ) )
Source File
post_position() is located in bb-includes/functions.bb-template.php
get_post_position()
Description
Retrieves position of post.
Usage
<?php get_post_position($post_id = 0); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
Returns position.
Filters
‘get_post_position’:
apply_
Filters
( ‘get_post_position’, $bb_post->post_position, $bb_post->post_id )
Source File
get_post_position() is located in bb-includes/functions.bb-template.php
post_position_link()
Description
Displays link to position of post.
Usage
<?php post_position_link( $topic_id = 0, $position = 1); ?>
Parameters
$topic_id
(integer)Topic identifier initialised to 0 for the topic being queried.
$position
(integer)Initialised to 1.
Return Values
This function does not return any value.
Filters
‘post_position_link’:
apply_
Filters
( ‘post_position_link’, get_post_position_link( $topic_id, $position ), get_topic_id( $topic_id ), (integer) $position )
Source File
post_position_link() is located in bb-includes/functions.bb-template.php
get_post_position_link()
Description
Retrieves link to position of post.
Usage
<?php get_post_position_link( $topic_id = 0, $position = 1); ?>
Parameters
$topic_id
(integer)Topic identifier initialised to 0 for the topic being queried.
$position
(integer)Initialised to 1.
Return Values
(string)
Returns link.
Filters
‘get_post_position_link’:
apply_
Filters
( ‘get_post_position_link’, get_topic_link( $bb_post->topic_id, $page ) . “#position-$position”, $bb_topic->topic_id, $position )
Source File
get_post_position_link() is located in bb-includes/functions.bb-template.php
bb_post_meta()
Description
This function displays the values of the custom fields with the specified key from the specified post.
Usage
<?php bb_post_meta( $key, $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
$key
(string) (required) A string containing the name of the meta value you want.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_post_meta() is located in bb-includes/functions.bb-template.php
bb_get_post_meta()
Description
This function retrieves the values of the custom fields with the specified key from the specified post.
Usage
<?php bb_post_meta( $key, $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
$key
(string) (required) A string containing the name of the meta value you want.
Return Values
(string)
Returns values of custom fields.
Filters
No filter.
Source File
bb_get_post_meta() is located in bb-includes/functions.bb-template.php
post_author()
Description
Displays the post author.
Usage
<?php post_author( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘ post_author’:
apply_
Filters
( ‘post_author’, get_post_author( $post_id ), $post_id )
Source File
post_author() is located in bb-includes/functions.bb-template.php
get_post_author()
Description
Retrieves the post author.
Usage
<?php post_author( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
(string)
Returns author’s display name.
Filters
‘get_post_author’:
apply_
Filters
( ‘get_post_author’, $user->display_name, $user->ID, $post_id );
‘bb_get_pingback_title’:
apply_
Filters
( ‘bb_get_pingback_title’, $title, $post_id );
‘get_post_author’:
apply_
Filters
( ‘get_post_author’, $title, 0, $post_id );
‘get_post_author’:
apply_
Filters
( ‘get_post_author’, __(‘Anonymous’), 0, $post_id );
Source File
get_post_author() is located in bb-includes/functions.bb-template.php
post_author_link()
Description
This function displays link to specified post.
Usage
<?php post_author_link( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_author_link() is located in bb-includes/functions.bb-template.php
post_author_avatar()
Description
This function displays author’s avatar of specified post.
Usage
<?php post_author_avatar( $size = '48', $default = '', $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
$size
(integer)(optional) Size of avatar to return (max is 512).
$default
(string) (optional) url for an image.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_author_avatar() is located in bb-includes/functions.bb-template.php
post_author_avatar_link()
Description
This function displays link to author’s avatar of specified post.
Usage
<?php post_author_avatar_link( $size = '48', $default = '', $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
$size
(integer)(optional) Size of avatar to return (max is 512).
$default
(string) (optional) url for an image.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_author_avatar_link() is located in bb-includes/functions.bb-template.php
post_text()
Description
This function displays text present in the specified post.
Usage
<?php post_text( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
This function does not return any value.
Filters
‘post_text’:
apply_
Filters
( ‘post_text’, get_post_text( $post_id ), get_post_id( $post_id ) )
Source File
post_text() is located in bb-includes/functions.bb-template.php
get_post_text()
Description
This function Retrieves text present in the specified post.
Usage
<?php get_post_text( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
(string)
Returns the text present in the post.
Filters
‘get_post_text’:
apply_
Filters
( ‘get_post_text’, $bb_post->post_text, $bb_post->post_id )
Source File
get_post_text() is located in bb-includes/functions.bb-template.php
bb_post_time()
Description
This function displays time of the specified post.
Usage
<?php bb_post_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_post_time’:
apply_
Filters
(‘bb_post_time’, bb_get_post_time( array(‘format’ => ‘mysql’) + $args ), $args )
Source File
bb_post_time() is located in bb-includes/functions.bb-template.php
bb_get_post_time()
Description
This function retrieves time of the specified post.
Usage
<?php bb_get_post_time( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns time.
Filters
‘bb_get_post_time’:
apply_
Filters
(‘bb_get_post_time’, $bb_post->post_time, $args)
Source File
bb_get_post_time() is located in bb-includes/functions.bb-template.php
post_ip()
Description
This function displays ip address of the specified post.
Usage
<?php post_ip( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
This function does not return any value.
Filters
‘post_ip’:
apply_
Filters
(‘post_ip’, get_post_ip( $post_id ), get_post_id( $post_id ) )
Source File
post_ip() is located in bb-includes/functions.bb-template.php
get_post_ip()
Description
This function retrieves ip address of the specified post.
Usage
<?php get_post_ip( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
Return ip address.
Filters
‘get_post_ip’:
apply_
Filters
(‘get_post_ip’, $bb_post->poster_ip, $bb_post->post_id )
Source File
get_post_ip() is located in bb-includes/functions.bb-template.php
bb_post_admin()
Description
This function displays various options to the admin of the specified post.
Usage
<?php bb_post_admin( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_post_admin’:
apply_
Filters
(‘bb_post_admin’, $parts, $args )
Source File
bb_post_admin() is located in bb-includes/functions.bb-template.php
post_ip_link()
Description
This function displays link to the ip address of the specified post.
Usage
<?php post_ip_link($args = null); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_ip_link() is located in bb-includes/functions.bb-template.php
get_post_ip_link()
Description
This function Retrieves link to the ip address of the specified post.
Usage
<?php get_post_ip_link($args = null); ?>
Parameters
$args
(array)Default values.
Return Values
(string)
Returns link.
Filters
‘post_ip_link’:
apply_
Filters
( ‘post_ip_link’, $link, $bb_post->post_id, $args )
Source File
get_post_ip_link() is located in bb-includes/functions.bb-template.php
post_edit_link()
Description
This function displays link to edit the specified post.
Usage
<?php post_edit_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_edit_link() is located in bb-includes/functions.bb-template.php
bb_get_post_edit_link()
Description
This function retrieves link to edit the specified post.
Usage
<?php bb_get_post_edit_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
(string)
Returns link.
Filters
‘bb_get_post_edit_link’:
apply_
Filters
( ‘bb_get_post_edit_link’, $r, $bb_post->post_id, $args )
Source File
bb_get_post_edit_link() is located in bb-includes/functions.bb-template.php
post_del_class()
Description
This function .
Usage
<?php post_del_class( $post_id = 0 ); ?>
Parameters
$post_id
(integer) (required) The ID of the post from which you want the data.
Return Values
Return ip address.
Filters
‘post_del_class’:
apply_
Filters
( ‘post_del_class’, $classes, $bb_post->post_id, $bb_post )
Source File
post_del_class() is located in bb-includes/functions.bb-template.php
post_delete_link()
Description
This function displays link to delete the specified post.
Usage
<?php post_delete_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
post_delete_link() is located in bb-includes/functions.bb-template.php
bb_get_post_delete_link()
Description
This function retrieves link to delete the specified post.
Usage
<?php bb_get_post_delete_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
(string)
Returns link.
Filters
‘post_delete_link’:
apply_
Filters
( ‘post_delete_link’, $r, $bb_post->post_status, $bb_post->post_id, $args )
Source File
bb_get_post_delete_link() is located in bb-includes/functions.bb-template.php
bb_post_undelete_link()
Description
This function displays link to undelete the specified post.
Usage
<?php bb_post_undelete_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_post_undelete_link() is located in bb-includes/functions.bb-template.php
bb_get_post_undelete_link()
Description
This function displays link to undelete the specified post.
Usage
<?php bb_get_post_undelete_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘post_undelete_link’:
apply_
Filters
( ‘post_undelete_link’, $r, $bb_post->post_status, $bb_post->post_id, $args )
Source File
bb_get_post_undelete_link() is located in bb-includes/functions.bb-template.php
post_author_id()
Description
Displays ID of the author of the post.
Usage
<?php post_author_id( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘post_author_id’:
apply_
Filters
( ‘post_author_id’, get_post_author_id( $post_id ), get_post_id( $post_id ) )
Source File
post_author_id() is located in bb-includes/functions.bb-template.php
get_post_author_id()
Description
Retrieves ID of the author of the post.
Usage
<?php post_author_id( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
Returns author’s ID.
Filters
‘get_post_author_id’:
apply_
Filters
( ‘get_post_author_id’, (int) $bb_post->poster_id, get_post_id( $post_id ) )
Source File
get_post_author_id() is located in bb-includes/functions.bb-template.php
post_author_title()
Description
Displays title of the author of the post.
Usage
<?php post_author_title( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘post_author_id’:
apply_
Filters
( ‘post_author_title’, get_post_author_title( $post_id ), get_post_id( $post_id ) )
Source File
post_author_title() is located in bb-includes/functions.bb-template.php
get_post_author_title()
Description
Retrieves title of the author of the post.
Usage
<?php get_post_author_title( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
Returns author’s title.
Filters
No filter.
Source File
get_post_author_title() is located in bb-includes/functions.bb-template.php
post_author_title_link()
Description
Displays link to the title of the author of the post.
Usage
<?php post_author_title_link( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘post_author_title_link’:
apply_
Filters
( ‘post_author_title_link’, get_post_author_title_link( $post_id ), get_post_id( $post_id ) )
Source File
post_author_title_link() is located in bb-includes/functions.bb-template.php
get_post_author_title_link()
Description
Retrieves link to the title of the author of the post.
Usage
<?php get_post_author_title_link( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
Returns link to title.
Filters
‘get_post_author_title_link’:
apply_
Filters
( ‘get_post_author_title_link’, $r, get_post_id( $post_id ) )
Source File
get_post_author_title_link() is located in bb-includes/functions.bb-template.php
post_author_type()
Description
Displays type of the author of the post.
Usage
<?php post_author_type( $post_id = 0 ); ?>
Parameters
$post_id
(integer)Post identifier initialised to 0 for the post being queried.
Return Values
This function does not return any value.
Filters
‘post_author_type’:
apply_
Filters
( ‘post_author_type’, $r, $post_id )
Source File
post_author_type() is located in bb-includes/functions.bb-template.php
allowed_markup()
Description
Displays allowed markup option.
Usage
<?php allowed_markup( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘allowed_markup’:
apply_
Filters
( ‘allowed_markup’, get_allowed_markup( $args ) )
Source File
allowed_markup() is located in bb-includes/functions.bb-template.php
get_allowed_markup()
Description
Retrieves allowed markup option.
Usage
<?php get_allowed_markup( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns allowed markup.
Filters
‘get_allowed_markup’:
apply_
Filters
(‘get_allowed_markup’, $r, $format)
Source File
get_allowed_markup() is located in bb-includes/functions.bb-template.php
bb_get_user_id()
Description
Retrieves ID of the user.
Usage
<?php bb_get_user_id($id = 0); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
(integer)
Returns user ID.
Filters
No filter.
Source File
bb_get_user_id() is located in bb-includes/functions.bb-template.php
user_profile_link()
Description
Displays link to user profile.
Usage
<?php user_profile_link($id = 0 , $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
$page
(integer)Initialised to 1.
$context
Return Values
This function does not return any value.
Filters
‘user_profile_link’:
apply_
Filters
( ‘user_profile_link’, get_user_profile_link( $id ), bb_get_user_id( $id ), $context )
Source File
user_profile_link() is located in bb-includes/functions.bb-template.php
get_user_profile_link()
Description
Retrieves link to user profile.
Usage
<?php get_user_profile_link($id = 0 , $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
$page
(integer)Initialised to 1.
$context
Return Values
Returns link.
Filters
‘get_user_profile_link’:
apply_
Filters
( ‘get_user_profile_link’, $r, $user->ID, $context )
Source File
get_user_profile_link() is located in bb-includes/functions.bb-template.php
user_delete_button()
Description
Displays delete button to delete any user.
Usage
<?php user_delete_button(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
‘user_delete_button’:
apply_
Filters
( ‘user_delete_button’, get_user_delete_button() )
Source File
user_delete_button() is located in bb-includes/functions.bb-template.php
get_user_delete_button()
Description
Retrieves delete button to delete any user.
Usage
<?php get_user_delete_button(); ?>
Parameters
No parameter.
Return Values
Returns submit type button.
Filters
‘get_user_delete_button’:
apply_
Filters
(‘get_user_delete_button’, $r)
Source File
get_user_delete_button() is located in bb-includes/functions.bb-template.php
profile_tab_link()
Description
Displays link to tab profile.
Usage
<?php profile_tab_link($id = 0, $tab, $page = 1 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
$tab
(unknown)used for tab.
$page
(integer)Initialised to 1.
Return Values
This function does not return any value.
Filters
‘profile_tab_link’:
apply_
Filters
(‘profile_tab_link’, get_profile_tab_link( $id, $tab ) )
Source File
profile_tab_link() is located in bb-includes/functions.bb-template.php
get_profile_tab_link()
Description
Retrieves link to tab profile.
Usage
<?php get_profile_tab_link( $id = 0, $tab, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
$tab
(unknown)used for tab.
$page
(integer)Initialised to 1.
$context
Return Values
Returns link.
Filters
‘get_profile_tab_link’:
apply_
Filters
( ‘get_profile_tab_link’, $r, $user->ID, $context )
Source File
get_profile_tab_link() is located in bb-includes/functions.bb-template.php
user_link()
Description
Displays link to user.
Usage
<?php user_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘user_link’:
apply_
Filters
( ‘user_link’, get_user_link( $id ), $id )
Source File
user_link() is located in bb-includes/functions.bb-template.php
get_user_link()
Description
Retrieves link to user.
Usage
<?php get_user_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
(string)
Returns link.
Filters
‘get_user_link’:
apply_
Filters
(‘get_user_link’, $user->user_url, $user->ID )
Source File
get_user_link() is located in bb-includes/functions.bb-template.php
full_user_link()
Description
Displays complete link with username.
Usage
<?php full_user_link( $id = 0 ) ; ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
full_user_link() is located in bb-includes/functions.bb-template.php
get_full_user_link()
Description
Retrieves complete link with username.
Usage
<?php get_full_user_link( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns link.
Filters
No filter.
Source File
get_full_user_link() is located in bb-includes/functions.bb-template.php
user_type_label()
Description
Displays label given to the role of the user.
Usage
<?php user_type_label( $type); ?>
Parameters
$type
(string)role of user.
Return Values
This function does not return any value.
Filters
‘user_type_label’:
apply_
Filters
( ‘user_type_label’, get_user_type_label( $type ), $type )
Source File
user_type_label() is located in bb-includes/functions.bb-template.php
get_user_type_label()
Description
Retrieves label given to the role of the user.
Usage
<?php get_user_type_label( $type); ?>
Parameters
$type
(string)role of user.
Return Values
(string)
Label of role.
Filters
‘get_user_type_label’:
apply_
Filters
(‘get_user_type_label’, $wp_roles->role_names[$type], $type)
Source File
get_user_type_label() is located in bb-includes/functions.bb-template.php
user_type()
Description
Displays role of the user.
Usage
<?php get_user_type_label( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘user_type’:
apply_
Filters
(‘user_type’, get_user_type( $id ), $id )
Source File
user_type() is located in bb-includes/functions.bb-template.php
get_user_type()
Description
Retrieves role of the user.Just supports one role for now.
Usage
<?php get_user_type_label( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns role of the user with first alphabet in caps.
Filters
‘get_user_type’:
apply_
Filters
(‘get_user_type’, $type, $user->ID)
Source File
get_user_type() is located in bb-includes/functions.bb-template.php
get_user_name()
Description
Retrieves user name.
Usage
<?php get_user_name( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns user name.
Filters
‘get_user_name’:
apply_
Filters
( ‘get_user_name’, $user->user_login, $user->ID )
Source File
get_user_name() is located in bb-includes/functions.bb-template.php
get_user_display_name()
Description
Retrieves user’s display name.
Usage
<?php get_user_display_name( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns user’s display name.
Filters
‘get_user_display_name’:
apply_
Filters
(‘get_user_display_name’, $user->display_name, $user->ID )
Source File
get_user_display_name() is located in bb-includes/functions.bb-template.php
user_title()
Description
Displays user’s title.
Usage
<?php user_title( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
‘user_title’:
apply_
Filters
( ‘user_title’, get_user_title( $id ), bb_get_user_id( $id ) )
Source File
user_title() is located in bb-includes/functions.bb-template.php
get_user_title()
Description
Retrieves user’s title.
Usage
<?php get_user_title( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
Returns title.
Filters
‘get_user_title’:
apply_
Filters
(‘get_user_title’, $user->title, $user->ID )
Source File
get_user_title() is located in bb-includes/functions.bb-template.php
profile_pages()
Description
Displays profile pages.
Usage
<?php profile_pages( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘profile_pages_add’:
apply_
Filters
( ‘profile_pages_add’, $add )
‘profile_pages’:
apply_
Filters
( ‘profile_pages’, get_page_number_links( $page, $user->topics_replied + $add ), $user->user_id ) )
Source File
profile_pages() is located in bb-includes/functions.bb-template.php
bb_profile_data()
Description
Displays profile data.
Usage
<?php bb_profile_data( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_profile_data() is located in bb-includes/functions.bb-template.php
bb_profile_base_content()
Description
Calls user function.
Usage
<?php bb_profile_base_content(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_profile_base_content() is located in bb-includes/functions.bb-template.php
bb_profile_data_form()
Description
Fires action to display profile data form to be filled by the user.
Usage
<?php bb_profile_data_form( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_profile_data_form() is located in bb-includes/functions.bb-template.php
bb_profile_admin_form()
Description
Displays admin form to be filled by the user if he/she is given the role to b an admin.
Usage
<?php bb_profile_admin_form( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_profile_admin_form() is located in bb-includes/functions.bb-template.php
bb_profile_password_form()
Description
Displays password form to be filled by the user.Provides hint for the password.
Usage
<?php bb_profile_password_form( $id = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_profile_password_form() is located in bb-includes/functions.bb-template.php
bb_logout_link()
Description
Displays link to log out of the account.
Usage
<?php bb_logout_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_logout_link’:
apply_
Filters
( ‘bb_logout_link’, bb_get_logout_link( $args ), $args )
Source File
bb_logout_link() is located in bb-includes/functions.bb-template.php
bb_get_logout_link()
Description
Retrieves link to log out of the account.
Usage
<?php bb_get_logout_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
‘bb_get_logout_link’:
apply_
Filters
(‘bb_get_logout_link’, $before . ‘‘ . $text . ‘‘ . $after, $args)
Source File
bb_get_logout_link() is located in bb-includes/functions.bb-template.php
bb_admin_link()
Description
Displays link to admin account.
Usage
<?php bb_admin_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_admin_link’:
apply_
Filters
(‘bb_admin_link’, bb_get_admin_link( $args ), $args)
Source File
bb_admin_link() is located in bb-includes/functions.bb-template.php
bb_get_admin_link()
Description
Retrieves link to admin account.
Usage
<?php bb_get_admin_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
‘bb_get_admin_link’:
apply_
Filters
(‘bb_get_admin_link’, $before . ‘‘ . $text . ‘‘ . $after, $args)
Source File
bb_get_admin_link() is located in bb-includes/functions.bb-template.php
bb_profile_link()
Description
Displays link to user profile.
Usage
<?php bb_profile_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘bb_profile_link’:
apply_
Filters
( ‘bb_profile_link’, bb_get_profile_link( $args ), $args)
Source File
bb_profile_link() is located in bb-includes/functions.bb-template.php
bb_get_profile_link()
Description
Retrieves link to user profile.
Usage
<?php bb_get_profile_link( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
‘bb_get_profile_link’:
apply_
Filters
(‘bb_get_profile_link’, “$before$text$after”, $args)
Source File
bb_get_profile_link() is located in bb-includes/functions.bb-template.php
bb_current_user_info()
Description
Displays information about the current user.
Usage
<?php bb_current_user_info( $key = '' ); ?>
Parameters
$key
(string) (required) A string containing the name of value you want.
Return Values
This function does not return any value.
Filters
‘bb_current_user_info’:
apply_
Filters
( ‘bb_current_user_info’, bb_get_current_user_info( $key ), $key)
Source File
bb_current_user_info() is located in bb-includes/functions.bb-template.php
bb_get_current_user_info()
Description
Retrieves information about the current user.
Usage
<?php bb_get_current_user_info( $key = '' ); ?>
Parameters
$key
(string) (required) A string containing the name of value you want.
Return Values
Returns data.
Filters
No filter.
Source File
bb_get_current_user_info() is located in bb-includes/functions.bb-template.php
bb_get_user_email()
Description
Retrieves email id of the user.
Usage
<?php bb_get_user_email( $id ); ?>
Parameters
$id
(integer)Identifier.
Return Values
Returns email id.
Filters
‘bb_get_user_email’:
apply_
Filters
( ‘bb_get_user_email’, $user->user_email, $id )
Source File
bb_get_user_email() is located in bb-includes/functions.bb-template.php
topic_tags()
Description
Loads topic-tags.php.
Usage
<?php topic_tags( ); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
topic_tags() is located in bb-includes/functions.bb-template.php
bb_tag_page_link()
Description
Displays link to tagged page.
Usage
<?php bb_tag_page_link(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_tag_page_link() is located in bb-includes/functions.bb-template.php
bb_get_tag_page_link()
Description
Retrieves link to tagged page.
Usage
<?php bb_get_tag_page_link( $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$context
(string)URI link.
Return Values
Returns link.
Filters
‘bb_get_tag_page_link’:
apply_
Filters
( ‘bb_get_tag_page_link’, $r, $context )
Source File
bb_get_tag_page_link() is located in bb-includes/functions.bb-template.php
bb_tag_link()
Description
Displays the correct link url for a given Tag ID.
Usage
<?php bb_tag_link( $tag_id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$tag_id
(integer)Tag ID.
$page
(integer)Initialised to 1.
$context
(string)URI link.
Return Values
This function does not return any value.
Filters
‘bb_tag_link’:
apply_
Filters
( ‘bb_tag_link’, bb_get_tag_link( $tag_id, $page, $context ), $tag_id, $page, $context )
Source File
bb_tag_link() is located in bb-includes/functions.bb-template.php
bb_get_tag_link()
Description
Retrieves the correct link url for a given Tag ID.
Usage
<?php bb_get_tag_link( $tag_id = 0, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$tag_id
(integer)Tag ID.
$page
(integer)Initialised to 1.
$context
(string)URI link.
Return Values
Returns link.
Filters
‘bb_get_tag_link’:
apply_
Filters
( ‘bb_get_tag_link’, $r, $_tag->tag, $page, $context )
Source File
bb_get_tag_link() is located in bb-includes/functions.bb-template.php
bb_tag_link_base()
Description
Displays the correct link url for base of the tag.
Usage
<?php bb_tag_link_base(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_tag_link_base() is located in bb-includes/functions.bb-template.php
bb_get_tag_link_base()
Description
Retrieves the correct link url for base of the tag.
Usage
<?php bb_get_tag_link_base(); ?>
Parameters
No parameter.
Return Values
Returns link.
Filters
No filter.
Source File
bb_get_tag_link_base() is located in bb-includes/functions.bb-template.php
bb_tag_name()
Description
Displays name of the tag according to the specified tag ID.
Usage
<?php bb_tag_name( $tag_id = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_tag_name() is located in bb-includes/functions.bb-template.php
bb_get_tag_name()
Description
Retrieves name of the tag according to the specified tag ID.
Usage
<?php bb_get_tag_name( $tag_id = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
Return Values
Returns tag name.
Filters
No filter.
Source File
bb_get_tag_name() is located in bb-includes/functions.bb-template.php
bb_tag_posts_rss_link()
Description
Displays rss link to posts having the specified tag ID.
Usage
<?php bb_tag_posts_rss_link( $tag_id = 0, $context = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
$context
(unknown)URI link
Return Values
This function does not return any value.
Filters
‘tag_posts_rss_link’:
apply_
Filters
( ‘tag_posts_rss_link’, bb_get_tag_posts_rss_link( $tagid, $context ), $tag_id, $context )
Source File
bb_tag_posts_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_tag_posts_rss_link()
Description
Retrieves rss link to posts having the specified tag ID.
Usage
<?php bb_get_tag_posts_rss_link( $tag_id = 0, $context = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
$context
(unknown)URI link
Return Values
Returns link.
Filters
‘get_tag_posts_rss_link’:
apply_
Filters
( ‘get_tag_posts_rss_link’, $link, $tag_id, $context )
Source File
bb_get_tag_posts_rss_link() is located in bb-includes/functions.bb-template.php
bb_tag_topics_rss_link()
Description
Displays rss link to topics having the specified tag ID.
Usage
<?php bb_tag_topics_rss_link( $tag_id = 0, $context = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
$context
(unknown)URI link
Return Values
This function does not return any value.
Filters
‘tag_topics_rss_link’:
apply_
Filters
( ‘tag_topics_rss_link’, bb_get_tag_topics_rss_link( $tag_id, $context ), $tag_id, $context )
Source File
bb_tag_topics_rss_link() is located in bb-includes/functions.bb-template.php
bb_get_tag_topics_rss_link()
Description
Retrieves rss link to topics having the specified tag ID.
Usage
<?php bb_get_tag_topics_rss_link( $tag_id = 0, $context = 0 ); ?>
Parameters
$tag_id
(integer)Tag ID.
$context
(unknown)URI link
Return Values
Returns link.
Filters
‘get_tag_topics_rss_link’:
apply_
Filters
( ‘get_tag_topics_rss_link’, $link, $tag_id, $context )
Source File
bb_get_tag_topics_rss_link() is located in bb-includes/functions.bb-template.php
bb_list_tags()
Description
Lists the tags in “li” format.
Usage
<?php bb_list_tags( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns list of tags.
Filters
No filter.
Source File
bb_list_tags() is located in bb-includes/functions.bb-template.php
_bb_list_tag_item()
Description
Lists the tag items in “li” format.
Usage
<?php _bb_list_tag_item( $tag, $args ); ?>
Parameters
$tag
(string)Tag name.
$args
(array)Default values.
Return Values
Returns list of tag items.
Filters
No filter.
Source File
_bb_list_tag_item() is located in bb-includes/functions.bb-template.php
tag_form()
Description
Displays a form to create a tag for a topic.
Usage
<?php tag_form( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
tag_form() is located in bb-includes/functions.bb-template.php
manage_tags_forms()
Description
Provides options( like rename , merge , destroy ) to manage tags at onClick event.
Usage
<?php manage_tags_forms(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
manage_tags_forms() is located in bb-includes/functions.bb-template.php
bb_tag_remove_link()
Description
Displays link to remove tag.
Usage
<?php bb_tag_remove_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_tag_remove_link() is located in bb-includes/functions.bb-template.php
bb_get_tag_remove_link()
Description
Retrieves link to remove tag.
Usage
<?php bb_get_tag_remove_link( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns link.
Filters
No filter.
Source File
bb_get_tag_remove_link() is located in bb-includes/functions.bb-template.php
bb_tag_heat_map()
Description
Displays tags on the basis of the count of topics containing them.The greater the count the larger the size.
Usage
<?php bb_tag_heat_map( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘tag_heat_map’:
apply_
Filters
( ‘tag_heat_map’, $r, $args )
Source File
bb_tag_heat_map() is located in bb-includes/functions.bb-template.php()
bb_get_tag_heat_map()
Description
Retrieves tags on the basis of the count of topics containing them.The greater the count the larger the size.
Usage
<?php bb_get_tag_heat_map( $tags, $args = ''); ?>
Parameters
$args
(array)Default values.
$tag
(string)Tag name.
Return Values
Returns tag names in various sizes.
Filters
‘bb_get_tag_heat_map’:
apply_
Filters
( ‘bb_get_tag_heat_map’, $r, $tags, $args )
Source File
bb_get_tag_heat_map() is located in bb-includes/functions.bb-template.php()
bb_sort_tag_heat_map()
Description
Sorts tags on the basis of count.
Usage
<?php bb_sort_tag_heat_map( &$tag_counts ); ?>
Parameters
$tag_counts
(string)Tag name.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_sort_tag_heat_map() is located in bb-includes/functions.bb-template.php()
tag_pages()
Description
Displays a list of page numbers the tag(keyword) was found in.
Usage
<?php tag_pages( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘tag_pages’:
apply_
Filters
( ‘tag_pages’, get_page_number_links( $page, $tagged_topic_count ) )
Source File
tag_pages() is located in bb-includes/functions.bb-template.php()
bb_forum_dropdown()
Description
Displays a drop down list box with forum options(disabled or selected).
Usage
<?php bb_forum_dropdown( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_forum_dropdown() is located in bb-includes/functions.bb-template.php()
bb_get_forum_dropdown()
Description
Retrieves a drop down list box with forum options(disabled or selected).
Usage
<?php bb_get_forum_dropdown( $args = '' ); ?>
Parameters
$args
(array)Default values.
Return Values
Returns ddlb.
Filters
No filter.
Source File
bb_get_forum_dropdown() is located in bb-includes/functions.bb-template.php()
favorites_link( )
Description
Displays link to your favorite user profiles.
Usage
<?php favorites_link( $user_id = 0 ); ?>
Parameters
$user_id
(integer)user ID.
Return Values
This function does not return any value.
Filters
‘favorites_link’:
apply_
Filters
( ‘favorites_link’, get_favorites_link( $user_id ) )
Source File
favorites_link() is located in bb-includes/functions.bb-template.php()
get_favorites_link( )
Description
Retrieves link to your favorite user profiles.
Usage
<?php get_favorites_link( $user_id = 0 ); ?>
Parameters
$user_id
(integer)user ID.
Return Values
Returns link.
Filters
‘get_favorites_link’:
apply_
Filters
( ‘get_favorites_link’, get_profile_tab_link($user_id, ‘favorites’), $user_id )
Source File
get_favorites_link() is located in bb-includes/functions.bb-template.php()
user_favorites_link()
Description
Displays link to user’s favorite topics.
Usage
<?php user_favorites_link($add = array(), $rem = array(), $user_id = 0); ?>
Parameters
$user_id
(integer)user ID.
$add
(array)
$rem
(array)
Return Values
This function does not return any value.
Filters
No filter.
Source File
user_favorites_link() is located in bb-includes/functions.bb-template.php()
bb_user_subscribe_link()
Description
Displays link to subscribe a topic.
Usage
<?php bb_user_subscribe_link(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_user_subscribe_link() is located in bb-includes/functions.bb-template.php()
favorites_rss_link()
Description
Displays favorite rss link.
Usage
<?php favorites_rss_link( $id = 0, $context = 0 ) ; ?>
Parameters
$id
(integer)Identifier initialised to 0.
$context
(string)URI link.
Return Values
This function does not return any value.
Filters
‘favorites_rss_link’:
apply_
Filters
(‘favorites_rss_link’, get_favorites_rss_link( $id, $context ), $context, $id)
Source File
favorites_rss_link() is located in bb-includes/functions.bb-template.php()
get_favorites_rss_link()
Description
Retrieves favorite rss link.
Usage
<?php get_favorites_rss_link( $id = 0, $context = 0 ); ?>
Parameters
$id
(integer)Identifier initialised to 0.
$context
(string)URI link.
Return Values
Returns link.
Filters
‘get_favorites_rss_link’:
apply_
Filters
(‘get_favorites_rss_link’, $link, $user->ID, $context )
Source File
get_favorites_rss_link() is located in bb-includes/functions.bb-template.php()
favorites_pages( )
Description
Displays number of your favorite pages.
Usage
<?php favorites_pages( $args = null ); ?>
Parameters
$args
(array)Default values.
Return Values
This function does not return any value.
Filters
‘favorites_pages’:
apply_
Filters
(‘favorites_pages’, get_page_number_links( $page, $favorites_total ), $user->user_id )
Source File
favorites_pages() is located in bb-includes/functions.bb-template.php()
view_name()
Description
Displays the title of the last view.
Usage
<?php view_name( $view = '' ); ?>
Parameters
$view
(string)
Return Values
This function does not return any value.
Filters
No filter.
Source File
view_name() is located in bb-includes/functions.bb-template.php()
get_view_name()
Description
Retrieves the title of the last view.
Usage
<?php get_view_name( $view = '' ); ?>
Parameters
$view
(string)
Return Values
Returns title.
Filters
No filter.
Source File
get_view_name() is located in bb-includes/functions.bb-template.php()
view_pages()
Description
Displays pages of the last view.
Usage
<?php view_pages(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
‘view_pages’:
apply_
Filters
( ‘view_pages’, get_page_number_links( $page, $view_count ) )
Source File
view_pages() is located in bb-includes/functions.bb-template.php()
view_link( )
Description
Displays link to the last view.
Usage
<?php view_link( $_view = false, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$_view
(boolean)
$page
(integer)Initialised to 0.
$context
(string)URI link.
Return Values
This function does not return any value.
Filters
No filter.
Source File
view_link() is located in bb-includes/functions.bb-template.php()
get_view_link()
Description
Retrieves link to last view.
Usage
<?php get_view_link( $_view = false, $page = 1, $context = BB_URI_CONTEXT_A_HREF ); ?>
Parameters
$_view
(boolean)
$page
(integer)Initialised to 0.
$context
(string)URI link.
Return Values
Returns link.
Filters
‘get_view_link’:
apply_
Filters
( ‘get_view_link’, $link, $v, $page, $context )
Source File
get_view_link() is located in bb-includes/functions.bb-template.php()
_bb_parse_time_function_args( )
Description
***************************************
Usage
<?php _bb_parse_time_function_args( $args ); ?>
Parameters
$_view
(boolean)
$page
(integer)Initialised to 0.
$context
(string)URI link.
Return Values
Returns link.
Filters
No filter.
Source File
_bb_parse_time_function_args() is located in bb-includes/functions.bb-template.php()
_bb_time_function_return( )
Description
Gives time in specified format.
Usage
<?php _bb_time_function_return( $time, $args ); ?>
Parameters
$time
(string)Time value.
$args
(array)Default values.
Return Values
Returns time.
Filters
No filter.
Source File
_bb_time_function_return() is located in bb-includes/functions.bb-template.php()
bb_template_scripts()
Description
Enqueues jquery when you are on the profile-edit.php page.
Usage
<?php bb_template_scripts(); ?>
Parameters
No parameter.
Return Values
This function does not return any value.
Filters
No filter.
Source File
bb_template_scripts()() is located in bb-includes/functions.bb-template.php()
loading...
loading...