| [ Index ] |
PHP Cross Reference of BBPress |
[Source view] [Print] [Project Stats]
bbPress Options
| File Size: | 1004 lines (29 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| bbp_get_default_options() X-Ref |
| Get the default site options and their values. These option return: array Filtered option names and values since: 2.0.0 bbPress (r3421) |
| bbp_add_options() X-Ref |
| Add default options Hooked to bbp_activate, it is only called once when bbPress is activated. This is non-destructive, so existing settings will not be overridden. since: 2.0.0 bbPress (r3421) |
| bbp_delete_options() X-Ref |
| Delete default options Hooked to bbp_uninstall, it is only called once when bbPress is uninstalled. This is destructive, so existing settings will be destroyed. since: 2.0.0 bbPress (r3421) |
| bbp_setup_option_filters() X-Ref |
| Add filters to each bbPress option and allow them to be overloaded from inside the $bbp->options array. since: 2.0.0 bbPress (r3451) |
| bbp_filter_pre_get_option( $value = false, $option = '' ) X-Ref |
| Filter pre options and maybe overloaded from the $bbp->options array. This function should not be called directly. param: bool $value Default value false param: string $option Name of the option return: mixed false if not overloaded, mixed if set since: 2.0.0 bbPress (r3451) |
| bbp_filter_default_option( $default = false, $option = '', $passed_default = false ) X-Ref |
| Filter default_options set them from inside the $bbp->options array. This function should not be called directly. param: bool $value Optional. Default value false return: mixed false if not overloaded, mixed if set since: 2.6.0 bbPress (r3451) |
| bbp_pre_load_options() X-Ref |
| Loads & caches bbPress options if a persistent cache is not being used. since: 2.6.0 |
| bbp_is_favorites_active( $default = 1 ) X-Ref |
| Checks if favorites feature is enabled. param: bool $default Optional.Default value true return: bool Is favorites enabled or not since: 2.0.0 bbPress (r2658) |
| bbp_is_subscriptions_active( $default = 1 ) X-Ref |
| Checks if subscription feature is enabled. param: bool $default Optional.Default value true return: bool Is subscription enabled or not since: 2.0.0 bbPress (r2658) |
| bbp_is_engagements_active( $default = 1 ) X-Ref |
| Checks if engagements feature is enabled. param: bool $default Optional.Default value true return: bool Is engagements enabled or not since: 2.6.0 bbPress (r6320) |
| bbp_allow_content_edit( $default = 1 ) X-Ref |
| Is content editing available when posting new topics & replies? param: bool $default Optional. Default value false return: bool Is content editing allowed? since: 2.6.0 bbPress (r6441) |
| bbp_allow_content_throttle( $default = 1 ) X-Ref |
| Is content throttling engaged when posting new topics & replies? param: bool $default Optional. Default value false return: bool Is content throttling allowed? since: 2.6.0 bbPress (r6441) |
| bbp_allow_topic_tags( $default = 1 ) X-Ref |
| Are topic tags allowed param: bool $default Optional. Default value true return: bool Are tags allowed? since: 2.2.0 bbPress (r4097) |
| bbp_allow_forum_mods( $default = 1 ) X-Ref |
| Are per-forum moderators allowed param: bool $default Optional. Default value true. return: bool Are per-forum moderators allowed? since: 2.6.0 bbPress (r5834) |
| bbp_allow_super_mods( $default = 0 ) X-Ref |
| Are moderators allowed to edit users param: bool $default Optional. Default value true. return: bool Are moderators allowed to edit users? since: 2.6.0 bbPress (r6562) |
| bbp_allow_search( $default = 1 ) X-Ref |
| Is forum-wide searching allowed param: bool $default Optional. Default value true return: bool Is forum-wide searching allowed? since: 2.4.0 bbPress (r4970) |
| bbp_allow_threaded_replies( $default = 0 ) X-Ref |
| Are threaded replies allowed param: bool $default Optional. Default value false return: bool Are threaded replies allowed? since: 2.4.0 bbPress (r4964) |
| bbp_thread_replies_depth( $default = 2 ) X-Ref |
| Maximum reply thread depth param: int $default Thread replies depth return: int Thread replies depth since: 2.4.0 bbPress (r4944) |
| bbp_allow_revisions( $default = 1 ) X-Ref |
| Are topic and reply revisions allowed param: bool $default Optional. Default value true return: bool Are revisions allowed? since: 2.0.0 bbPress (r3412) |
| bbp_allow_anonymous( $default = 0 ) X-Ref |
| Is the anonymous posting allowed? param: bool $default Optional. Default value return: bool Is anonymous posting allowed? since: 2.0.0 bbPress (r2659) |
| bbp_allow_global_access( $default = 1 ) X-Ref |
| Is this forum available to all users on all sites in this installation? param: bool $default Optional. Default value false return: bool Is global access allowed? since: 2.0.0 bbPress (r3378) |
| bbp_get_default_role( $default = 'bbp_participant' ) X-Ref |
| Get the default forums role (issued to users on their first visit to the forums) by bbp_set_current_user_default_role() and repair tools param: string $default Optional. Default value empty return: string The default forums user role since: 2.2.0 bbPress (r4294) |
| bbp_use_wp_editor( $default = 1 ) X-Ref |
| Use the WordPress editor if available param: bool $default Optional. Default value true return: bool Use WP editor? since: 2.0.0 bbPress (r3386) |
| bbp_use_autoembed( $default = 1 ) X-Ref |
| Use WordPress's oEmbed API param: bool $default Optional. Default value true return: bool Use oEmbed? since: 2.1.0 bbPress (r3752) |
| bbp_get_theme_package_id( $default = 'default' ) X-Ref |
| Get the current theme package ID param: string $default Optional. Default value 'default' return: string ID of the theme-package since: 2.1.0 bbPress (r3829) |
| bbp_title_max_length( $default = 80 ) X-Ref |
| Output the maximum length of a title param: bool $default Optional. Default value 80 since: 2.0.0 bbPress (r3246) |
| bbp_get_title_max_length( $default = 80 ) X-Ref |
| Return the maximum length of a title param: bool $default Optional. Default value 80 return: int Is anonymous posting allowed? since: 2.0.0 bbPress (r3246) |
| bbp_edit_lock( $default = 5 ) X-Ref |
| Output the number of minutes a topic or reply can be edited after it's published. Used by `bbp_past_edit_lock()`. param: bool $default Optional. Default value 5 since: 2.6.0 bbPress (r6868) |
| bbp_get_edit_lock( $default = 5 ) X-Ref |
| Return the number of minutes a topic or reply can be edited after it's published. Used by `bbp_past_edit_lock()`. param: bool $default Optional. Default value 5 return: int Is anonymous posting allowed? since: 2.6.0 bbPress (r6868) |
| bbp_group_forums_root_id( $default = 0 ) X-Ref |
| Output the group forums root parent forum id param: int $default Optional. Default value since: 2.1.0 bbPress (r3575) |
| bbp_get_group_forums_root_id( $default = 0 ) X-Ref |
| Return the group forums root parent forum id param: bool $default Optional. Default value 0 return: int The post ID for the root forum since: 2.1.0 bbPress (r3575) |
| bbp_is_group_forums_active( $default = 1 ) X-Ref |
| Checks if BuddyPress Group Forums are enabled param: bool $default Optional. Default value true return: bool Is group forums enabled or not since: 2.1.0 bbPress (r3575) |
| bbp_is_akismet_active( $default = 1 ) X-Ref |
| Checks if Akismet is enabled param: bool $default Optional. Default value true return: bool Is Akismet enabled or not since: 2.1.0 bbPress (r3575) |
| bbp_settings_integration( $default = 'basic' ) X-Ref |
| Integrate settings into existing WordPress pages There are 3 possible modes: - 'basic' Traditional admin integration - 'compact' One "bbPress" top-level admin menu - 'deep' Deeply integrate with the WordPress admin interface param: bool $default Optional. Default value false return: string How to integrate settings since: 2.4.0 bbPress (r4932) |
| bbp_engagements_strategy( $default = 'meta' ) X-Ref |
| How to interact with engagements There are 3 possible strategies: - 'meta' 2.6 and higher. Uses multiple postmeta keys. - 'user' Pre-2.6. Uses comma-separated string of IDs in usermeta. - 'term' Alternate. Uses taxonomy term relationships. param: bool $default Optional. Default value false return: string How to interact with engagements since: 2.6.0 bbPress (r6875) |
| bbp_get_root_slug( $default = 'forums' ) X-Ref |
| Return the root slug param: string $default Optional. Default value 'forums' return: string since: 2.1.0 bbPress (r3759) |
| bbp_include_root_slug( $default = 1 ) X-Ref |
| Are we including the root slug in front of forum pages? param: bool $default Optional. Default value true return: bool since: 2.1.0 bbPress (r3759) |
| bbp_show_on_root( $default = 'forums' ) X-Ref |
| What to show on root, forums or topics? param: string $default Optional. Default value 'forums' return: string since: 2.4.0 bbPress (r4932) |
| bbp_maybe_get_root_slug() X-Ref |
| Maybe return the root slug, based on whether or not it's included in the url param: string $default Optional. Default value 'forums' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_forum_slug( $default = 'forum' ) X-Ref |
| Return the single forum slug param: string $default Optional. Default value 'forum' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_topic_archive_slug( $default = 'topics' ) X-Ref |
| Return the topic archive slug param: string $default Optional. Default value 'topics' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_reply_archive_slug( $default = 'replies' ) X-Ref |
| Return the reply archive slug param: string $default Optional. Default value 'replies' return: string since: 2.4.0 bbPress (r4925) |
| bbp_get_topic_slug( $default = 'topic' ) X-Ref |
| Return the single topic slug param: string $default Optional. Default value 'topic' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_topic_tag_tax_slug( $default = 'topic-tag' ) X-Ref |
| Return the topic-tag taxonomy slug param: string $default Optional. Default value 'topic-tag' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_reply_slug( $default = 'reply' ) X-Ref |
| Return the single reply slug (used mostly for editing) param: string $default Optional. Default value 'reply' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_user_slug( $default = 'users' ) X-Ref |
| Return the single user slug param: string $default Optional. Default value 'users' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_user_favorites_slug( $default = 'favorites' ) X-Ref |
| Return the single user favorites slug param: string $default Optional. Default value 'favorites' return: string since: 2.2.0 bbPress (r4187) |
| bbp_get_user_subscriptions_slug( $default = 'subscriptions' ) X-Ref |
| Return the single user subscriptions slug param: string $default Optional. Default value 'subscriptions' return: string since: 2.2.0 bbPress (r4187) |
| bbp_get_user_engagements_slug( $default = 'engagements' ) X-Ref |
| Return the single user engagements slug param: string $default Optional. Default value 'engagements' return: string since: 2.6.0 bbPress (r6320) |
| bbp_get_view_slug( $default = 'view' ) X-Ref |
| Return the topic view slug param: string $default Optional. Default value 'view' return: string since: 2.1.0 bbPress (r3759) |
| bbp_get_search_slug( $default = 'search' ) X-Ref |
| Return the search slug param: string $default Optional. Default value 'search' return: string since: 2.3.0 bbPress (r4579) |
| bbp_get_edit_slug( $default = 'edit' ) X-Ref |
| Return the edit slug param: string $default Optional. Default value 'edit' return: string since: 2.6.2 bbPress (r6965) |
| bbp_get_config_location( $default = '' ) X-Ref |
| Checks if there is a previous BuddyPress Forum configuration param: string $default Optional. Default empty string return: string The location of the bb-config.php file, if any since: 2.1.0 bbPress (r3790) |
| Generated: Thu Apr 18 01:01:08 2024 | Cross-referenced by PHPXref 0.7.1 |