bbp_get_default_options

The bbPress bbp get default options hook.

Description

apply_filters( 'bbp_get_default_options', (callback) $array ); 

Parameters (1)

0. $array — Optional. (callback) => array('_bbp_db_version' => bbpress()->db_version,'_bbp_edit_lock' => 5, '_bbp_throttle_time' => 10, '_bbp_enable_favorites' => 1, '_bbp_enable_subscriptions' => 1, '_bbp_allow_anonymous' => 0, '_bbp_allow_global_access' => 1, '_bbp_allow_revisions' => 1, '_bbp_allow_topic_tags' => 1, '_bbp_allow_threaded_replies' => 0, '_bbp_allow_search' => 1, '_bbp_thread_replies_depth' => 2, '_bbp_use_wp_editor' => 1, '_bbp_use_autoembed' => 0, '_bbp_theme_package_id' => 'default', '_bbp_default_role' => bbp_get_participant_role(), '_bbp_settings_integration' => 0,'_bbp_topics_per_page' => 15, '_bbp_replies_per_page' => 15, '_bbp_forums_per_page' => 50, '_bbp_topics_per_rss_page' => 25, '_bbp_replies_per_rss_page' => 25,'_bbp_page_for_forums' => 0, '_bbp_page_for_topics' => 0, '_bbp_page_for_login' => 0, '_bbp_page_for_register' => 0, '_bbp_page_for_lost_pass' => 0,'_bbp_root_slug' => 'forums', '_bbp_show_on_root' => 'forums', '_bbp_include_root' => 1,'_bbp_forum_slug' => 'forum', '_bbp_topic_slug' => 'topic', '_bbp_reply_slug' => 'reply', '_bbp_topic_tag_slug' => 'topic-tag','_bbp_user_slug' => 'users', '_bbp_user_favs_slug' => 'favorites', '_bbp_user_subs_slug' => 'subscriptions', '_bbp_topic_archive_slug' => 'topics', '_bbp_reply_archive_slug' => 'replies','_bbp_view_slug' => 'view', '_bbp_search_slug' => 'search','_bbp_title_max_length' => 80, '_bbp_super_sticky_topics' => '','_bbp_private_forums' => '', '_bbp_hidden_forums' => '','_bbp_enable_group_forums' => 1, '_bbp_group_forums_root_id' => 0,'_bbp_enable_akismet' => 1 )
The array.

Usage

To run the hook, copy the example below.
  1. $array = apply_filters( 'bbp_get_default_options', $array ); 
  2.  
  3. if ( !empty( $array ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bbp_get_default_options callback 
  2. function filter_bbp_get_default_options( $array ) { 
  3. // make filter magic happen here... 
  4. return $array
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bbp_get_default_options', 'filter_bbp_get_default_options', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bbp_get_default_options', 'filter_bbp_get_default_options', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/includes/core/options.php  
  1. return apply_filters( 'bbp_get_default_options', array(