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/common/template.php

    r6433 r6438  
    112112    $public = get_blog_option( $site_id, 'blog_public', 1 );
    113113
     114    // Filter & return
    114115    return (bool) apply_filters( 'bbp_is_site_public', $public, $site_id );
    115116}
    … …  
    134135    }
    135136
     137    // Filter & return
    136138    return (bool) apply_filters( 'bbp_is_forum', $retval, $post_id );
    137139}
    … …  
    158160    }
    159161
     162    // Filter & return
    160163    return (bool) apply_filters( 'bbp_is_forum_archive', $retval );
    161164}
    … …  
    188191    }
    189192
     193    // Filter & return
    190194    return (bool) apply_filters( 'bbp_is_single_forum', $retval );
    191195}
    … …  
    214218    }
    215219
     220    // Filter & return
    216221    return (bool) apply_filters( 'bbp_is_forum_edit', $retval );
    217222}
    … …  
    237242    }
    238243
     244    // Filter & return
    239245    return (bool) apply_filters( 'bbp_is_topic', $retval, $post_id );
    240246}
    … …  
    267273    }
    268274
     275    // Filter & return
    269276    return (bool) apply_filters( 'bbp_is_single_topic', $retval );
    270277}
    … …  
    290297    }
    291298
     299    // Filter & return
    292300    return (bool) apply_filters( 'bbp_is_topic_archive', $retval );
    293301}
    … …  
    316324    }
    317325
     326    // Filter & return
    318327    return (bool) apply_filters( 'bbp_is_topic_edit', $retval );
    319328}
    … …  
    337346    }
    338347
     348    // Filter & return
    339349    return (bool) apply_filters( 'bbp_is_topic_merge', $retval );
    340350}
    … …  
    358368    }
    359369
     370    // Filter & return
    360371    return (bool) apply_filters( 'bbp_is_topic_split', $retval );
    361372}
    … …  
    388399    }
    389400
     401    // Filter & return
    390402    return (bool) apply_filters( 'bbp_is_topic_tag', $retval );
    391403}
    … …  
    419431    }
    420432
     433    // Filter & return
    421434    return (bool) apply_filters( 'bbp_is_topic_tag_edit', $retval );
    422435}
    … …  
    449462    }
    450463
     464    // Filter & return
    451465    return (bool) apply_filters( 'bbp_is_custom_post_type', $retval, $the_post );
    452466}
    … …  
    472486    }
    473487
     488    // Filter & return
    474489    return (bool) apply_filters( 'bbp_is_reply', $retval, $post_id );
    475490}
    … …  
    498513    }
    499514
     515    // Filter & return
    500516    return (bool) apply_filters( 'bbp_is_reply_edit', $retval );
    501517}
    … …  
    517533    }
    518534
     535    // Filter & return
    519536    return (bool) apply_filters( 'bbp_is_reply_move', $retval );
    520537}
    … …  
    547564    }
    548565
     566    // Filter & return
    549567    return (bool) apply_filters( 'bbp_is_single_reply', $retval );
    550568}
    … …  
    568586    }
    569587
     588    // Filter & return
    570589    return (bool) apply_filters( 'bbp_is_favorites', $retval );
    571590}
    … …  
    589608    }
    590609
     610    // Filter & return
    591611    return (bool) apply_filters( 'bbp_is_subscriptions', $retval );
    592612}
    … …  
    611631    }
    612632
     633    // Filter & return
    613634    return (bool) apply_filters( 'bbp_is_topics_created', $retval );
    614635}
    … …  
    633654    }
    634655
     656    // Filter & return
    635657    return (bool) apply_filters( 'bbp_is_replies_created', $retval );
    636658}
    … …  
    658680    }
    659681
     682    // Filter & return
    660683    return (bool) apply_filters( 'bbp_is_user_home', $retval );
    661684}
    … …  
    681704    }
    682705
     706    // Filter & return
    683707    return (bool) apply_filters( 'bbp_is_user_home_edit', $retval );
    684708}
    … …  
    703727    }
    704728
     729    // Filter & return
    705730    return (bool) apply_filters( 'bbp_is_single_user', $retval );
    706731}
    … …  
    725750    }
    726751
     752    // Filter & return
    727753    return (bool) apply_filters( 'bbp_is_single_user_edit', $retval );
    728754}
    … …  
    747773    }
    748774
     775    // Filter & return
    749776    return (bool) apply_filters( 'bbp_is_single_user_profile', $retval );
    750777}
    … …  
    769796    }
    770797
     798    // Filter & return
    771799    return (bool) apply_filters( 'bbp_is_single_user_topics', $retval );
    772800}
    … …  
    791819    }
    792820
     821    // Filter & return
    793822    return (bool) apply_filters( 'bbp_is_single_user_replies', $retval );
    794823}
    … …  
    813842    }
    814843
     844    // Filter & return
    815845    return (bool) apply_filters( 'bbp_is_single_user_engagements', $retval );
    816846}
    … …  
    841871    }
    842872
     873    // Filter & return
    843874    return (bool) apply_filters( 'bbp_is_single_view', $retval );
    844875}
    … …  
    879910    }
    880911
     912    // Filter & return
    881913    return (bool) apply_filters( 'bbp_is_search', $retval );
    882914}
    … …  
    917949    }
    918950
     951    // Filter & return
    919952    return (bool) apply_filters( 'bbp_is_search_results', $retval );
    920953}
    … …  
    939972    }
    940973
     974    // Filter & return
    941975    return (bool) apply_filters( 'bbp_is_edit', $retval );
    942976}
    … …  
    10921126    $classes = apply_filters( 'bbp_get_the_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes );
    10931127
    1094     return apply_filters( 'bbp_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes );
     1128    // Filter & return
     1129    return (array) apply_filters( 'bbp_body_class', $classes, $bbp_classes, $wp_classes, $custom_classes );
    10951130}
    10961131
    … …  
    12481283
    12491284        // Add action as query arg
    1250         if ( ! empty( $r['action'] ) ) {
    1251             $login_url = add_query_arg( array( 'action' => $r['action'] ), $r['url'] );
    1252 
    1253         // No query arg
    1254         } else {
    1255             $login_url = $r['url'];
    1256         }
     1285        $login_url = ! empty( $r['action'] )
     1286            ? add_query_arg( array( 'action' => $r['action'] ), $r['url'] )
     1287            : $r['url'];
    12571288
    12581289        $login_url = site_url( $login_url, $r['context'] );
    12591290
     1291        // Filter & return
    12601292        return apply_filters( 'bbp_get_wp_login_action', $login_url, $r, $args );
    12611293    }
    … …  
    12901322    $redirect_field = '<input type="hidden" id="bbp_redirect_to" name="redirect_to" value="' . esc_url( $redirect_to ) . '" />';
    12911323
     1324    // Filter & return
    12921325    echo apply_filters( 'bbp_redirect_to_field', $redirect_field, $redirect_to );
    12931326}
    … …  
    13511384        }
    13521385
     1386        // Filter & return
    13531387        return apply_filters( 'bbp_get_sanitize_val', $retval, $request, $input_type );
    13541388    }
    … …  
    13971431        }
    13981432
     1433        // Filter & return
    13991434        return apply_filters( 'bbp_get_tab_index', (int) $bbp->tab_index );
    14001435    }
    … …  
    16251660        }
    16261661
     1662        // Filter & return
    16271663        return apply_filters( 'bbp_get_dropdown', $retval, $r );
    16281664    }
    … …  
    19391975        $output = ob_get_clean();
    19401976
     1977        // Filter & return
    19411978        return apply_filters( 'bbp_get_the_content', $output, $args, $post_content );
    19421979    }
    … …  
    19642001    $plugins[] = 'tabfocus';
    19652002
     2003    // Filter & return
    19662004    return apply_filters( 'bbp_get_tiny_mce_plugins', $plugins );
    19672005}
    … …  
    19892027    array_push( $buttons, 'image' );
    19902028
     2029    // Filter & return
    19912030    return apply_filters( 'bbp_get_teeny_mce_buttons', $buttons );
    19922031}
    … …  
    20162055    $settings['buttons'] = implode( ',', $buttons );
    20172056
     2057    // Filter & return
    20182058    return apply_filters( 'bbp_get_quicktags_settings', $settings );
    20192059}
    … …  
    21432183        }
    21442184
     2185        // Filter & return
    21452186        return apply_filters( 'bbp_get_view_link', $url, $view );
    21462187    }
    … …  
    25042545        $trail  = ! empty( $crumbs ) ? ( $r['before'] . $r['crumb_before'] . implode( $sep . $r['crumb_after'] . $r['crumb_before'] , $crumbs ) . $r['crumb_after'] . $r['after'] ) : '';
    25052546
     2547        // Filter & return
    25062548        return apply_filters( 'bbp_get_breadcrumb', $trail, $crumbs, $r );
    25072549    }
    … …  
    25482590        }
    25492591
     2592        // Filter & return
    25502593        return apply_filters( 'bbp_get_allowed_tags', htmlentities( $allowed ) );
    25512594    }
    … …  
    26412684     */
    26422685    function bbp_get_logout_link( $redirect_to = '' ) {
    2643         return apply_filters( 'bbp_get_logout_link', '<a href="' . wp_logout_url( $redirect_to ) . '" class="button logout-link">' . esc_html__( 'Log Out', 'bbpress' ) . '</a>', $redirect_to );
     2686
     2687        // Build the link
     2688        $link = '<a href="' . wp_logout_url( $redirect_to ) . '" class="button logout-link">' . esc_html__( 'Log Out', 'bbpress' ) . '</a>';
     2689
     2690        // Filter & return
     2691        return apply_filters( 'bbp_get_logout_link', $link, $redirect_to );
    26442692    }
    26452693
    … …  
    28582906    }
    28592907
    2860     // Filter and return
     2908    // Filter & return
    28612909    return apply_filters( 'bbp_title', $new_title, $sep, $seplocation );
    28622910}
Note: See TracChangeset for help on using the changeset viewer.