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

    r6433 r6438  
    3333     */
    3434    function bbp_get_topic_post_type() {
     35
     36        // Filter & return
    3537        return apply_filters( 'bbp_get_topic_post_type', bbpress()->topic_post_type );
    3638    }
    … …  
    4446 */
    4547function bbp_get_topic_post_type_labels() {
    46     return apply_filters( 'bbp_get_topic_post_type_labels', array(
     48
     49    // Filter & return
     50    return (array) apply_filters( 'bbp_get_topic_post_type_labels', array(
    4751        'name'                  => __( 'Topics',                   'bbpress' ),
    4852        'menu_name'             => __( 'Topics',                   'bbpress' ),
    … …  
    7579 */
    7680function bbp_get_topic_post_type_rewrite() {
    77     return apply_filters( 'bbp_get_topic_post_type_rewrite', array(
     81
     82    // Filter & return
     83    return (array) apply_filters( 'bbp_get_topic_post_type_rewrite', array(
    7884        'slug'       => bbp_get_topic_slug(),
    7985        'with_front' => false
    … …  
    8995 */
    9096function bbp_get_topic_post_type_supports() {
    91     return apply_filters( 'bbp_get_topic_post_type_supports', array(
     97
     98    // Filter & return
     99    return (array) apply_filters( 'bbp_get_topic_post_type_supports', array(
    92100        'title',
    93101        'editor',
    … …  
    113121    }
    114122
     123    // Filter & return
    115124    return (bool) apply_filters( 'bbp_show_lead_topic', (bool) $show_lead );
    116125}
    … …  
    265274    }
    266275
    267     // Return object
     276    // Filter & return
    268277    return apply_filters( 'bbp_has_topics', $bbp->topic_query->have_posts(), $bbp->topic_query );
    269278}
    … …  
    502511        }
    503512
     513        // Filter & return
    504514        return (int) apply_filters( 'bbp_get_topic_id', (int) $bbp_topic_id, $topic_id );
    505515    }
    … …  
    549559    }
    550560
     561    // Filter & return
    551562    return apply_filters( 'bbp_get_topic', $topic, $output, $filter );
    552563}
    … …  
    592603        }
    593604
     605        // Filter & return
    594606        return apply_filters( 'bbp_get_topic_permalink', $topic_permalink, $topic_id );
    595607    }
    … …  
    622634        $title    = get_the_title( $topic_id );
    623635
     636        // Filter & return
    624637        return apply_filters( 'bbp_get_topic_title', $title, $topic_id );
    625638    }
    … …  
    668681        }
    669682
     683        // Filter & return
    670684        return apply_filters( 'bbp_get_topic_archive_title', $title );
    671685    }
    … …  
    706720        $content = get_post_field( 'post_content', $topic_id );
    707721
     722        // Filter & return
    708723        return apply_filters( 'bbp_get_topic_content', $content, $topic_id );
    709724    }
    … …  
    759774        }
    760775
     776        // Filter & return
    761777        return apply_filters( 'bbp_get_topic_excerpt', $excerpt, $topic_id, $length );
    762778    }
    … …  
    805821        }
    806822
     823        // Filter & return
    807824        return apply_filters( 'bbp_get_topic_post_date', $result, $topic_id, $humanize, $gmt, $date, $time );
    808825    }
    … …  
    901918        }
    902919
     920        // Filter & return
    903921        return apply_filters( 'bbp_get_topic_pagination', $pagination_links, $args );
    904922    }
    … …  
    926944    $topic_id = bbp_get_topic_id( $topic_id );
    927945
     946    // Filter & return
    928947    return apply_filters( 'bbp_topic_append_revisions', $content . bbp_get_topic_revision_log( $topic_id ), $content, $topic_id );
    929948}
    … …  
    9991018        $retval .= "\n" . '</ul>' . "\n\n";
    10001019
     1020        // Filter & return
    10011021        return apply_filters( 'bbp_get_topic_revision_log', $retval, $topic_id );
    10021022    }
    … …  
    10191039            $revision_log = empty( $revision_log ) ? array() : $revision_log;
    10201040
     1041            // Filter & return
    10211042            return apply_filters( 'bbp_get_topic_raw_revision_log', $revision_log, $topic_id );
    10221043        }
    … …  
    10381059    $revisions = wp_get_post_revisions( $topic_id, array( 'order' => 'ASC' ) );
    10391060
     1061    // Filter & return
    10401062    return apply_filters( 'bbp_get_topic_revisions', $revisions, $topic_id );
    10411063}
    … …  
    10881110    }
    10891111
     1112    // Filter & return
    10901113    return (bool) apply_filters( 'bbp_is_topic_sticky', $retval, $topic_id, $check_super );
    10911114}
    … …  
    11041127    $topic_id = bbp_get_topic_id( $topic_id );
    11051128    $stickies = bbp_get_super_stickies( $topic_id );
    1106     $retval   = in_array( $topic_id, $stickies );
    1107 
     1129    $retval   = in_array( $topic_id, $stickies, true );
     1130
     1131    // Filter & return
    11081132    return (bool) apply_filters( 'bbp_is_topic_super_sticky', $retval, $topic_id );
    11091133}
    … …  
    11351159        $topic_id = bbp_get_topic_id( $topic_id );
    11361160
     1161        // Filter & return
    11371162        return apply_filters( 'bbp_get_topic_status', get_post_status( $topic_id ), $topic_id );
    11381163    }
    … …  
    11491174 */
    11501175function bbp_get_public_topic_statuses() {
    1151     $statuses = array( bbp_get_public_status_id(), bbp_get_closed_status_id() );
    1152 
     1176    $statuses = array(
     1177        bbp_get_public_status_id(),
     1178        bbp_get_closed_status_id()
     1179    );
     1180
     1181    // Filter & return
    11531182    return (array) apply_filters( 'bbp_get_public_topic_statuses', $statuses );
    11541183}
    … …  
    11681197    $topic_id     = bbp_get_topic_id( $topic_id );
    11691198    $status       = bbp_get_closed_status_id();
    1170     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1171 
    1172     return (bool) apply_filters( 'bbp_is_topic_closed', (bool) $topic_status, $topic_id );
     1199    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1200
     1201    // Filter & return
     1202    return (bool) apply_filters( 'bbp_is_topic_closed', $topic_status, $topic_id );
    11731203}
    11741204
    … …  
    12051235    $is_public = in_array( $status, $public, true );
    12061236
    1207     return (bool) apply_filters( 'bbp_is_topic_public', (bool) $is_public, $topic_id );
     1237    // Filter & return
     1238    return (bool) apply_filters( 'bbp_is_topic_public', $is_public, $topic_id );
    12081239}
    12091240
    … …  
    12221253    $topic_id     = bbp_get_topic_id( $topic_id );
    12231254    $status       = bbp_get_public_status_id();
    1224     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1225 
    1226     return (bool) apply_filters( 'bbp_is_topic_published', (bool) $topic_status, $topic_id );
     1255    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1256
     1257    // Filter & return
     1258    return (bool) apply_filters( 'bbp_is_topic_published', $topic_status, $topic_id );
    12271259}
    12281260
    … …  
    12411273    $topic_id     = bbp_get_topic_id( $topic_id );
    12421274    $status       = bbp_get_spam_status_id();
    1243     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1244 
    1245     return (bool) apply_filters( 'bbp_is_topic_spam', (bool) $topic_status, $topic_id );
     1275    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1276
     1277    // Filter & return
     1278    return (bool) apply_filters( 'bbp_is_topic_spam', $topic_status, $topic_id );
    12461279}
    12471280
    … …  
    12601293    $topic_id     = bbp_get_topic_id( $topic_id );
    12611294    $status       = bbp_get_trash_status_id();
    1262     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1263 
    1264     return (bool) apply_filters( 'bbp_is_topic_trash', (bool) $topic_status, $topic_id );
     1295    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1296
     1297    // Filter & return
     1298    return (bool) apply_filters( 'bbp_is_topic_trash', $topic_status, $topic_id );
    12651299}
    12661300
    … …  
    12791313    $topic_id     = bbp_get_topic_id( $topic_id );
    12801314    $status       = bbp_get_pending_status_id();
    1281     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1282 
    1283     return (bool) apply_filters( 'bbp_is_topic_pending', (bool) $topic_status, $topic_id );
     1315    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1316
     1317    // Filter & return
     1318    return (bool) apply_filters( 'bbp_is_topic_pending', $topic_status, $topic_id );
    12841319}
    12851320
    … …  
    12981333    $topic_id     = bbp_get_topic_id( $topic_id );
    12991334    $status       = bbp_get_private_status_id();
    1300     $topic_status = bbp_get_topic_status( $topic_id ) === $status;
    1301 
    1302     return (bool) apply_filters( 'bbp_is_topic_private', (bool) $topic_status, $topic_id );
     1335    $topic_status = ( bbp_get_topic_status( $topic_id ) === $status );
     1336
     1337    // Filter & return
     1338    return (bool) apply_filters( 'bbp_is_topic_private', $topic_status, $topic_id );
    13031339}
    13041340
    … …  
    13291365    }
    13301366
    1331     // The topic is by an anonymous user
     1367    // Filter & return
    13321368    return (bool) apply_filters( 'bbp_is_topic_anonymous', $retval, $topic_id );
    13331369}
    … …  
    13771413        }
    13781414
     1415        // Filter & return
    13791416        return apply_filters( 'bbp_get_topic_author', $author, $topic_id );
    13801417    }
    … …  
    14071444        $author_id = get_post_field( 'post_author', $topic_id );
    14081445
     1446        // Filter & return
    14091447        return (int) apply_filters( 'bbp_get_topic_author_id', (int) $author_id, $topic_id );
    14101448    }
    … …  
    14701508        }
    14711509
     1510        // Filter & return
    14721511        return apply_filters( 'bbp_get_topic_author_display_name', $author_name, $topic_id );
    14731512    }
    … …  
    15141553        }
    15151554
     1555        // Filter & return
    15161556        return apply_filters( 'bbp_get_topic_author_avatar', $author_avatar, $topic_id, $size );
    15171557    }
    … …  
    16271667        }
    16281668
     1669        // Filter & return
    16291670        return apply_filters( 'bbp_get_topic_author_link', $author_link, $args );
    16301671    }
    … …  
    16741715        }
    16751716
     1717        // Filter & return
    16761718        return apply_filters( 'bbp_get_topic_author_url', $author_url, $topic_id );
    16771719    }
    … …  
    17271769        }
    17281770
     1771        // Filter & return
    17291772        return apply_filters( 'bbp_get_topic_author_email', $author_email, $topic_id );
    17301773    }
    … …  
    17771820        }
    17781821
     1822        // Filter & return
    17791823        return apply_filters( 'bbp_get_topic_author_role', $author_role, $r );
    17801824    }
    … …  
    18081852        $forum_id = bbp_get_topic_forum_id( $topic_id );
    18091853
     1854        // Filter & return
    18101855        return apply_filters( 'bbp_get_topic_forum', bbp_get_forum_title( $forum_id ), $topic_id, $forum_id );
    18111856    }
    … …  
    18381883        $forum_id = get_post_meta( $topic_id, '_bbp_forum_id', true );
    18391884
     1885        // Filter & return
    18401886        return (int) apply_filters( 'bbp_get_topic_forum_id', (int) $forum_id, $topic_id );
    18411887    }
    … …  
    18681914        $active_id = get_post_meta( $topic_id, '_bbp_last_active_id', true );
    18691915
     1916        // Filter & return
    18701917        return (int) apply_filters( 'bbp_get_topic_last_active_id', (int) $active_id, $topic_id );
    18711918    }
    … …  
    19141961        $last_active = ! empty( $last_active ) ? bbp_get_time_since( bbp_convert_date( $last_active ) ) : '';
    19151962
    1916         // Return the time since
     1963        // Filter & return
    19171964        return apply_filters( 'bbp_get_topic_last_active', $last_active, $topic_id );
    19181965    }
    … …  
    19682015        $retval = bbp_get_user_subscribe_link( $r );
    19692016
     2017        // Filter & return
    19702018        return apply_filters( 'bbp_get_topic_subscribe_link', $retval, $r, $args );
    19712019    }
    … …  
    20212069        $retval = bbp_get_user_favorites_link( $r );
    20222070
     2071        // Filter & return
    20232072        return apply_filters( 'bbp_get_topic_favorite_link', $retval, $r, $args );
    20242073    }
    … …  
    20532102        $reply_id = get_post_meta( $topic_id, '_bbp_last_reply_id', true );
    20542103
     2104        // Filter & return
    20552105        return (int) apply_filters( 'bbp_get_topic_last_reply_id', (int) $reply_id, $topic_id );
    20562106    }
    … …  
    20892139        $retval = apply_filters( 'bbp_get_topic_last_topic_title', $retval, $topic_id, $reply_id );
    20902140
     2141        // Filter & return
    20912142        return apply_filters( 'bbp_get_topic_last_reply_title', $retval, $topic_id, $reply_id );
    20922143    }
    … …  
    21212172        $retval   = bbp_get_reply_permalink( $reply_id );
    21222173
     2174        // Filter & return
    21232175        return apply_filters( 'bbp_get_topic_last_reply_permalink', $retval, $topic_id, $reply_id );
    21242176    }
    … …  
    21592211        }
    21602212
     2213        // Filter & return
    21612214        return apply_filters( 'bbp_get_topic_last_reply_url', $reply_url, $topic_id, $reply_id );
    21622215    }
    … …  
    22012254        }
    22022255
     2256        // Filter & return
    22032257        return apply_filters( 'bbp_get_topic_freshness_link', $anchor, $topic_id, $time_since, $link_url, $title );
    22042258    }
    … …  
    22582312        }
    22592313
     2314        // Filter & return
    22602315        return apply_filters( 'bbp_get_topic_replies_link', $retval, $topic_id );
    22612316    }
    … …  
    25952650        $retval = $r['before'] . $links . $r['after'];
    25962651
     2652        // Filter & return
    25972653        return apply_filters( 'bbp_get_topic_admin_links', $retval, $r, $args );
    25982654    }
    … …  
    26612717        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-edit-link">' . $r['edit_text'] . '</a>' . $r['link_after'];
    26622718
     2719        // Filter & return
    26632720        return apply_filters( 'bbp_get_topic_edit_link', $retval, $r, $args );
    26642721    }
    … …  
    27152772        $url = bbp_add_view_all( $url );
    27162773
     2774        // Filter & return
    27172775        return apply_filters( 'bbp_get_topic_edit_url', $url, $topic_id );
    27182776    }
    … …  
    27932851        $retval = $r['link_before'] . implode( $r['sep'], $actions ) . $r['link_after'];
    27942852
     2853        // Filter & return
    27952854        return apply_filters( 'bbp_get_topic_trash_link', $retval, $r, $args );
    27962855    }
    … …  
    28552914        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-close-link">' . $display . '</a>' . $r['link_after'];
    28562915
     2916        // Filter & return
    28572917        return apply_filters( 'bbp_get_topic_close_link', $retval, $r, $args );
    28582918    }
    … …  
    29182978        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-approve-link">' . $display . '</a>' . $r['link_after'];
    29192979
     2980        // Filter & return
    29202981        return apply_filters( 'bbp_get_topic_approve_link', $retval, $r, $args );
    29212982    }
    … …  
    29973058        $retval = $r['link_before'] . $stick_display . $super_display . $r['link_after'];
    29983059
     3060        // Filter & return
    29993061        return apply_filters( 'bbp_get_topic_stick_link', $retval, $r, $args );
    30003062    }
    … …  
    30523114        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-merge-link">' . $r['merge_text'] . '</a>' . $r['link_after'];
    30533115
     3116        // Filter & return
    30543117        return apply_filters( 'bbp_get_topic_merge_link', $retval, $r, $args );
    30553118    }
    … …  
    31123175        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-topic-spam-link">' . $display . '</a>' . $r['link_after'];
    31133176
     3177        // Filter & return
    31143178        return apply_filters( 'bbp_get_topic_spam_link', $retval, $r, $args );
    31153179    }
    … …  
    31623226        $retval   = $r['link_before'] . '<a role="button" href="' . esc_url( $r['uri'] ) . '" class="bbp-topic-reply-link">' . $r['reply_text'] . '</a>' . $r['link_after'];
    31633227
     3228        // Filter & return
    31643229        return apply_filters( 'bbp_get_topic_reply_link', $retval, $r, $args );
    31653230    }
    … …  
    32333298    }
    32343299
     3300    // Filter & return
    32353301    return apply_filters( 'bbp_get_topics_pagination_base', $base );
    32363302}
    … …  
    32793345        }
    32803346
    3281         // Filter and return
     3347        // Filter & return
    32823348        return apply_filters( 'bbp_get_forum_pagination_count', $retstr );
    32833349    }
    … …  
    33083374        }
    33093375
     3376        // Filter & return
    33103377        return apply_filters( 'bbp_get_forum_pagination_links', $bbp->topic_query->pagination_links );
    33113378    }
    … …  
    34643531        <?php
    34653532
    3466         // Return the results
     3533        // Filter & return
    34673534        return apply_filters( 'bbp_get_form_topic_type_dropdown', ob_get_clean(), $r, $args );
    34683535    }
    … …  
    35453612        <?php
    35463613
    3547         // Return the results
     3614        // Filter & return
    35483615        return apply_filters( 'bbp_get_form_topic_status_dropdown', ob_get_clean(), $r, $args );
    35493616    }
    … …  
    36303697        $retstr = $r['before'] . $retstr . $r['after'];
    36313698
    3632         // Return filtered result
     3699        // Filter & return
    36333700        return apply_filters( 'bbp_get_single_topic_description', $retstr, $r, $args );
    36343701    }
    … …  
    36553722     */
    36563723    function bbp_get_topic_tag_tax_id() {
     3724
     3725        // Filter & return
    36573726        return apply_filters( 'bbp_get_topic_tag_tax_id', bbpress()->topic_tag_tax_id );
    36583727    }
    … …  
    36663735 */
    36673736function bbp_get_topic_tag_tax_labels() {
    3668     return apply_filters( 'bbp_get_topic_tag_tax_labels', array(
     3737
     3738    // Filter & return
     3739    return (array) apply_filters( 'bbp_get_topic_tag_tax_labels', array(
    36693740        'name'                       => __( 'Topic Tags',                      'bbpress' ),
    36703741        'singular_name'              => __( 'Topic Tag',                       'bbpress' ),
    … …  
    36923763 */
    36933764function bbp_get_topic_tag_tax_rewrite() {
    3694     return apply_filters( 'bbp_get_topic_tag_tax_rewrite', array(
     3765
     3766    // Filter & return
     3767    return (array) apply_filters( 'bbp_get_topic_tag_tax_rewrite', array(
    36953768        'slug'       => bbp_get_topic_tag_tax_slug(),
    36963769        'with_front' => false
    … …  
    37353808            : 0;
    37363809
     3810        // Filter & return
    37373811        return (int) apply_filters( 'bbp_get_topic_tag_id', (int) $retval, $tag, $term );
    37383812    }
    … …  
    37753849            : '';
    37763850
     3851        // Filter & return
    37773852        return apply_filters( 'bbp_get_topic_tag_name', $retval, $tag, $term );
    37783853    }
    … …  
    38153890            : '';
    38163891
     3892        // Filter & return
    38173893        return apply_filters( 'bbp_get_topic_tag_slug', $retval, $tag, $term );
    38183894    }
    … …  
    38553931            : '';
    38563932
     3933        // Filter & return
    38573934        return apply_filters( 'bbp_get_topic_tag_link', $retval, $tag, $term );
    38583935    }
    … …  
    39033980        }
    39043981
     3982        // Filter & return
    39053983        return apply_filters( 'bbp_get_topic_tag_edit_link', $retval, $tag, $term );
    39063984    }
    … …  
    39514029            : '';
    39524030
     4031        // Filter & return
    39534032        return apply_filters( 'bbp_get_topic_tag_description', $retval, $r, $args, $tag, $term );
    39544033    }
    … …  
    39904069        }
    39914070
     4071        // Filter & return
    39924072        return apply_filters( 'bbp_get_form_topic_title', $topic_title );
    39934073    }
    … …  
    40274107        }
    40284108
     4109        // Filter & return
    40294110        return apply_filters( 'bbp_get_form_topic_content', $topic_content );
    40304111    }
    … …  
    41044185        }
    41054186
     4187        // Filter & return
    41064188        return apply_filters( 'bbp_get_form_topic_tags', $topic_tags );
    41074189    }
    … …  
    41424224        }
    41434225
     4226        // Filter & return
    41444227        return apply_filters( 'bbp_get_form_topic_forum', $topic_forum );
    41454228    }
    … …  
    42004283        $checked = checked( $topic_subscribed, true, false );
    42014284
     4285        // Filter & return
    42024286        return apply_filters( 'bbp_get_form_topic_subscribed', $checked, $topic_subscribed );
    42034287    }
    … …  
    42364320        $checked = checked( $topic_revision, true, false );
    42374321
     4322        // Filter & return
    42384323        return apply_filters( 'bbp_get_form_topic_log_edit', $checked, $topic_revision );
    42394324    }
    … …  
    42694354        }
    42704355
     4356        // Filter & return
    42714357        return apply_filters( 'bbp_get_form_topic_edit_reason', $topic_edit_reason );
    42724358    }
    … …  
    43374423    }
    43384424
     4425    // Filter & return
    43394426    return (bool) apply_filters( 'bbp_show_topic_lock_alert', $retval, $topic_id );
    43404427}
    … …  
    43694456        $text = sprintf( esc_html__( '%1$s is currently editing this topic.', 'bbpress' ), $person );
    43704457
     4458        // Filter & return
    43714459        return apply_filters( 'bbp_get_topic_lock_description', $text, $user_id, $topic_id );
    43724460    }
Note: See TracChangeset for help on using the changeset viewer.