Contents

Code Reference Functions bp_set_object_terms()

bp_set_object_terms( int $object_id, string|array $terms, string $taxonomy, bool $append = false )

Set taxonomy terms on a BuddyPress object.

Description

See also

Parameters

$object_id

(Required) Object ID.

$terms

(Required) Term or terms to set.

$taxonomy

(Required) Taxonomy name.

$append

(Optional) True to append terms to existing terms. Default: false.

Default value: false

Return

(array) Array of term taxonomy IDs.

Source

File: bp-core/bp-core-taxonomy.php

90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
function bp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
    $site_id = bp_get_taxonomy_term_site_id( $taxonomy );
 
    $switched = false;
    if ( $site_id !== get_current_blog_id() ) {
        switch_to_blog( $site_id );
        bp_register_taxonomies();
        $switched = true;
    }
 
    $tt_ids = wp_set_object_terms( $object_id, $terms, $taxonomy, $append );
 
    if ( $switched ) {
        restore_current_blog();
    }
 
    /**
     * Fires when taxonomy terms have been set on BuddyPress objects.
     *
     * @since BuddyPress 2.7.0
     *
     * @param int    $object_id Object ID.
     * @param array  $terms     Term or terms to remove.
     * @param array  $tt_ids    Array of term taxonomy IDs.
     * @param string $taxonomy  Taxonomy name.
     */
    do_action( 'bp_set_object_terms', $object_id, $terms, $tt_ids, $taxonomy );
 
    return $tt_ids;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.2.0 Introduced.

Uses

Uses
Uses Description
bp-core/bp-core-taxonomy.php: bp_get_taxonomy_term_site_id()

Gets the ID of the site that BP should use for taxonomy term storage.
bp-core/bp-core-taxonomy.php: bp_set_object_terms

Fires when taxonomy terms have been set on BuddyPress objects.
bp-core/bp-core-dependency.php: bp_register_taxonomies()

Fire the ‘bp_register_taxonomies’ action, where plugins should register taxonomies.
bp-core/bp-core-wpabstraction.php: switch_to_blog()

Switch to specified blog.
bp-core/bp-core-wpabstraction.php: restore_current_blog()

Restore current blog.

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.