標籤： developer

bbp_author_link

bbp_author_link
Codex Home → bbp_author_link
Description
The 『bbp_author_link』 function is used to display the most recently active author』s avatar and username linked to their profile
How to use it

$args (optional) – Accepts an array of arguments to configure display ( post_id, link_title, type, size )
Uses bbp_get_author_link()
Sample code example

Displays the linked avatar and username for the most recently active author in a forum
1 ) ); ?>
Displays the most recently active user from the topic with an ID of 1
bbp_get_forum_last_active_id(), 'size' => 32 ) ); ?>
Displays the most recently active user within the forum and sets their avatar to a size of 32px wide and 32px tall
bbp_get_forum_last_active_id(), 'link_title' => 'Author profile' ) ); ?>
Displays the most recently active user within the forum and sets the title of their linked avatar and username to 「Author profile」
bbp_get_forum_last_active_id(), 'type' => 'avatar' ) ); ?>
Displays only the most recently active user』s avatar without their display name
bbp_get_forum_last_active_id(), 'type' => 'name' ) ); ?>
Displays only the most recently active user』s display name without their avatar
Related
bbp_reply_author_link()
bbp_topic_author_link()

bbp_theme_after_forum_freshness_link

bbp_theme_after_forum_freshness_link
Codex Home → bbp_theme_after_forum_freshness_link
Description
The 『bbp_theme_after_forum_freshness_link』 action is used to display content after the forum freshness link
How to use it
Since this is an action, we can use add_action to hook into it.
Sample code example
add_action( 'bbp_theme_after_forum_freshness_link', 'jc_after_forum_freshness_link' );
function jc_after_forum_freshness_link() {
echo 'Hello world!';
}
Note: Always remember to prefix your functions to avoid conflicts!

bbp_theme_after_forum_sub_forums

bbp_theme_after_forum_sub_forums
Codex Home → bbp_theme_after_forum_sub_forums
Description
The 『bbp_theme_after_forum_sub_forums』 action is used to display content after each list of sub forum links.
Where it can be found
On line 26 of
/bbp-theme-compat/bbpress/loop-single-forum.php
/bbp-themes/bbp-twentyten/bbpress/loop-single-forum.php
1
How to use it
Since this is an action, we can use add_action to hook into it.
Sample code example
1234add_action( 'bbp_theme_after_forum_sub_forums', 'jc_after_sub_forum_list' );function jc_after_sub_forum_list() {     echo 'Hello world!';}
Note: Always remember to prefix your functions to avoid conflicts!

bbp_theme_before_forum_description

bbp_theme_before_forum_description
Codex Home → bbp_theme_before_forum_description
Description
The 『bbp_theme_before_forum_description』 action is used to display content before the description of the forum on forum index pages.
Where it can be found
On line 28 of
/bbp-theme-compat/bbpress/loop-single-forum.php
/bbp-themes/bbp-twentyten/bbpress/loop-single-forum.php
1
How to use it
Since this is an action, we can use add_action to hook into it.
Sample code example
1234add_action( 'bbp_theme_before_forum_description', 'jc_before_forum_description' );function jc_before_forum_description() {     echo 'Hello world!';}
Note: Always remember to prefix your functions to avoid conflicts!

bbp_theme_after_forum_description

bbp_theme_after_forum_description
Codex Home → bbp_theme_after_forum_description
Description
The 『bbp_theme_after_forum_description』 action is used to display content after the description of the forum on forum index pages.
Where it can be found
On line 32 of
/bbp-theme-compat/bbpress/loop-single-forum.php
/bbp-themes/bbp-twentyten/bbpress/loop-single-forum.php

How to use it
Since this is an action, we can use add_action to hook into it.
Sample code example
add_action( 'bbp_theme_after_forum_description', 'jc_after_forum_description' );
function jc_after_forum_description() {
echo 'Hello world!';
}
Note: Always remember to prefix your functions to avoid conflicts!

bbp_forum_row_actions

bbp_forum_row_actions
Codex Home → bbp_forum_row_actions
Description
The 『bbp_forum_row_actions』 action is used to display content within forum topic rows for functions such as administrative shortcuts.
Where it can be found
Line 453 and 454
/includes/forums/template.php
function bbp_forum_row_actions() {
do_action( 'bbp_forum_row_actions' );
}
Line 48
/templates/default/bbpress/loop-single-forum.php

How to use it
Since this is an action, we can use add_action to hook into it.
Sample code example
add_action( 'bbp_forum_row_actions', 'jc_forum_row_actions' );
function jc_forum_row_actions($action) {
$action = edit_post_link( 'Edit forum' );
return $action;
}
This will display a link to edit each forum, if a user is logged in and able to make edits.
Note: Always remember to prefix your functions to avoid conflicts!

bbp_forum_topic_count

bbp_forum_topic_count
Codex Home → bbp_forum_topic_count
Description
The 『bbp_forum_topic_count』 function is used to display the total topic count of a forum including sub forums.
How to use it

$forum_id (optional) – Returns count for particular forum id
$total_count (optional) – Returns the total topic count with true including sub forums or just topics within that forum with false
Uses bbp_get_forum_topic_count()
Sample code example

Displays the total count of all topics within the current forum and sub forums

Displays the total count of all topics within the forum with an ID of 1

Displays the count of topics within the current forum not including topics in sub forums

bbp_get_forum_topic_count

bbp_get_forum_topic_count
Codex Home → bbp_get_forum_topic_count
Description
The 『bbp_get_forum_topic_count』 function is used to return the total topic count of a forum including sub forums.
How to use it
1
$forum_id (optional) – Returns count for particular forum id
$total_count (optional) – Returns the total topic count with true including sub forums or just topics within that forum with false
Used by bbp_forum_topic_count() for displaying counts
Sample code example
1
Returns the total count of all topics within the current forum and sub forums
1
Returns the total count of all topics within the forum with an ID of 1
1
Returns the count of topics within the current forum not including topics in sub forums

bbp_show_lead_topic

bbp_show_lead_topic
Codex Home → bbp_show_lead_topic
Description
The 『bbp_show_lead_topic』 function is an alternate layout style where topics appear as 「lead」 posts, ahead of replies whereas by default topics are included in the reply loop.
How to use it
When set to $show_lead = true the 『Lead Topic』 uses the single topic part content-single-topic-lead.php allowing you to style the lead topic separately from the main reply loop. It』s also useful if you want to add some ads or a simple note to your readers after the lead topic before the replies.
Sample code example
function custom_bbp_show_lead_topic( $show_lead ) {
$show_lead[] = 'true';
return $show_lead;
}

add_filter('bbp_show_lead_topic', 'custom_bbp_show_lead_topic' );

bbp_forum_reply_count

bbp_forum_reply_count
Codex Home → bbp_forum_reply_count
Description
The 『bbp_forum_reply_count』 function is used to display the total count of all replies to topics within a forum and sub forums
How to use it
1
$forum_id (optional) – Returns count for particular forum id
$total_count (optional) – Returns total count for all replies in forum and sub forums by default and returns total count for all replies in forum but not sub forums if true, must set $forum_id to work if true
Uses bbp_get_forum_reply_count()
Sample code example
1
Displays the total count of all replies within a forum and sub forums
1
Displays the count of all replies within a forum and not sub forums with a forum ID of 1