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

    r6437 r6438  
    3333     */
    3434    function bbp_get_reply_post_type() {
     35
     36        // Filter & return
    3537        return apply_filters( 'bbp_get_reply_post_type', bbpress()->reply_post_type );
    3638    }
    … …  
    4446 */
    4547function bbp_get_reply_post_type_labels() {
    46     return apply_filters( 'bbp_get_reply_post_type_labels', array(
     48
     49    // Filter & return
     50    return (array) apply_filters( 'bbp_get_reply_post_type_labels', array(
    4751        'name'                  => __( 'Replies',                   'bbpress' ),
    4852        'menu_name'             => __( 'Replies',                   'bbpress' ),
    … …  
    7579 */
    7680function bbp_get_reply_post_type_rewrite() {
    77     return apply_filters( 'bbp_get_reply_post_type_rewrite', array(
     81
     82    // Filter & return
     83    return (array) apply_filters( 'bbp_get_reply_post_type_rewrite', array(
    7884        'slug'       => bbp_get_reply_slug(),
    7985        'with_front' => false
    … …  
    8995 */
    9096function bbp_get_reply_post_type_supports() {
    91     return apply_filters( 'bbp_get_reply_post_type_supports', array(
     97
     98    // Filter & return
     99    return (array) apply_filters( 'bbp_get_reply_post_type_supports', array(
    92100        'title',
    93101        'editor',
    … …  
    283291    }
    284292
    285     // Return object
     293    // Filter & return
    286294    return apply_filters( 'bbp_has_replies', $bbp->reply_query->have_posts(), $bbp->reply_query );
    287295}
    … …  
    379387        }
    380388
     389        // Filter & return
    381390        return (int) apply_filters( 'bbp_get_reply_id', $bbp_reply_id, $reply_id );
    382391    }
    … …  
    422431    }
    423432
     433    // Filter & return
    424434    return apply_filters( 'bbp_get_reply', $reply, $output, $filter );
    425435}
    … …  
    451461        $reply_id = bbp_get_reply_id( $reply_id );
    452462
     463        // Filter & return
    453464        return apply_filters( 'bbp_get_reply_permalink', get_permalink( $reply_id ), $reply_id );
    454465    }
    … …  
    524535        }
    525536
     537        // Filter & return
    526538        return apply_filters( 'bbp_get_reply_url', $url, $reply_id, $redirect_to );
    527539    }
    … …  
    555567        $title    = get_the_title( $reply_id );
    556568
     569        // Filter & return
    557570        return apply_filters( 'bbp_get_reply_title', $title, $reply_id );
    558571    }
    … …  
    582595        $reply_title = sprintf( __( 'Reply To: %s', 'bbpress' ), $topic_title );
    583596
     597        // Filter & return
    584598        return apply_filters( 'bbp_get_reply_title_fallback', $reply_title, $post_id, $topic_title );
    585599    }
    … …  
    620634        $content = get_post_field( 'post_content', $reply_id );
    621635
     636        // Filter & return
    622637        return apply_filters( 'bbp_get_reply_content', $content, $reply_id );
    623638    }
    … …  
    673688        }
    674689
     690        // Filter & return
    675691        return apply_filters( 'bbp_get_reply_excerpt', $excerpt, $reply_id, $length );
    676692    }
    … …  
    719735        }
    720736
     737        // Filter & return
    721738        return apply_filters( 'bbp_get_reply_post_date', $result, $reply_id, $humanize, $gmt, $date, $time );
    722739    }
    … …  
    744761    $reply_id = bbp_get_reply_id( $reply_id );
    745762
     763    // Filter & return
    746764    return apply_filters( 'bbp_reply_append_revisions', $content . bbp_get_reply_revision_log( $reply_id ), $content, $reply_id );
    747765}
    … …  
    827845        $r .= "\n" . '</ul>' . "\n\n";
    828846
     847        // Filter & return
    829848        return apply_filters( 'bbp_get_reply_revision_log', $r, $reply_id );
    830849    }
    … …  
    846865            $revision_log = empty( $revision_log ) ? array() : $revision_log;
    847866
     867            // Filter & return
    848868            return apply_filters( 'bbp_get_reply_raw_revision_log', $revision_log, $reply_id );
    849869        }
    … …  
    865885    $revisions = wp_get_post_revisions( $reply_id, array( 'order' => 'ASC' ) );
    866886
     887    // Filter & return
    867888    return apply_filters( 'bbp_get_reply_revisions', $revisions, $reply_id );
    868889}
    … …  
    914935    function bbp_get_reply_status( $reply_id = 0 ) {
    915936        $reply_id = bbp_get_reply_id( $reply_id );
     937
     938        // Filter & return
    916939        return apply_filters( 'bbp_get_reply_status', get_post_status( $reply_id ), $reply_id );
    917940    }
    … …  
    932955    $reply_status = bbp_get_reply_status( $reply_id ) === $status;
    933956
     957    // Filter & return
    934958    return (bool) apply_filters( 'bbp_is_reply_published', (bool) $reply_status, $reply_id );
    935959}
    … …  
    950974    $reply_status = bbp_get_reply_status( $reply_id ) === $status;
    951975
     976    // Filter & return
    952977    return (bool) apply_filters( 'bbp_is_reply_spam', (bool) $reply_status, $reply_id );
    953978}
    … …  
    968993    $reply_status = bbp_get_reply_status( $reply_id ) === $status;
    969994
     995    // Filter & return
    970996    return (bool) apply_filters( 'bbp_is_reply_trash', (bool) $reply_status, $reply_id );
    971997}
    … …  
    9871013    $reply_status = bbp_get_reply_status( $reply_id ) === $status;
    9881014
     1015    // Filter & return
    9891016    return (bool) apply_filters( 'bbp_is_reply_pending', (bool) $reply_status, $reply_id );
    9901017}
    … …  
    10061033    $reply_status = bbp_get_reply_status( $reply_id ) === $status;
    10071034
     1035    // Filter & return
    10081036    return (bool) apply_filters( 'bbp_is_reply_private', (bool) $reply_status, $reply_id );
    10091037}
    … …  
    10341062    }
    10351063
     1064    // Filter & return
    10361065    return (bool) apply_filters( 'bbp_is_reply_anonymous', $retval, $reply_id );
    10371066}
    … …  
    10801109        }
    10811110
     1111        // Filter & return
    10821112        return apply_filters( 'bbp_get_reply_author', $author, $reply_id );
    10831113    }
    … …  
    11101140        $author_id = get_post_field( 'post_author', $reply_id );
    11111141
     1142        // Filter & return
    11121143        return (int) apply_filters( 'bbp_get_reply_author_id', $author_id, $reply_id );
    11131144    }
    … …  
    11721203        }
    11731204
     1205        // Filter & return
    11741206        return apply_filters( 'bbp_get_reply_author_display_name', $author_name, $reply_id );
    11751207    }
    … …  
    12171249        }
    12181250
     1251        // Filter & return
    12191252        return apply_filters( 'bbp_get_reply_author_avatar', $author_avatar, $reply_id, $size );
    12201253    }
    … …  
    13271360        }
    13281361
     1362        // Filter & return
    13291363        return apply_filters( 'bbp_get_reply_author_link', $author_link, $r );
    13301364    }
    … …  
    13711405        }
    13721406
     1407        // Filter & return
    13731408        return apply_filters( 'bbp_get_reply_author_url', $author_url, $reply_id );
    13741409    }
    … …  
    14241459        }
    14251460
     1461        // Filter & return
    14261462        return apply_filters( 'bbp_get_reply_author_email', $author_email, $reply_id );
    14271463    }
    … …  
    14741510        }
    14751511
     1512        // Filter & return
    14761513        return apply_filters( 'bbp_get_reply_author_role', $author_role, $r );
    14771514    }
    … …  
    15051542        $topic_id = bbp_get_reply_topic_id( $reply_id );
    15061543
     1544        // Filter & return
    15071545        return apply_filters( 'bbp_get_reply_topic_title', bbp_get_topic_title( $topic_id ), $reply_id );
    15081546    }
    … …  
    15461584        }
    15471585
     1586        // Filter & return
    15481587        return (int) apply_filters( 'bbp_get_reply_topic_id', $topic_id, $reply_id );
    15491588    }
    … …  
    15861625        }
    15871626
     1627        // Filter & return
    15881628        return (int) apply_filters( 'bbp_get_reply_forum_id', $forum_id, $reply_id );
    15891629    }
    … …  
    16641704        }
    16651705
     1706        // Filter & return
    16661707        return (int) apply_filters( 'bbp_get_reply_to', $reply_to, $reply_id );
    16671708    }
    … …  
    17431784        $retval   = $r['link_before'] . '<a role="button" href="' . esc_url( $r['uri'] ) . '" class="bbp-reply-to-link"' . $onclick . '>' . $r['reply_text'] . '</a>' . $r['link_after'];
    17441785
     1786        // Filter & return
    17451787        return apply_filters( 'bbp_get_reply_to_link', $retval, $r, $args );
    17461788    }
    … …  
    17881830        $retval = sprintf( '<a href="%1$s" id="bbp-cancel-reply-to-link"%2$s>%3$s</a>', esc_url( $link ), $style, esc_html( $text ) );
    17891831
     1832        // Filter & return
    17901833        return apply_filters( 'bbp_get_cancel_reply_to_link', $retval, $link, $text );
    17911834    }
    … …  
    18561899        }
    18571900
     1901        // Filter & return
    18581902        return (int) apply_filters( 'bbp_get_reply_position', $reply_position, $reply_id, $topic_id );
    18591903    }
    … …  
    19582002        $retval = $r['before'] . $links . $r['after'];
    19592003
     2004        // Filter & return
    19602005        return apply_filters( 'bbp_get_reply_admin_links', $retval, $r, $args );
    19612006    }
    … …  
    20242069        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-reply-edit-link">' . $r['edit_text'] . '</a>' . $r['link_after'];
    20252070
     2071        // Filter & return
    20262072        return apply_filters( 'bbp_get_reply_edit_link', $retval, $r, $args );
    20272073    }
    … …  
    20792125        $url = bbp_add_view_all( $url );
    20802126
     2127        // Filter & return
    20812128        return apply_filters( 'bbp_get_reply_edit_url', $url, $reply_id );
    20822129    }
    … …  
    21622209        $retval = $r['link_before'] . implode( $r['sep'], $actions ) . $r['link_after'];
    21632210
     2211        // Filter & return
    21642212        return apply_filters( 'bbp_get_reply_trash_link', $retval, $r, $args );
    21652213    }
    … …  
    22252273        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-reply-spam-link">' . $display . '</a>' . $r['link_after'];
    22262274
     2275        // Filter & return
    22272276        return apply_filters( 'bbp_get_reply_spam_link', $retval, $r, $args );
    22282277    }
    … …  
    22952344        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" title="' . $r['split_title'] . '" class="bbp-reply-move-link">' . $r['split_text'] . '</a>' . $r['link_after'];
    22962345
     2346        // Filter & return
    22972347        return apply_filters( 'bbp_get_reply_move_link', $retval, $r, $args );
    22982348    }
    … …  
    23652415        $retval = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" title="' . $r['split_title'] . '" class="bbp-topic-split-link">' . $r['split_text'] . '</a>' . $r['link_after'];
    23662416
     2417        // Filter & return
    23672418        return apply_filters( 'bbp_get_topic_split_link', $retval, $r, $args );
    23682419    }
    … …  
    24282479        $retval  = $r['link_before'] . '<a href="' . esc_url( $uri ) . '" class="bbp-reply-approve-link">' . $display . '</a>' . $r['link_after'];
    24292480
     2481        // Filter & return
    24302482        return apply_filters( 'bbp_get_reply_approve_link', $retval, $r, $args );
    24312483    }
    … …  
    25472599        }
    25482600
    2549         // Filter and return
     2601        // Filter & return
    25502602        return apply_filters( 'bbp_get_topic_pagination_count', $retstr );
    25512603    }
    … …  
    25772629        }
    25782630
     2631        // Filter & return
    25792632        return apply_filters( 'bbp_get_topic_pagination_links', $bbp->reply_query->pagination_links );
    25802633    }
    … …  
    26162669        }
    26172670
     2671        // Filter & return
    26182672        return apply_filters( 'bbp_get_form_reply_content', $reply_content );
    26192673    }
    … …  
    26542708        }
    26552709
     2710        // Filter & return
    26562711        return apply_filters( 'bbp_get_form_reply_to', $reply_to );
    26572712    }
    … …  
    27432798        ) );
    27442799
    2745         // Filter and return
     2800        // Filter & return
    27462801        return apply_filters( 'bbp_get_reply_to_dropdown', $retval, $reply_id, $reply_to, $topic_id );
    27472802    }
    … …  
    27802835        $checked = checked( $reply_revision, true, false );
    27812836
     2837        // Filter & return
    27822838        return apply_filters( 'bbp_get_form_reply_log_edit', $checked, $reply_revision );
    27832839    }
    … …  
    28132869        }
    28142870
     2871        // Filter & return
    28152872        return apply_filters( 'bbp_get_form_reply_edit_reason', $reply_edit_reason );
    28162873    }
    … …  
    28932950        <?php
    28942951
    2895         // Return the results
     2952        // Filter & return
    28962953        return apply_filters( 'bbp_get_form_reply_status_dropdown', ob_get_clean(), $r );
    28972954    }
Note: See TracChangeset for help on using the changeset viewer.