bbp_get_topic_revision_log( int $topic_id )

Return the formatted revision log of the topic

Description

Parameters

$topic_id: (Optional) Topic id

Return

(string) Revision log of the topic

Source

function bbp_get_topic_revision_log( $topic_id = 0 ) {
    // Create necessary variables
    $topic_id     = bbp_get_topic_id( $topic_id );
    $revision_log = bbp_get_topic_raw_revision_log( $topic_id );
 
    if ( empty( $topic_id ) || empty( $revision_log ) || !is_array( $revision_log ) )
        return false;
 
    $revisions = bbp_get_topic_revisions( $topic_id );
    if ( empty( $revisions ) )
        return false;
 
    $r = "\n\n" . '<ul id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '" class="bbp-topic-revision-log">' . "\n\n";
 
    // Loop through revisions
    foreach ( (array) $revisions as $revision ) {
 
        if ( empty( $revision_log[$revision->ID] ) ) {
            $author_id = $revision->post_author;
            $reason    = '';
        } else {
            $author_id = $revision_log[$revision->ID]['author'];
            $reason    = $revision_log[$revision->ID]['reason'];
        }
 
        $author = bbp_get_author_link( array( 'size' => 14, 'link_text' => bbp_get_topic_author_display_name( $revision->ID ), 'post_id' => $revision->ID ) );
        $since  = bbp_get_time_since( bbp_convert_date( $revision->post_modified ) );
 
        $r .= "\t" . '<li id="bbp-topic-revision-log-' . esc_attr( $topic_id ) . '-item-' . esc_attr( $revision->ID ) . '" class="bbp-topic-revision-log-item">' . "\n";
        if ( !empty( $reason ) ) {
            $r .= "\t\t" . sprintf( __( 'This discussion was modified %1$s by %2$s. Reason: %3$s', 'buddyboss' ), esc_html( $since ), $author, esc_html( $reason ) ) . "\n";
        } else {
            $r .= "\t\t" . sprintf( __( 'This discussion was modified %1$s by %2$s.', 'buddyboss' ), esc_html( $since ), $author ) . "\n";
        }
        $r .= "\t" . '</li>' . "\n";
 
    }
 
    $r .= "\n" . '</ul>' . "\n\n";
 
    return apply_filters( 'bbp_get_topic_revision_log', $r, $topic_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
bbPress (r2782)	Introduced.

Uses

Uses
Uses	Description
bp-forums/topics/template.php: bbp_get_topic_author_display_name()	Return the author display_name of the topic
bp-forums/topics/template.php: bbp_get_topic_revisions()	Return the revisions of the topic
bp-forums/topics/template.php: bbp_get_topic_raw_revision_log()	Return the raw revision log of the topic
bp-forums/topics/template.php: bbp_get_topic_id()	Return the topic id
bp-forums/users/template.php: bbp_get_author_link()	Return the author link of the post
bp-forums/common/functions.php: bbp_get_time_since()	Return formatted time to display human readable time difference.
bp-forums/common/functions.php: bbp_convert_date()	Convert time supplied from database query into specified date format.

Show 2 more uses Hide more uses

Used By
Used By	Description
bp-forums/topics/template.php: bbp_topic_content_append_revisions()	Append revisions to the topic content
bp-forums/topics/template.php: bbp_topic_revision_log()	Output the revision log of the topic
bp-forums/replies/template.php: bbp_get_reply_revision_log()	Return the formatted revision log of the reply

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents