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

    r6427 r6438  
    191191    $bbp->user_query = new BBP_User_Query( $r );
    192192
     193    // Filter & return
    193194    return apply_filters( 'bbp_has_users', $bbp->user_query->have_users(), $bbp->user_query );
    194195}
    … …  
    270271        }
    271272
     273        // Filter & return
    272274        return (int) apply_filters( 'bbp_get_user_id', (int) $bbp_user_id, $displayed_user_fallback, $current_user_fallback );
    273275    }
    … …  
    293295     */
    294296    function bbp_get_current_user_id() {
    295         return apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
     297
     298        // Filter & return
     299        return (int) apply_filters( 'bbp_get_current_user_id', bbp_get_user_id( 0, false, true ) );
    296300    }
    297301
    … …  
    316320     */
    317321    function bbp_get_displayed_user_id() {
     322
     323        // Filter & return
    318324        return apply_filters( 'bbp_get_displayed_user_id', bbp_get_user_id( 0, true, false ) );
    319325    }
    … …  
    368374        $user->filter = $old_filter;
    369375
    370         // Return empty
     376        // Filter & return
    371377        return apply_filters( 'bbp_get_displayed_user_field', $value, $field, $filter );
    372378    }
    … …  
    394400        global $user_identity;
    395401
    396         $current_user_name = is_user_logged_in() ? $user_identity : __( 'Anonymous', 'bbpress' );
    397 
     402        $current_user_name = is_user_logged_in()
     403            ? $user_identity
     404            : esc_html__( 'Anonymous', 'bbpress' );
     405
     406        // Filter & return
    398407        return apply_filters( 'bbp_get_current_user_name', $current_user_name );
    399408    }
    … …  
    434443        $avatar = get_avatar( $user, $size );
    435444
     445        // Filter & return
    436446        return apply_filters( 'bbp_get_current_user_avatar', $avatar, $size );
    437447    }
    … …  
    472482        $user_link = '<a href="' . esc_url( bbp_get_user_profile_url( $user_id ) ) . '">' . esc_html( $user->display_name ) . '</a>';
    473483
     484        // Filter & return
    474485        return apply_filters( 'bbp_get_user_profile_link', $user_link, $user_id );
    475486    }
    … …  
    524535        $retval = ! empty( $nicename ) ? ( $r['before'] . $nicename . $r['after'] ) : '';
    525536
    526         // Filter and return
     537        // Filter & return
    527538        return (string) apply_filters( 'bbp_get_user_nicename', $retval, $user_id, $r );
    528539    }
    … …  
    588599        }
    589600
     601        // Filter & return
    590602        return apply_filters( 'bbp_get_user_profile_url', $url, $user_id, $user_nicename );
    591603    }
    … …  
    625637        $user      = get_userdata( $user_id );
    626638        $edit_link = '<a href="' . esc_url( bbp_get_user_profile_edit_url( $user_id ) ) . '">' . esc_html( $user->display_name ) . '</a>';
     639
     640        // Filter & return
    627641        return apply_filters( 'bbp_get_user_profile_edit_link', $edit_link, $user_id );
    628642    }
    … …  
    684698        }
    685699
     700        // Filter & return
    686701        return apply_filters( 'bbp_get_user_edit_profile_url', $url, $user_id, $user_nicename );
    687 
    688702    }
    689703
    … …  
    736750        }
    737751
     752        // Filter & return
    738753        return apply_filters( 'bbp_get_user_display_role', $role, $user_id );
    739754    }
    … …  
    784799        $retval = $r['before'] . '<a href="' . esc_url( admin_url() ) . '">' . $r['text'] . '</a>' . $r['after'];
    785800
     801        // Filter & return
    786802        return apply_filters( 'bbp_get_admin_link', $retval, $r );
    787803    }
    … …  
    831847        }
    832848
     849        // Filter & return
    833850        return apply_filters( 'bbp_get_author_ip', $author_ip, $r );
    834851    }
    … …  
    889906        }
    890907
     908        // Filter & return
    891909        return apply_filters( 'bbp_get_author_display_name', $retval, $post_id );
    892910    }
    … …  
    945963        }
    946964
     965        // Filter & return
    947966        return apply_filters( 'bbp_get_author_email', $retval, $post_id );
    948967    }
    … …  
    10011020        }
    10021021
     1022        // Filter & return
    10031023        return apply_filters( 'bbp_get_author_url', $retval, $post_id );
    10041024    }
    … …  
    10801100        }
    10811101
     1102        // Filter & return
    10821103        return apply_filters( 'bbp_get_favorites_permalink', $url, $user_id );
    10831104    }
    … …  
    11911212        }
    11921213
    1193         // Return the link
     1214        // Filter & return
    11941215        return apply_filters( 'bbp_get_user_favorites_link', $html, $r, $user_id, $topic_id );
    11951216    }
    … …  
    12811302        }
    12821303
     1304        // Filter & return
    12831305        return apply_filters( 'bbp_get_subscriptions_permalink', $url, $user_id );
    12841306    }
    … …  
    14351457        }
    14361458
    1437         // Return the link
     1459        // Filter & return
    14381460        return apply_filters( 'bbp_get_user_subscribe_link', $html, $r, $user_id, $topic_id );
    14391461    }
    … …  
    16031625function bbp_edit_user_blog_role() {
    16041626
    1605     // Return if no user is being edited
     1627    // Bail if no user is being edited
    16061628    if ( ! bbp_is_single_user_edit() ) {
    16071629        return;
    … …  
    16351657function bbp_edit_user_forums_role() {
    16361658
    1637     // Return if no user is being edited
     1659    // Bail if no user is being edited
    16381660    if ( ! bbp_is_single_user_edit() ) {
    16391661        return;
    … …  
    16791701    $contact_methods = wp_get_user_contact_methods( bbpress()->displayed_user );
    16801702
    1681     return apply_filters( 'bbp_edit_user_contact_methods', $contact_methods );
     1703    // Filter & return
     1704    return (array) apply_filters( 'bbp_edit_user_contact_methods', $contact_methods );
    16821705}
    16831706
    … …  
    17351758        }
    17361759
     1760        // Filter & return
    17371761        return apply_filters( 'bbp_get_user_topics_created_url', $url, $user_id );
    17381762    }
    … …  
    17911815        }
    17921816
     1817        // Filter & return
    17931818        return apply_filters( 'bbp_get_user_replies_created_url', $url, $user_id );
    17941819    }
    … …  
    18471872        }
    18481873
     1874        // Filter & return
    18491875        return apply_filters( 'bbp_get_user_engagements_url', $url, $user_id );
    18501876    }
    … …  
    21052131        }
    21062132
     2133        // Filter & return
    21072134        return apply_filters( 'bbp_get_author_link', $author_link, $r );
    21082135    }
    … …  
    21572184
    21582185    // Forum is hidden, and user can see it
    2159     } elseif ( bbp_is_forum_hidden ( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_forum', $forum_id  ) ) {
     2186    } elseif ( bbp_is_forum_hidden( $forum_id, $r['check_ancestors'] ) && user_can( $user_id, 'read_forum', $forum_id  ) ) {
    21602187        $retval = true;
    21612188    }
    21622189
     2190    // Filter & return
    21632191    return apply_filters( 'bbp_user_can_view_forum', $retval, $forum_id, $user_id );
    21642192}
    … …  
    21962224    }
    21972225
    2198     // Allow access to be filtered
     2226    // Filter & return
    21992227    return (bool) apply_filters( 'bbp_current_user_can_publish_topics', $retval );
    22002228}
    … …  
    22262254    }
    22272255
    2228     // Allow access to be filtered
     2256    // Filter & return
    22292257    return (bool) apply_filters( 'bbp_current_user_can_publish_forums', $retval );
    22302258}
    … …  
    22622290    }
    22632291
    2264     // Allow access to be filtered
     2292    // Filter & return
    22652293    return (bool) apply_filters( 'bbp_current_user_can_publish_replies', $retval );
    22662294}
    … …  
    23032331    }
    23042332
     2333    // Filter & return
    23052334    return apply_filters( 'bbp_get_forums_for_current_user', $forums, $r, $args );
    23062335}
    … …  
    23362365    }
    23372366
    2338     // Allow access to be filtered
     2367    // Filter & return
    23392368    return (bool) apply_filters( 'bbp_current_user_can_access_create_forum_form', (bool) $retval );
    23402369}
    … …  
    23722401    }
    23732402
    2374     // Allow access to be filtered
     2403    // Filter & return
    23752404    return (bool) apply_filters( 'bbp_current_user_can_access_create_topic_form', (bool) $retval );
    23762405}
    … …  
    24082437    }
    24092438
    2410     // Allow access to be filtered
     2439    // Filter & return
    24112440    return (bool) apply_filters( 'bbp_current_user_can_access_create_reply_form', (bool) $retval );
    24122441}
    … …  
    24442473    }
    24452474
    2446     // Allow access to be filtered
     2475    // Filter & return
    24472476    return (bool) apply_filters( 'bbp_current_user_can_access_anonymous_user_form', (bool) $retval );
    24482477}
    … …  
    25082537        }
    25092538
     2539        // Filter & return
    25102540        return apply_filters( 'bbp_get_moderator_list', $retval );
    25112541    }
Note: See TracChangeset for help on using the changeset viewer.