Skip to:
Content

bbPress.org


Ignore:
Timestamp:
05/27/2017 05:04:31 PM (7 years ago)
Author:
johnjamesjacoby
Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/includes/core/options.php

    r6419 r6438  
    2222function bbp_get_default_options() {
    2323
    24     // Default options
     24    // Filter & return
    2525    return apply_filters( 'bbp_get_default_options', array(
    2626
    … …  
    216216 */
    217217function bbp_is_favorites_active( $default = 1 ) {
     218
     219    // Filter & return
    218220    return (bool) apply_filters( 'bbp_is_favorites_active', (bool) get_option( '_bbp_enable_favorites', $default ) );
    219221}
    … …  
    229231 */
    230232function bbp_is_subscriptions_active( $default = 1 ) {
     233
     234    // Filter & return
    231235    return (bool) apply_filters( 'bbp_is_subscriptions_active', (bool) get_option( '_bbp_enable_subscriptions', $default ) );
    232236}
    … …  
    242246 */
    243247function bbp_is_engagements_active( $default = 1 ) {
     248
     249    // Filter & return
    244250    return (bool) apply_filters( 'bbp_is_engagements_active', (bool) get_option( '_bbp_enable_engagements', $default ) );
    245251}
    … …  
    255261 */
    256262function bbp_allow_topic_tags( $default = 1 ) {
     263
     264    // Filter & return
    257265    return (bool) apply_filters( 'bbp_allow_topic_tags', (bool) get_option( '_bbp_allow_topic_tags', $default ) );
    258266}
    … …  
    269277 */
    270278function bbp_allow_forum_mods( $default = 1 ) {
     279
     280    // Filter & return
    271281    return (bool) apply_filters( 'bbp_allow_forum_mods', (bool) get_option( '_bbp_allow_forum_mods', $default ) );
    272282}
    … …  
    282292 */
    283293function bbp_allow_search( $default = 1 ) {
     294
     295    // Filter & return
    284296    return (bool) apply_filters( 'bbp_allow_search', (bool) get_option( '_bbp_allow_search', $default ) );
    285297}
    … …  
    295307 */
    296308function bbp_allow_threaded_replies( $default = 0 ) {
     309
     310    // Filter & return
    297311    return (bool) apply_filters( '_bbp_allow_threaded_replies', (bool) get_option( '_bbp_allow_threaded_replies', $default ) );
    298312}
    … …  
    310324 */
    311325function bbp_thread_replies_depth( $default = 2 ) {
     326
     327    // Filter & return
    312328    return (int) apply_filters( 'bbp_thread_replies_depth', (int) get_option( '_bbp_thread_replies_depth', $default ) );
    313329}
    … …  
    323339 */
    324340function bbp_allow_revisions( $default = 1 ) {
     341
     342    // Filter & return
    325343    return (bool) apply_filters( 'bbp_allow_revisions', (bool) get_option( '_bbp_allow_revisions', $default ) );
    326344}
    … …  
    336354 */
    337355function bbp_allow_anonymous( $default = 0 ) {
     356
     357    // Filter & return
    338358    return apply_filters( 'bbp_allow_anonymous', (bool) get_option( '_bbp_allow_anonymous', $default ) );
    339359}
    … …  
    349369 */
    350370function bbp_allow_global_access( $default = 1 ) {
     371
     372    // Filter & return
    351373    return (bool) apply_filters( 'bbp_allow_global_access', (bool) get_option( '_bbp_allow_global_access', $default ) );
    352374}
    … …  
    362384 */
    363385function bbp_get_default_role( $default = 'bbp_participant' ) {
     386
     387    // Filter & return
    364388    return apply_filters( 'bbp_get_default_role', get_option( '_bbp_default_role', $default ) );
    365389}
    … …  
    375399 */
    376400function bbp_use_wp_editor( $default = 1 ) {
     401
     402    // Filter & return
    377403    return (bool) apply_filters( 'bbp_use_wp_editor', (bool) get_option( '_bbp_use_wp_editor', $default ) );
    378404}
    … …  
    388414 */
    389415function bbp_use_autoembed( $default = 1 ) {
     416
     417    // Filter & return
    390418    return (bool) apply_filters( 'bbp_use_autoembed', (bool) get_option( '_bbp_use_autoembed', $default ) );
    391419}
    … …  
    401429 */
    402430function bbp_get_theme_package_id( $default = 'default' ) {
     431
     432    // Filter & return
    403433    return apply_filters( 'bbp_get_theme_package_id', get_option( '_bbp_theme_package_id', $default ) );
    404434}
    … …  
    424454     */
    425455    function bbp_get_title_max_length( $default = 80 ) {
     456
     457        // Filter & return
    426458        return (int) apply_filters( 'bbp_get_title_max_length', (int) get_option( '_bbp_title_max_length', $default ) );
    427459    }
    … …  
    447479     */
    448480    function bbp_get_group_forums_root_id( $default = 0 ) {
     481
     482        // Filter & return
    449483        return (int) apply_filters( 'bbp_get_group_forums_root_id', (int) get_option( '_bbp_group_forums_root_id', $default ) );
    450484    }
    … …  
    460494 */
    461495function bbp_is_group_forums_active( $default = 1 ) {
     496
     497    // Filter & return
    462498    return (bool) apply_filters( 'bbp_is_group_forums_active', (bool) get_option( '_bbp_enable_group_forums', $default ) );
    463499}
    … …  
    473509 */
    474510function bbp_is_akismet_active( $default = 1 ) {
     511
     512    // Filter & return
    475513    return (bool) apply_filters( 'bbp_is_akismet_active', (bool) get_option( '_bbp_enable_akismet', $default ) );
    476514}
    … …  
    521559 */
    522560function bbp_get_root_slug( $default = 'forums' ) {
     561
     562    // Filter & return
    523563    return apply_filters( 'bbp_get_root_slug', get_option( '_bbp_root_slug', $default ) );
    524564}
    … …  
    532572 */
    533573function bbp_include_root_slug( $default = 1 ) {
     574
     575    // Filter & return
    534576    return (bool) apply_filters( 'bbp_include_root_slug', (bool) get_option( '_bbp_include_root', $default ) );
    535577}
    … …  
    543585 */
    544586function bbp_show_on_root( $default = 'forums' ) {
     587
     588    // Filter & return
    545589    return apply_filters( 'bbp_show_on_root', get_option( '_bbp_show_on_root', $default ) );
    546590}
    … …  
    560604    }
    561605
     606    // Filter & return
    562607    return apply_filters( 'bbp_maybe_get_root_slug', $retval );
    563608}
    … …  
    571616 */
    572617function bbp_get_forum_slug( $default = 'forum' ) {
     618
     619    // Filter & return
    573620    return apply_filters( 'bbp_get_forum_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_forum_slug', $default ) );
    574621}
    … …  
    582629 */
    583630function bbp_get_topic_archive_slug( $default = 'topics' ) {
     631
     632    // Filter & return
    584633    return apply_filters( 'bbp_get_topic_archive_slug', get_option( '_bbp_topic_archive_slug', $default ) );
    585634}
    … …  
    593642 */
    594643function bbp_get_reply_archive_slug( $default = 'replies' ) {
     644
     645    // Filter & return
    595646    return apply_filters( 'bbp_get_reply_archive_slug', get_option( '_bbp_reply_archive_slug', $default ) );
    596647}
    … …  
    604655 */
    605656function bbp_get_topic_slug( $default = 'topic' ) {
     657
     658    // Filter & return
    606659    return apply_filters( 'bbp_get_topic_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_topic_slug', $default ) );
    607660}
    … …  
    615668 */
    616669function bbp_get_topic_tag_tax_slug( $default = 'topic-tag' ) {
     670
     671    // Filter & return
    617672    return apply_filters( 'bbp_get_topic_tag_tax_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_topic_tag_slug', $default ) );
    618673}
    … …  
    626681 */
    627682function bbp_get_reply_slug( $default = 'reply' ) {
     683
     684    // Filter & return
    628685    return apply_filters( 'bbp_get_reply_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_reply_slug', $default ) );
    629686}
    … …  
    637694 */
    638695function bbp_get_user_slug( $default = 'users' ) {
     696
     697    // Filter & return
    639698    return apply_filters( 'bbp_get_user_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_user_slug', $default ) );
    640699}
    … …  
    648707 */
    649708function bbp_get_user_favorites_slug( $default = 'favorites' ) {
     709
     710    // Filter & return
    650711    return apply_filters( 'bbp_get_user_favorites_slug', get_option( '_bbp_user_favs_slug', $default ) );
    651712}
    … …  
    659720 */
    660721function bbp_get_user_subscriptions_slug( $default = 'subscriptions' ) {
     722
     723    // Filter & return
    661724    return apply_filters( 'bbp_get_user_subscriptions_slug', get_option( '_bbp_user_subs_slug', $default ) );
    662725}
    … …  
    670733 */
    671734function bbp_get_user_engagements_slug( $default = 'engagements' ) {
     735
     736    // Filter & return
    672737    return apply_filters( 'bbp_get_user_engagements_slug', get_option( '_bbp_user_engagements_slug', $default ) );
    673738}
    … …  
    681746 */
    682747function bbp_get_view_slug( $default = 'view' ) {
     748
     749    // Filter & return
    683750    return apply_filters( 'bbp_get_view_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_view_slug', $default ) );
    684751}
    … …  
    692759 */
    693760function bbp_get_search_slug( $default = 'search' ) {
     761
     762    // Filter & return
    694763    return apply_filters( 'bbp_get_search_slug', bbp_maybe_get_root_slug() . get_option( '_bbp_search_slug', $default ) );
    695764}
    … …  
    707776 */
    708777function bbp_get_config_location( $default = '' ) {
     778
     779    // Filter & return
    709780    return apply_filters( 'bbp_get_config_location', get_option( 'bb-config-location', $default ) );
    710781}
Note: See TracChangeset for help on using the changeset viewer.