Contents
bbpress()
The main function responsible for returning the one true bbPress Instance to functions everywhere.
Description
Use this function like you would a global variable, except without needing to declare the global.
Example: <?php $bbp = bbpress(); ?>
Return
(The) one true bbPress Instance
Source
File: bp-forums/classes/class-bbpress.php
function bbpress() {
return bbpress::instance();
}
Related
Uses
| Uses | Description |
|---|---|
| bp-forums/classes/class-bbpress.php: bbPress::instance() |
Main bbPress Instance |
| Used By | Description |
|---|---|
| bp-forums/classes/class-bp-rest-bbp-walker-reply.php: Rest_BBP_Walker_Reply::start_lvl() | |
| bp-forums/classes/class-bp-rest-bbp-walker-reply.php: Rest_BBP_Walker_Reply::end_lvl() | |
| bp-forums/admin/replies.php: bbp_admin_replies() |
Setup Forums Replies Admin |
| bp-forums/admin/topics.php: bbp_admin_topics() |
Setup Forums Topics Admin |
| bp-forums/admin/settings.php: bbp_maybe_admin_setting_disabled() |
Disable a settings field if the value is forcibly set in Forums’ global options array. |
| bp-forums/admin/settings.php: bbp_converter_setting_callback_platform() |
Edit Platform setting field |
| bp-forums/admin/settings.php: bbp_admin_setting_callback_subtheme_id() |
Use the WordPress editor setting field |
| bp-forums/admin/converters/Invision.php: Invision::callback_html() |
This callback processes any custom BBCodes with parser.php |
| bp-forums/admin/converters/Mingle.php: Mingle::callback_html() |
This callback processes any custom BBCodes with parser.php |
| bp-forums/admin/converters/phpBB.php: phpBB::callback_html() |
This callback processes any custom parser.php attributes and custom code with preg_replace |
| bp-forums/admin/converters/vBulletin3.php: vBulletin3::callback_html() |
This callback processes any custom parser.php attributes and custom code with preg_replace |
| bp-forums/admin/converters/SMF.php: SMF::callback_html() |
This callback processes any custom parser.php attributes and custom code with preg_replace |
| bp-forums/admin/converters/vBulletin.php: vBulletin::callback_html() |
This callback processes any custom parser.php attributes and custom code with preg_replace |
| bp-forums/admin/converters/SimplePress5.php: SimplePress5::callback_html() |
This callback processes any custom parser.php attributes and custom HTML code with preg_replace |
| bp-forums/admin/converters/bbPress1.php: bbPress1::callback_html() |
This callback: |
| bp-forums/admin/converters/Vanilla.php: Vanilla::callback_html() |
This callback processes any custom BBCodes with parser.php |
| bp-forums/admin/converter.php: BBP_Converter_Base::callback_html() | |
| bp-forums/admin/actions.php: bbp_new_site() |
When a new site is created in a multisite installation, run the activation routine on that site |
| bp-forums/admin/converter.php: bbp_new_converter() |
This is a function that is purposely written to look like a “new” statement. |
| bp-forums/admin/admin.php: BBP_Admin::network_update_screen() |
Update all forums across all sites |
| bp-forums/admin/forums.php: bbp_admin_forums() |
Setup forums Admin |
| bp-forums/admin/admin.php: BBP_Admin::map_settings_meta_caps() |
Maps settings capabilities |
| bp-forums/admin/admin.php: BBP_Admin::modify_plugin_action_links() |
Add Settings link to plugins area |
| bp-forums/admin/admin.php: BBP_Admin::hide_theme_compat_packages() |
Hide theme compat package selection if only 1 package is registered |
| bp-forums/admin/admin.php: BBP_Admin::setup_globals() |
Admin globals |
| bp-forums/admin/admin.php: BBP_Admin::admin_menus() |
Add the admin menus |
| bp-forums/admin/admin.php: BBP_Admin::network_admin_menus() |
Add the network admin menus |
| bp-forums/admin/admin.php: bbp_admin() |
Setup Forums Admin |
| bp-forums/admin/functions.php: bbp_admin_separator() |
Add a separator to the WordPress admin menus |
| bp-forums/admin/functions.php: bbp_admin_custom_menu_order() |
Tell WordPress we have a custom menu order |
| bp-forums/admin/functions.php: bbp_admin_menu_order() |
Move our custom separator above our custom post types |
| bp-forums/core/filters.php: _bbp_filter_locale() |
Deprecated locale filter |
| bp-forums/core/update.php: bbp_is_activation() |
Determine if Forums is being activated |
| bp-forums/core/update.php: bbp_is_deactivation() |
Determine if Forums is being deactivated |
| bp-forums/core/extend.php: bbp_setup_akismet() |
Loads Akismet inside the Forums global class |
| bp-forums/core/theme-compat.php: bbp_register_theme_package() |
Register a new Forums theme package to the active theme packages array |
| bp-forums/core/theme-compat.php: bbp_template_include_theme_compat() |
Reset main query vars and filter ‘the_content’ to output a Forums template part as needed. |
| bp-forums/core/theme-compat.php: bbp_remove_all_filters() |
Removes all filters from a WordPress filter, and stashes them in the $bbp global in the event they need to be restored later. |
| bp-forums/core/theme-compat.php: bbp_restore_all_filters() |
Restores filters from the $bbp global that were removed using bbp_remove_all_filters() |
| bp-forums/core/theme-compat.php: bbp_set_theme_compat_original_template() |
Set the theme compat original_template global |
| bp-forums/core/theme-compat.php: bbp_is_theme_compat_original_template() |
Set the theme compat original_template global |
| bp-forums/core/template-functions.php: bbp_parse_query() |
Add checks for Forums conditions to parse_query action |
| bp-forums/core/theme-compat.php: bbp_setup_theme_compat() |
Setup the default theme compat theme |
| bp-forums/core/theme-compat.php: bbp_get_theme_compat_id() |
Gets the name of the Forums compatable theme used, in the event the currently active WordPress theme does not explicitly support Forums. |
| bp-forums/core/theme-compat.php: bbp_get_theme_compat_name() |
Gets the name of the Forums compatable theme used, in the event the currently active WordPress theme does not explicitly support Forums. |
| bp-forums/core/theme-compat.php: bbp_get_theme_compat_version() |
Gets the version of the Forums compatable theme used, in the event the currently active WordPress theme does not explicitly support Forums. |
| bp-forums/core/theme-compat.php: bbp_get_theme_compat_dir() |
Gets the Forums compatable theme used in the event the currently active WordPress theme does not explicitly support Forums. This can be filtered, or set manually. Tricky theme authors can override the default and include their own Forums compatibility layers for their themes. |
| bp-forums/core/theme-compat.php: bbp_get_theme_compat_url() |
Gets the Forums compatable theme used in the event the currently active WordPress theme does not explicitly support Forums. This can be filtered, or set manually. Tricky theme authors can override the default and include their own Forums compatibility layers for their themes. |
| bp-forums/core/theme-compat.php: bbp_is_theme_compat_active() |
Gets true/false if page is currently inside theme compatibility |
| bp-forums/core/theme-compat.php: bbp_set_theme_compat_active() |
Sets true/false if page is currently inside theme compatibility |
| bp-forums/core/theme-compat.php: bbp_set_theme_compat_templates() |
Set the theme compat templates global |
| bp-forums/core/theme-compat.php: bbp_set_theme_compat_template() |
Set the theme compat template global |
| bp-forums/core/template-loader.php: bbp_set_template_included() |
Set the included template |
| bp-forums/core/template-loader.php: bbp_is_template_included() |
Is a Forums template being included? |
| bp-forums/core/functions.php: bbp_get_user_topics_rewrite_id() |
Return the unique ID for user topics rewrite rules |
| bp-forums/core/functions.php: bbp_get_user_replies_rewrite_id() |
Return the unique ID for user replies rewrite rules |
| bp-forums/core/functions.php: bbp_get_user_favorites_rewrite_id() |
Return the unique ID for user caps rewrite rules |
| bp-forums/core/functions.php: bbp_get_user_subscriptions_rewrite_id() |
Return the unique ID for user caps rewrite rules |
| bp-forums/core/functions.php: bbp_get_view_rewrite_id() |
Return the unique ID for topic view rewrite rules |
| bp-forums/core/functions.php: bbp_get_paged_rewrite_id() |
Get the id used for paginated requests |
| bp-forums/core/functions.php: bbp_get_pending_status_id() |
Return the pending post status ID |
| bp-forums/core/functions.php: bbp_get_private_status_id() |
Return the private post status ID |
| bp-forums/core/functions.php: bbp_get_hidden_status_id() |
Return the hidden post status ID |
| bp-forums/core/functions.php: bbp_get_closed_status_id() |
Return the closed post status ID |
| bp-forums/core/functions.php: bbp_get_spam_status_id() |
Return the spam post status ID |
| bp-forums/core/functions.php: bbp_get_trash_status_id() |
Return the trash post status ID |
| bp-forums/core/functions.php: bbp_get_orphan_status_id() |
Return the orphan post status ID |
| bp-forums/core/functions.php: bbp_get_user_rewrite_id() |
Return the unique ID for user profile rewrite rules |
| bp-forums/core/functions.php: bbp_get_edit_rewrite_id() |
Return the unique ID for all edit rewrite rules (forum|topic|reply|tag|user) |
| bp-forums/core/functions.php: bbp_get_search_rewrite_id() |
Return the unique ID for all search rewrite rules |
| bp-forums/core/functions.php: bbp_get_public_status_id() |
Return the public post status ID |
| bp-forums/core/functions.php: bbp_register_view() |
Register a Forums view |
| bp-forums/core/functions.php: bbp_deregister_view() |
Deregister a Forums view |
| bp-forums/core/functions.php: bbp_get_view_query_args() |
Return the view’s query arguments |
| bp-forums/core/functions.php: bbp_add_error() |
Adds an error message to later be output in the theme |
| bp-forums/core/functions.php: bbp_has_errors() |
Check if error messages exist in queue |
| bp-forums/core/functions.php: bbp_get_version() |
Return the Forums version |
| bp-forums/core/functions.php: bbp_get_db_version() |
Return the Forums database version |
| bp-forums/core/functions.php: bbp_get_views() |
Get the registered views |
| bp-forums/core/options.php: bbp_pre_get_option() |
Filter default options and allow them to be overloaded from inside the $bbp->options array. |
| bp-forums/templates/default/bbpress-functions.php: BBP_Default::__construct() |
The main Forums (Default) Loader |
| bp-forums/core/options.php: bbp_get_default_options() |
Get the default site options and their values. |
| bp-forums/topics/template.php: bbp_get_topic_tag_edit_link() |
Return the link of the current tag |
| bp-forums/topics/template.php: bbp_get_topic_tag_tax_id() |
Return the unique id of the topic tag taxonomy |
| bp-forums/topics/template.php: bbp_get_forum_pagination_count() |
Return the pagination count |
| bp-forums/topics/template.php: bbp_get_forum_pagination_links() |
Return pagination links |
| bp-forums/topics/template.php: bbp_get_topic_edit_url() |
Return URL to the topic edit page |
| bp-forums/topics/template.php: bbp_get_topic_class() |
Return the row class of a topic |
| bp-forums/topics/template.php: bbp_get_topic_id() |
Return the topic id |
| bp-forums/topics/template.php: bbp_get_topic_post_type() |
Return the unique id of the custom post type for topics |
| bp-forums/topics/template.php: bbp_has_topics() |
The main topic loop. WordPress makes this easy for us |
| bp-forums/topics/template.php: bbp_topics() |
Whether there are more topics available in the loop |
| bp-forums/topics/template.php: bbp_the_topic() |
Loads up the current topic in the loop |
| bp-forums/members.php: BBP_BuddyPress_Members::user_profile_url() |
Override Forums profile URL with BuddyBoss profile URL |
| bp-forums/members.php: BBP_BuddyPress_Members::get_favorites_permalink() |
Override Forums favorites URL with BuddyBoss profile URL |
| bp-forums/members.php: BBP_BuddyPress_Members::get_subscriptions_permalink() |
Override Forums subscriptions URL with BuddyBoss profile URL |
| bp-forums/users/capabilities.php: bbp_set_current_user_default_role() |
Add the default role to the current user if needed |
| bp-forums/users/template.php: bbp_edit_user_display_name() |
Drop down for selecting the user’s display name |
| bp-forums/users/template.php: bbp_edit_user_contact_methods() |
Return user contact methods Selectbox |
| bp-forums/users/template.php: bbp_get_user_profile_edit_url() |
Return URL to the profile edit page of a user |
| bp-forums/users/template.php: bbp_get_displayed_user_field() |
Return a sanitized user field value |
| bp-forums/users/functions.php: bbp_user_maybe_convert_pass() |
Convert passwords from previous platfrom encryption to WordPress encryption. |
| bp-forums/users/template.php: bbp_get_user_id() |
Return a validated user id |
| bp-forums/users/options.php: bbp_filter_get_user_option() |
Filter default options and allow them to be overloaded from inside the $bbp->user_options array. |
| bp-forums/groups.php: BBP_Forums_Group_Extension::map_reply_edit_url_to_group() |
Map a reply edit link to its group forum |
| bp-forums/groups.php: BBP_Forums_Group_Extension::display_forums() |
Output the forums for a group in the edit screens |
| bp-forums/forums/template.php: bbp_get_form_forum_visibility() |
Return value of forum visibility |
| bp-forums/forums/template.php: bbp_get_forum_class() |
Return the row class of a forum |
| bp-forums/forums/template.php: bbp_get_forum_index_pagination_count() |
Return the forum index pagination count |
| bp-forums/forums/template.php: bbp_get_forum_index_pagination_links() |
Return forum pagination links |
| bp-forums/forums/template.php: bbp_the_forum() |
Loads up the current forum in the loop |
| bp-forums/forums/template.php: bbp_get_forum_id() |
Return the forum id |
| bp-forums/forums/template.php: bbp_get_forum_post_type() |
Return the unique id of the custom post type for forums |
| bp-forums/forums/template.php: bbp_has_forums() |
The main forum loop. |
| bp-forums/forums/template.php: bbp_forums() |
Whether there are more forums available in the loop |
| bp-forums/classes/class-bp-forums-component.php: BP_Forums_Component::setup_components() |
Instantiate classes for BuddyBoss integration |
| bp-forums/common/classes.php: BBP_Walker_Reply::start_lvl() | |
| bp-forums/common/classes.php: BBP_Walker_Reply::end_lvl() | |
| bp-forums/common/classes.php: BBP_Walker_Reply::start_el() | |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topics_of_tag() |
Display the contents of a specific topic tag in an output buffer and return to ensure that post/page contents are displayed first. |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_view() |
Display the contents of a specific view in an output buffer and return to ensure that post/page contents are displayed first. |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topics_of_tag_query() |
Filter the query for topic tags |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::unset_globals() |
Unset some globals in the $bbp object that hold query related info |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_forum() |
Display the contents of a specific forum ID in an output buffer and return to ensure that post/page contents are displayed first. |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topic() |
Display the contents of a specific topic ID in an output buffer and return to ensure that post/page contents are displayed first. |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_topic_form() |
Display the topic form in an output buffer and return to ensure post/page contents are displayed first. |
| bp-forums/common/shortcodes.php: BBP_Shortcodes::display_reply() |
Display the contents of a specific reply ID in an output buffer and return to ensure that post/page contents are displayed first. |
| bp-forums/common/template.php: bbp_template_notices() |
Display possible errors & messages inside a template file |
| bp-forums/common/template.php: bbp_get_view_id() |
Get the view id |
| bp-forums/common/template.php: bbp_get_view_title() |
Get the view name aka title |
| bp-forums/common/template.php: bbp_get_tab_index() |
Output the current tab index of a given form |
| bp-forums/common/template.php: bbp_get_dropdown() |
Output a select box allowing to pick which forum/topic a new topic/reply belongs in. |
| bp-forums/common/template.php: bbp_is_topic_tag() |
Check if the current page is a topic tag |
| bp-forums/bp-forums-loader.php: bp_setup_forums() |
Set up the bp-forums component. |
| bp-forums/functions.php: bbp_group_is_admin() |
Is the current user an admin of the current group |
| bp-forums/functions.php: bbp_group_is_mod() |
Is the current user a moderator of the current group |
| bp-forums/functions.php: bbp_group_is_member() |
Is the current user a member of the current group |
| bp-forums/functions.php: bbp_group_is_banned() |
Is the current user banned from the current group |
| bp-forums/functions.php: bbp_group_is_creator() |
Is the current user the creator of the current group |
| bp-forums/functions.php: bbp_get_component_name() |
Return Forums’ component name/ID (‘forums’ by default) |
| bp-forums/replies/template.php: bbp_get_topic_pagination_count() |
Return the topic pagination count |
| bp-forums/replies/template.php: bbp_get_topic_pagination_links() |
Return topic pagination links |
| bp-forums/replies/template.php: bbp_get_reply_class() |
Return the row class of a reply |
| bp-forums/replies/template.php: bbp_get_reply_edit_url() |
Return URL to the reply edit page |
| bp-forums/replies/template.php: bbp_get_reply_post_type() |
Return the unique id of the custom post type for replies |
| bp-forums/replies/template.php: bbp_has_replies() |
The main reply loop. WordPress makes this easy for us |
| bp-forums/replies/template.php: bbp_replies() |
Whether there are more replies available in the loop |
| bp-forums/replies/template.php: bbp_the_reply() |
Loads up the current reply in the loop |
| bp-forums/replies/template.php: bbp_get_reply_id() |
Return the id of the reply in a replies loop |
| bp-forums/replies/functions.php: bbp_list_replies() |
List replies |
| bp-forums/search/template.php: bbp_get_search_pagination_count() |
Return the search results pagination count |
| bp-forums/search/template.php: bbp_get_search_pagination_links() |
Return search pagination links |
| bp-forums/search/template.php: bbp_has_search_results() |
The main search loop. WordPress does the heavy lifting. |
| bp-forums/search/template.php: bbp_search_results() |
Whether there are more search results available in the loop |
| bp-forums/search/template.php: bbp_the_search_result() |
Loads up the current search result in the loop |
| bp-search/classes/class-bp-search-bbpress-forums-topics.php: Bp_Search_bbPress_Topics::sql() | |
| bp-core/admin/bp-core-admin-schema.php: bp_core_install_discussion_forums() |
Run the bbpress activation. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.