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

    r6433 r6438  
    3333     */
    3434    function bbp_get_forum_post_type() {
     35
     36        // Filter & return
    3537        return apply_filters( 'bbp_get_forum_post_type', bbpress()->forum_post_type );
    3638    }
    … …  
    4547 */
    4648function bbp_get_forum_post_type_labels() {
    47     return apply_filters( 'bbp_get_forum_post_type_labels', array(
     49
     50    // Filter & return
     51    return (array) apply_filters( 'bbp_get_forum_post_type_labels', array(
    4852        'name'                  => __( 'Forums',                   'bbpress' ),
    4953        'menu_name'             => __( 'Forums',                   'bbpress' ),
    … …  
    7680 */
    7781function bbp_get_forum_post_type_rewrite() {
    78     return apply_filters( 'bbp_get_forum_post_type_rewrite', array(
     82
     83    // Filter & return
     84    return (array) apply_filters( 'bbp_get_forum_post_type_rewrite', array(
    7985        'slug'       => bbp_get_forum_slug(),
    8086        'with_front' => false
    … …  
    9096 */
    9197function bbp_get_forum_post_type_supports() {
    92     return apply_filters( 'bbp_get_forum_post_type_supports', array(
     98
     99    // Filter & return
     100    return (array) apply_filters( 'bbp_get_forum_post_type_supports', array(
    93101        'title',
    94102        'editor',
    … …  
    148156    $bbp->forum_query = new WP_Query( $bbp_f );
    149157
     158    // Filter & return
    150159    return apply_filters( 'bbp_has_forums', $bbp->forum_query->have_posts(), $bbp->forum_query );
    151160}
    … …  
    250259        }
    251260
     261        // Filter & return
    252262        return (int) apply_filters( 'bbp_get_forum_id', (int) $bbp_forum_id, $forum_id );
    253263    }
    … …  
    298308    }
    299309
     310    // Filter & return
    300311    return apply_filters( 'bbp_get_forum', $forum, $output, $filter );
    301312}
    … …  
    340351        }
    341352
     353        // Filter & return
    342354        return apply_filters( 'bbp_get_forum_permalink', $forum_permalink, $forum_id );
    343355    }
    … …  
    369381        $title    = get_the_title( $forum_id );
    370382
     383        // Filter & return
    371384        return apply_filters( 'bbp_get_forum_title', $title, $forum_id );
    372385    }
    … …  
    415428        }
    416429
     430        // Filter & return
    417431        return apply_filters( 'bbp_get_forum_archive_title', $title );
    418432    }
    … …  
    453467        $content = get_post_field( 'post_content', $forum_id );
    454468
     469        // Filter & return
    455470        return apply_filters( 'bbp_get_forum_content', $content, $forum_id );
    456471    }
    … …  
    495510        $active_id = get_post_meta( $forum_id, '_bbp_last_active_id', true );
    496511
     512        // Filter & return
    497513        return (int) apply_filters( 'bbp_get_forum_last_active_id', (int) $active_id, $forum_id );
    498514    }
    … …  
    548564        $active_time = ! empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
    549565
     566        // Filter & return
    550567        return apply_filters( 'bbp_get_forum_last_active', $active_time, $forum_id );
    551568    }
    … …  
    617634        }
    618635
     636        // Filter & return
    619637        return apply_filters( 'bbp_get_forum_freshness_link', $anchor, $forum_id, $time_since, $link_url, $title, $active_id );
    620638    }
    … …  
    646664        $parent_id = get_post_field( 'post_parent', $forum_id );
    647665
     666        // Filter & return
    648667        return (int) apply_filters( 'bbp_get_forum_parent_id', (int) $parent_id, $forum_id );
    649668    }
    … …  
    673692    }
    674693
     694    // Filter & return
    675695    return apply_filters( 'bbp_get_forum_ancestors', $ancestors, $forum_id );
    676696}
    … …  
    741761        : array();
    742762
     763    // Filter & return
    743764    return (array) apply_filters( 'bbp_forum_get_subforums', $sub_forums, $r, $args );
    744765}
    … …  
    889910        }
    890911
     912        // Filter & return
    891913        return apply_filters( 'bbp_get_forum_subscribe_link', $retval, $r, $args );
    892914    }
    … …  
    921943        $topic_id = get_post_meta( $forum_id, '_bbp_last_topic_id', true );
    922944
     945        // Filter & return
    923946        return (int) apply_filters( 'bbp_get_forum_last_topic_id', (int) $topic_id, $forum_id );
    924947    }
    … …  
    953976        $title    = ! empty( $topic_id ) ? bbp_get_topic_title( $topic_id ) : '';
    954977
     978        // Filter & return
    955979        return apply_filters( 'bbp_get_forum_last_topic_title', $title, $forum_id );
    956980    }
    … …  
    9861010        $link     = bbp_get_topic_permalink( $topic_id );
    9871011
     1012        // Filter & return
    9881013        return apply_filters( 'bbp_get_forum_last_topic_permalink', $link, $forum_id, $topic_id );
    9891014    }
    … …  
    10071032    $author_id = bbp_get_topic_author_id( $topic_id );
    10081033
     1034    // Filter & return
    10091035    return (int) apply_filters( 'bbp_get_forum_last_topic_author_id', (int) $author_id, $forum_id, $topic_id );
    10101036}
    … …  
    10411067        $author_link = bbp_get_user_profile_link( $author_id );
    10421068
     1069        // Filter & return
    10431070        return apply_filters( 'bbp_get_forum_last_topic_author_link', $author_link, $forum_id );
    10441071    }
    … …  
    10741101        $reply_id = get_post_meta( $forum_id, '_bbp_last_reply_id', true );
    10751102
     1103        // Filter & return
    10761104        return (int) apply_filters( 'bbp_get_forum_last_reply_id', (int) $reply_id, $forum_id );
    10771105    }
    … …  
    11021130        $title    = bbp_get_reply_title( $reply_id );
    11031131
     1132        // Filter & return
    11041133        return apply_filters( 'bbp_get_forum_last_reply_title', $title, $forum_id, $reply_id );
    11051134    }
    … …  
    11341163        $link     = bbp_get_reply_permalink( $reply_id );
    11351164
     1165        // Filter & return
    11361166        return apply_filters( 'bbp_get_forum_last_reply_permalink', $link, $forum_id, $reply_id );
    11371167    }
    … …  
    11811211        }
    11821212
    1183         // Filter and return
     1213        // Filter & return
    11841214        return apply_filters( 'bbp_get_forum_last_reply_url', $reply_url, $forum_id, $reply_id );
    11851215    }
    … …  
    12161246        $author_id = bbp_get_reply_author_id( $reply_id );
    12171247
     1248        // Filter & return
    12181249        return apply_filters( 'bbp_get_forum_last_reply_author_id', $author_id, $forum_id, $reply_id );
    12191250    }
    … …  
    12511282        $author_link = bbp_get_user_profile_link( $author_id );
    12521283
     1284        // Filter & return
    12531285        return apply_filters( 'bbp_get_forum_last_reply_author_link', $author_link, $forum_id, $author_id );
    12541286    }
    … …  
    13101342        }
    13111343
     1344        // Filter & return
    13121345        return apply_filters( 'bbp_get_forum_topics_link', $retval, $forum_id );
    13131346    }
    … …  
    15351568        }
    15361569
     1570        // Filter & return
    15371571        return apply_filters( 'bbp_get_forum_status', $status, $forum_id );
    15381572    }
    … …  
    15651599        $visibility = get_post_status( $forum_id );
    15661600
     1601        // Filter & return
    15671602        return apply_filters( 'bbp_get_forum_visibility', $visibility, $forum_id );
    15681603    }
    … …  
    15961631        }
    15971632
     1633        // Filter & return
    15981634        return apply_filters( 'bbp_get_forum_type', $retval, $forum_id );
    15991635    }
    … …  
    16131649    $retval   = ( ! empty( $type ) && 'category' === $type );
    16141650
     1651    // Filter & return
    16151652    return (bool) apply_filters( 'bbp_is_forum_category', (bool) $retval, $forum_id );
    16161653}
    … …  
    16511688    $retval   = bbp_is_forum_status( $forum_id, bbp_get_closed_status_id(), $check_ancestors, 'OR' );
    16521689
     1690    // Filter & return
    16531691    return (bool) apply_filters( 'bbp_is_forum_closed', (bool) $retval, $forum_id, $check_ancestors );
    16541692}
    … …  
    17241762    }
    17251763
    1726     // Filter and return
     1764    // Filter & return
    17271765    return (bool) apply_filters( 'bbp_is_forum_status', $retval, $count, $forum_id, $status_name, $check_ancestors, $operator );
    17281766}
    … …  
    17471785    $retval   = bbp_is_forum_visibility( $forum_id, bbp_get_public_status_id(), $check_ancestors );
    17481786
    1749     return (bool) apply_filters( 'bbp_is_forum_public', (bool) $retval, $forum_id, $check_ancestors );
     1787    // Filter & return
     1788    return (bool) apply_filters( 'bbp_is_forum_public', $retval, $forum_id, $check_ancestors );
    17501789}
    17511790
    … …  
    17691808    $retval   = bbp_is_forum_visibility( $forum_id, bbp_get_private_status_id(), $check_ancestors, 'OR' );
    17701809
    1771     return (bool) apply_filters( 'bbp_is_forum_private', (bool) $retval, $forum_id, $check_ancestors );
     1810    // Filter & return
     1811    return (bool) apply_filters( 'bbp_is_forum_private', $retval, $forum_id, $check_ancestors );
    17721812}
    17731813
    … …  
    17921832    $retval   = bbp_is_forum_visibility( $forum_id, bbp_get_hidden_status_id(), $check_ancestors, 'OR' );
    17931833
    1794     return (bool) apply_filters( 'bbp_is_forum_hidden', (bool) $retval, $forum_id, $check_ancestors );
     1834    // Filter & return
     1835    return (bool) apply_filters( 'bbp_is_forum_hidden', $retval, $forum_id, $check_ancestors );
    17951836}
    17961837
    … …  
    18681909    }
    18691910
    1870     // Filter and return
     1911    // Filter & return
    18711912    return (bool) apply_filters( 'bbp_is_forum_visibility', $retval, $count, $forum_id, $status_name, $check_ancestors, $operator );
    18721913}
    … …  
    18991940        $author_id = get_post_field( 'post_author', $forum_id );
    19001941
     1942        // Filter & return
    19011943        return (int) apply_filters( 'bbp_get_forum_author_id', (int) $author_id, $forum_id );
    19021944    }
    … …  
    19311973        $author    = get_the_author_meta( 'display_name', $author_id );
    19321974
     1975        // Filter & return
    19331976        return apply_filters( 'bbp_get_forum_author_display_name', $author, $forum_id, $author_id );
    19341977    }
    … …  
    19521995    }
    19531996
     1997    // Filter & return
    19541998    return apply_filters( 'bbp_suppress_private_forum_meta', $retval );
    19551999}
    … …  
    20062050    }
    20072051
     2052    // Filter & return
    20082053    return apply_filters( 'bbp_suppress_private_author_link', $retval, $author_link, $args );
    20092054}
    … …  
    21952240        $retstr = $r['before'] . $retstr . $r['after'];
    21962241
    2197         // Return filtered result
     2242        // Filter & return
    21982243        return apply_filters( 'bbp_get_single_forum_description', $retstr, $r, $args );
    21992244    }
    … …  
    22352280        }
    22362281
     2282        // Filter & return
    22372283        return apply_filters( 'bbp_get_form_forum_title', $forum_title );
    22382284    }
    … …  
    22722318        }
    22732319
     2320        // Filter & return
    22742321        return apply_filters( 'bbp_get_form_forum_content', $forum_content );
    22752322    }
    … …  
    23262373        }
    23272374
     2375        // Filter & return
    23282376        return apply_filters( 'bbp_get_form_forum_moderators', $forum_mods );
    23292377    }
    … …  
    23642412        }
    23652413
     2414        // Filter & return
    23662415        return apply_filters( 'bbp_get_form_forum_parent', $forum_parent );
    23672416    }
    … …  
    24022451        }
    24032452
     2453        // Filter & return
    24042454        return apply_filters( 'bbp_get_form_forum_type', $forum_type );
    24052455    }
    … …  
    24402490        }
    24412491
     2492        // Filter & return
    24422493        return apply_filters( 'bbp_get_form_forum_visibility', $forum_visibility );
    24432494    }
    … …  
    25002551        $checked = checked( $forum_subscribed, true, false );
    25012552
     2553        // Filter & return
    25022554        return apply_filters( 'bbp_get_form_forum_subscribed', $checked, $forum_subscribed );
    25032555    }
    … …  
    25912643        <?php
    25922644
    2593         // Return the results
     2645        // Filter & return
    25942646        return apply_filters( 'bbp_get_form_forum_type_dropdown', ob_get_clean(), $r, $args );
    25952647    }
    … …  
    26812733        <?php
    26822734
    2683         // Return the results
     2735        // Filter & return
    26842736        return apply_filters( 'bbp_get_form_forum_status_dropdown', ob_get_clean(), $r, $args );
    26852737    }
    … …  
    27712823        <?php
    27722824
    2773         // Return the results
     2825        // Filter & return
    27742826        return apply_filters( 'bbp_get_form_forum_type_dropdown', ob_get_clean(), $r, $args );
    27752827    }
    … …  
    28682920        }
    28692921
     2922        // Filter & return
    28702923        return apply_filters( 'bbp_get_forum_topics_feed_link', $link, $url, $forum_id );
    28712924    }
    … …  
    29322985        }
    29332986
     2987        // Filter & return
    29342988        return apply_filters( 'bbp_get_forum_replies_feed_link', $link, $url, $forum_id );
    29352989    }
Note: See TracChangeset for help on using the changeset viewer.