Skip to:
Content

bbPress.org


Ignore:
Timestamp:
05/27/2017 05:04:31 PM (8 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/functions.php

    r6437 r6438  
    2424 */
    2525function bbp_get_redirect_to() {
    26     $retval = ! empty( $_REQUEST['redirect_to'] ) ? $_REQUEST['redirect_to'] : '';
    27 
     26
     27    // Check 'redirect_to' request parameter
     28    $retval = ! empty( $_REQUEST['redirect_to'] )
     29        ? $_REQUEST['redirect_to']
     30        : '';
     31
     32    // Filter & return
    2833    return apply_filters( 'bbp_get_redirect_to', $retval );
    2934}
    … …  
    4449
    4550    // Are we appending the view=all vars?
    46     if ( bbp_get_view_all() || ! empty( $force ) ) {
    47         $link = add_query_arg( array( 'view' => 'all' ), $original_link );
    48     } else {
    49         $link = $original_link;
    50     }
    51 
     51    $link = ( bbp_get_view_all() || ! empty( $force ) )
     52        ? add_query_arg( array( 'view' => 'all' ), $original_link )
     53        : $original_link;
     54
     55    // Filter & return
    5256    return apply_filters( 'bbp_add_view_all', $link, $original_link );
    5357}
    … …  
    6569 */
    6670function bbp_remove_view_all( $original_link = '' ) {
    67     return apply_filters( 'bbp_remove_view_all', remove_query_arg( 'view', $original_link ), $original_link );
     71
     72    // Remove `view' argument
     73    $link = remove_query_arg( 'view', $original_link );
     74
     75    // Filter & return
     76    return apply_filters( 'bbp_remove_view_all', $link, $original_link );
    6877}
    6978
    … …  
    7988function bbp_get_view_all( $cap = 'moderate' ) {
    8089    $retval = ( ( ! empty( $_GET['view'] ) && ( 'all' === $_GET['view'] ) && current_user_can( $cap ) ) );
     90
     91    // Filter & return
    8192    return apply_filters( 'bbp_get_view_all', (bool) $retval );
    8293}
    … …  
    192203    }
    193204
     205    // Filter & return
    194206    return apply_filters( 'bbp_past_edit_lock', (bool) $retval, $cur_time, $lock_time, $post_date_gmt );
    195207}
    … …  
    424436    $statistics['hidden_reply_title'] = isset( $hidden_reply_title ) ? $hidden_reply_title : '';
    425437
     438    // Filter & return
    426439    return apply_filters( 'bbp_get_statistics', $statistics, $r );
    427440}
    … …  
    480493    $r['bbp_anonymous_website'] = apply_filters( 'bbp_pre_anonymous_post_author_website', $r['bbp_anonymous_website'] );
    481494
    482     // Finally, return filtered anonymous post data
     495    // Filter & return
    483496    return (array) apply_filters( 'bbp_filter_anonymous_post_data', $r, $args );
    484497}
    … …  
    519532    }
    520533
    521     // Filter and return
     534    // Filter & return
    522535    return (array) apply_filters( 'bbp_sanitize_anonymous_post_author', $r, $anonymous_data );
    523536}
    … …  
    972985        $sitename = substr( $sitename, 4 );
    973986    }
     987
     988    // Filter & return
    974989    return apply_filters( 'bbp_get_do_not_reply_address', 'noreply@' . $sitename );
    975990}
    … …  
    13651380    }
    13661381
    1367     // Filter and return
     1382    // Filter & return
    13681383    return apply_filters( 'bbp_logout_url', $url, $redirect_to );
    13691384}
    … …  
    15151530    unset( $query );
    15161531
    1517     // Filter and return
     1532    // Filter & return
    15181533    return (int) apply_filters( 'bbp_get_public_child_last_id', $child_id, $parent_id, $post_type );
    15191534}
    … …  
    15661581    unset( $query );
    15671582
    1568     // Filter and return
     1583    // Filter & return
    15691584    return (int) apply_filters( 'bbp_get_public_child_count', $child_count, $parent_id, $post_type );
    15701585}
    … …  
    16171632    unset( $query );
    16181633
    1619     // Filter and return
     1634    // Filter & return
    16201635    return (array) apply_filters( 'bbp_get_public_child_ids', $child_ids, $parent_id, $post_type );
    16211636}
    … …  
    17011716    $child_ids = wp_parse_id_list( $child_ids );
    17021717
    1703     // Filter and return
     1718    // Filter & return
    17041719    return (array) apply_filters( 'bbp_get_all_child_ids', $child_ids, $parent_id, $post_type );
    17051720}
    … …  
    17261741        : '';
    17271742
     1743    // Filter & return
    17281744    return apply_filters( 'bbp_get_global_post_field', $retval, $post, $field, $context );
    17291745}
    … …  
    20592075    }
    20602076
     2077    // Filter & return
    20612078    return apply_filters( 'bbp_get_page_by_path', $retval, $path );
    20622079}
Note: See TracChangeset for help on using the changeset viewer.