Contents

Code Reference Functions bbp_stick_topic()

bbp_stick_topic( int $topic_id, int $super = false )

Sticks a topic to a forum or front

Description

Parameters

$topic_id

(Optional) Topic id

$super

(Optional) Should we make the topic a super sticky?

Default value: false

Return

(bool) True on success, false on failure

Source

File: bp-forums/topics/functions.php

3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
function bbp_stick_topic( $topic_id = 0, $super = false ) {
    $topic_id = bbp_get_topic_id( $topic_id );
 
    // Bail if a topic is not a topic (prevents revisions as stickies)
    if ( ! bbp_is_topic( $topic_id ) )
        return false;
 
    // We may have a super sticky to which we want to convert into a normal
    // sticky and vice versa; unstick the topic first to avoid any possible error.
    bbp_unstick_topic( $topic_id );
 
    $forum_id = empty( $super ) ? bbp_get_topic_forum_id( $topic_id ) : 0;
    $stickies = bbp_get_stickies( $forum_id );
 
    do_action( 'bbp_stick_topic', $topic_id, $super );
 
    if ( !is_array( $stickies ) ) {
        $stickies   = array( $topic_id );
    } else {
        $stickies[] = $topic_id;
    }
 
    // Pull out duplicates and empties
    $stickies = array_unique( array_filter( $stickies ) );
 
    // Unset incorrectly stuck revisions
    foreach ( (array) $stickies as $key => $id ) {
        if ( ! bbp_is_topic( $id ) ) {
            unset( $stickies[$key] );
        }
    }
 
    // Reset keys
    $stickies = array_values( $stickies );
    $success  = !empty( $super ) ? update_option( '_bbp_super_sticky_topics', $stickies ) : update_post_meta( $forum_id, '_bbp_sticky_topics', $stickies );
 
    do_action( 'bbp_sticked_topic', $topic_id, $super, $success );
 
    return (bool) $success;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
bbPress (r2754) Introduced.
Used By
Used By Description
bp-forums/classes/class-bp-rest-topics-actions-endpoint.php: BP_REST_Topics_Actions_Endpoint::rest_update_sticky()

Update sticky things for the topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::create_item()

Create a topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::update_item()

Update/Edit a topic.
bp-forums/admin/topics.php: BBP_Topics_Admin::attributes_metabox_save()

Pass the topic attributes for processing
bp-forums/admin/topics.php: BBP_Topics_Admin::toggle_topic()

Toggle topic
bp-forums/admin/converter.php: BBP_Converter_Base::convert_topic_stickies()

This method converts old topic stickies to new Forums stickies.
bp-forums/admin/converter.php: BBP_Converter_Base::convert_topic_super_stickies()

This method converts old topic super stickies to new Forums super stickies.
bp-forums/topics/functions.php: bbp_toggle_topic_handler()

Handles the front end opening/closing, spamming/unspamming, sticking/unsticking and trashing/untrashing/deleting of topics
bp-forums/topics/functions.php: bbp_move_topic_handler()

Handle the moving of a topic from one forum to another. This includes walking up the old and new branches and updating the counts.
bp-forums/topics/functions.php: bbp_new_topic_handler()

Handles the front end topic submission
bp-forums/topics/functions.php: bbp_edit_topic_handler()

Handles the front end edit topic submission
Show 6 more used by Hide more used by

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.