[ Index ]

PHP Cross Reference of BBPress

title

Body

[close]

/src/includes/core/ -> options.php (summary)

bbPress Options

File Size: 990 lines (29 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 52 functions

  bbp_get_default_options()
  bbp_add_options()
  bbp_delete_options()
  bbp_setup_option_filters()
  bbp_filter_pre_get_option()
  bbp_filter_default_option()
  bbp_pre_load_options()
  bbp_is_favorites_active()
  bbp_is_subscriptions_active()
  bbp_is_engagements_active()
  bbp_allow_content_edit()
  bbp_allow_content_throttle()
  bbp_allow_topic_tags()
  bbp_allow_forum_mods()
  bbp_allow_super_mods()
  bbp_allow_search()
  bbp_allow_threaded_replies()
  bbp_thread_replies_depth()
  bbp_allow_revisions()
  bbp_allow_anonymous()
  bbp_allow_global_access()
  bbp_get_default_role()
  bbp_use_wp_editor()
  bbp_use_autoembed()
  bbp_get_theme_package_id()
  bbp_title_max_length()
  bbp_get_title_max_length()
  bbp_edit_lock()
  bbp_get_edit_lock()
  bbp_group_forums_root_id()
  bbp_get_group_forums_root_id()
  bbp_is_group_forums_active()
  bbp_is_akismet_active()
  bbp_settings_integration()
  bbp_engagements_strategy()
  bbp_get_root_slug()
  bbp_include_root_slug()
  bbp_show_on_root()
  bbp_maybe_get_root_slug()
  bbp_get_forum_slug()
  bbp_get_topic_archive_slug()
  bbp_get_reply_archive_slug()
  bbp_get_topic_slug()
  bbp_get_topic_tag_tax_slug()
  bbp_get_reply_slug()
  bbp_get_user_slug()
  bbp_get_user_favorites_slug()
  bbp_get_user_subscriptions_slug()
  bbp_get_user_engagements_slug()
  bbp_get_view_slug()
  bbp_get_search_slug()
  bbp_get_config_location()

Functions
Functions that are not part of a class:

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.

return: mixed false if not overloaded, mixed if set
param: bool   $value  Default value false
param: string $option Name of the option
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.

return: mixed false if not overloaded, mixed if set
param: bool $value Optional. Default value false
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.

return: bool Is favorites enabled or not
param: bool $default Optional.Default value true
since: 2.0.0 bbPress (r2658)

bbp_is_subscriptions_active( $default = 1 )   X-Ref
Checks if subscription feature is enabled.

return: bool Is subscription enabled or not
param: bool $default Optional.Default value true
since: 2.0.0 bbPress (r2658)

bbp_is_engagements_active( $default = 1 )   X-Ref
Checks if engagements feature is enabled.

return: bool Is engagements enabled or not
param: bool $default Optional.Default value true
since: 2.6.0 bbPress (r6320)

bbp_allow_content_edit( $default = 1 )   X-Ref
Is content editing available when posting new topics & replies?

return: bool Is content editing allowed?
param: bool $default Optional. Default value false
since: 2.6.0 bbPress (r6441)

bbp_allow_content_throttle( $default = 1 )   X-Ref
Is content throttling engaged when posting new topics & replies?

return: bool Is content throttling allowed?
param: bool $default Optional. Default value false
since: 2.6.0 bbPress (r6441)

bbp_allow_topic_tags( $default = 1 )   X-Ref
Are topic tags allowed

return: bool Are tags allowed?
param: bool $default Optional. Default value true
since: 2.2.0 bbPress (r4097)

bbp_allow_forum_mods( $default = 1 )   X-Ref
Are per-forum moderators allowed

return: bool Are per-forum moderators allowed?
param: bool $default Optional. Default value true.
since: 2.6.0 bbPress (r5834)

bbp_allow_super_mods( $default = 0 )   X-Ref
Are moderators allowed to edit users

return: bool Are moderators allowed to edit users?
param: bool $default Optional. Default value true.
since: 2.6.0 bbPress (r6562)

bbp_allow_search( $default = 1 )   X-Ref
Is forum-wide searching allowed

return: bool Is forum-wide searching allowed?
param: bool $default Optional. Default value true
since: 2.4.0 bbPress (r4970)

bbp_allow_threaded_replies( $default = 0 )   X-Ref
Are threaded replies allowed

return: bool Are threaded replies allowed?
param: bool $default Optional. Default value false
since: 2.4.0 bbPress (r4964)

bbp_thread_replies_depth( $default = 2 )   X-Ref
Maximum reply thread depth

return: int Thread replies depth
param: int $default Thread replies depth
since: 2.4.0 bbPress (r4944)

bbp_allow_revisions( $default = 1 )   X-Ref
Are topic and reply revisions allowed

return: bool Are revisions allowed?
param: bool $default Optional. Default value true
since: 2.0.0 bbPress (r3412)

bbp_allow_anonymous( $default = 0 )   X-Ref
Is the anonymous posting allowed?

return: bool Is anonymous posting allowed?
param: bool $default Optional. Default value
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?

return: bool Is global access allowed?
param: bool $default Optional. Default value false
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

return: string The default forums user role
param: string $default Optional. Default value empty
since: 2.2.0 bbPress (r4294)

bbp_use_wp_editor( $default = 1 )   X-Ref
Use the WordPress editor if available

return: bool Use WP editor?
param: bool $default Optional. Default value true
since: 2.0.0 bbPress (r3386)

bbp_use_autoembed( $default = 1 )   X-Ref
Use WordPress's oEmbed API

return: bool Use oEmbed?
param: bool $default Optional. Default value true
since: 2.1.0 bbPress (r3752)

bbp_get_theme_package_id( $default = 'default' )   X-Ref
Get the current theme package ID

return: string ID of the theme-package
param: string $default Optional. Default value 'default'
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

return: int Is anonymous posting allowed?
param: bool $default Optional. Default value 80
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()`.

return: int Is anonymous posting allowed?
param: bool $default Optional. Default value 5
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

return: int The post ID for the root forum
param: bool $default Optional. Default value 0
since: 2.1.0 bbPress (r3575)

bbp_is_group_forums_active( $default = 1 )   X-Ref
Checks if BuddyPress Group Forums are enabled

return: bool Is group forums enabled or not
param: bool $default Optional. Default value true
since: 2.1.0 bbPress (r3575)

bbp_is_akismet_active( $default = 1 )   X-Ref
Checks if Akismet is enabled

return: bool Is Akismet enabled or not
param: bool $default Optional. Default value true
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

return: string How to integrate settings
param: bool $default Optional. Default value false
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.

return: string How to interact with engagements
param: bool $default Optional. Default value false
since: 2.6.0 bbPress (r6875)

bbp_get_root_slug( $default = 'forums' )   X-Ref
Return the root slug

return: string
param: string $default Optional. Default value 'forums'
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?

return: bool
param: bool $default Optional. Default value true
since: 2.1.0 bbPress (r3759)

bbp_show_on_root( $default = 'forums' )   X-Ref
What to show on root, forums or topics?

return: string
param: string $default Optional. Default value 'forums'
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

return: string
param: string $default Optional. Default value 'forums'
since: 2.1.0 bbPress (r3759)

bbp_get_forum_slug( $default = 'forum' )   X-Ref
Return the single forum slug

return: string
param: string $default Optional. Default value 'forum'
since: 2.1.0 bbPress (r3759)

bbp_get_topic_archive_slug( $default = 'topics' )   X-Ref
Return the topic archive slug

return: string
param: string $default Optional. Default value 'topics'
since: 2.1.0 bbPress (r3759)

bbp_get_reply_archive_slug( $default = 'replies' )   X-Ref
Return the reply archive slug

return: string
param: string $default Optional. Default value 'replies'
since: 2.4.0 bbPress (r4925)

bbp_get_topic_slug( $default = 'topic' )   X-Ref
Return the single topic slug

return: string
param: string $default Optional. Default value 'topic'
since: 2.1.0 bbPress (r3759)

bbp_get_topic_tag_tax_slug( $default = 'topic-tag' )   X-Ref
Return the topic-tag taxonomy slug

return: string
param: string $default Optional. Default value 'topic-tag'
since: 2.1.0 bbPress (r3759)

bbp_get_reply_slug( $default = 'reply' )   X-Ref
Return the single reply slug (used mostly for editing)

return: string
param: string $default Optional. Default value 'reply'
since: 2.1.0 bbPress (r3759)

bbp_get_user_slug( $default = 'users' )   X-Ref
Return the single user slug

return: string
param: string $default Optional. Default value 'users'
since: 2.1.0 bbPress (r3759)

bbp_get_user_favorites_slug( $default = 'favorites' )   X-Ref
Return the single user favorites slug

return: string
param: string $default Optional. Default value 'favorites'
since: 2.2.0 bbPress (r4187)

bbp_get_user_subscriptions_slug( $default = 'subscriptions' )   X-Ref
Return the single user subscriptions slug

return: string
param: string $default Optional. Default value 'subscriptions'
since: 2.2.0 bbPress (r4187)

bbp_get_user_engagements_slug( $default = 'engagements' )   X-Ref
Return the single user engagements slug

return: string
param: string $default Optional. Default value 'engagements'
since: 2.6.0 bbPress (r6320)

bbp_get_view_slug( $default = 'view' )   X-Ref
Return the topic view slug

return: string
param: string $default Optional. Default value 'view'
since: 2.1.0 bbPress (r3759)

bbp_get_search_slug( $default = 'search' )   X-Ref
Return the search slug

return: string
param: string $default Optional. Default value 'search'
since: 2.3.0 bbPress (r4579)

bbp_get_config_location( $default = '' )   X-Ref
Checks if there is a previous BuddyPress Forum configuration

return: string The location of the bb-config.php file, if any
param: string $default Optional. Default empty string
since: 2.1.0 bbPress (r3790)



Generated: Tue Oct 22 01:01:25 2019 Cross-referenced by PHPXref 0.7.1