File: //var/www/intranet.kauko.lt/wp-content/plugins/buddypress/bp-core/bp-core-taxonomy.php
<?php
/**
* BuddyPress taxonomy functions.
*
* Most BuddyPress taxonomy functions are wrappers for their WordPress counterparts.
* Because BuddyPress can be activated in various ways in a network environment, we
* must switch to the root blog before using the WP functions.
*
* @package BuddyPress
* @subpackage Core
* @since 2.2.0
*/
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
/**
* Returns default BuddyPress taxonomies.
*
* @since 7.0.0
*
* @return array The BuddyPress default taxonomies.
*/
function bp_get_default_taxonomies() {
$taxonomies = array(
// Member Type.
bp_get_member_type_tax_name() => array(
'object' => 'user',
'component' => 'members',
'args' => bp_get_member_type_tax_args(),
),
// Email type.
bp_get_email_tax_type() => array(
'object' => bp_get_email_post_type(),
'component' => 'core',
'args' => bp_get_email_tax_type_args(),
),
);
/**
* This filter should only be used by built-in BuddyPress Components.
*
* @since 7.0.0
*
* @param array $taxonomies The taxonomy arguments used for WordPress registration.
*/
return apply_filters( 'bp_get_default_taxonomies', $taxonomies );
}
/**
* Register our default taxonomies.
*
* @since 2.2.0
*/
function bp_register_default_taxonomies() {
$taxonomies = bp_get_default_taxonomies();
foreach ( $taxonomies as $taxonomy_name => $taxonomy_params ) {
if ( ! isset( $taxonomy_params['object'] ) || ! isset( $taxonomy_params['args'] ) ) {
continue;
}
register_taxonomy(
$taxonomy_name,
$taxonomy_params['object'],
$taxonomy_params['args']
);
}
}
add_action( 'bp_register_taxonomies', 'bp_register_default_taxonomies' );
/**
* Gets the ID of the site that BP should use for taxonomy term storage.
*
* Defaults to the root blog ID.
*
* @since 2.6.0
*
* @param string $taxonomy Taxonomy slug to check for.
* @return int
*/
function bp_get_taxonomy_term_site_id( $taxonomy = '' ) {
$site_id = bp_get_root_blog_id();
/**
* Filters the ID of the site where BP should store taxonomy terms.
*
* @since 2.6.0
*
* @param int $site_id Site ID to cehck for.
* @param string $taxonomy Taxonomy slug to check for.
*/
return (int) apply_filters( 'bp_get_taxonomy_term_site_id', $site_id, $taxonomy );
}
/**
* Set taxonomy terms on a BuddyPress object.
*
* @since 2.2.0
*
* @see wp_set_object_terms() for a full description of function and parameters.
*
* @param int $object_id Object ID.
* @param string|array $terms Term or terms to set.
* @param string $taxonomy Taxonomy name.
* @param bool $append Optional. True to append terms to existing terms. Default: false.
* @return array Array of term taxonomy IDs.
*/
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 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;
}
/**
* Get taxonomy terms for a BuddyPress object.
*
* @since 2.2.0
*
* @see wp_get_object_terms() for a full description of function and parameters.
*
* @param int|array $object_ids ID or IDs of objects.
* @param string|array $taxonomies Name or names of taxonomies to match.
* @param array $args See {@see wp_get_object_terms()}.
* @return array
*/
function bp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
// Different taxonomies must be stored on different sites.
$taxonomy_site_map = array();
foreach ( (array) $taxonomies as $taxonomy ) {
$taxonomy_site_id = bp_get_taxonomy_term_site_id( $taxonomy );
$taxonomy_site_map[ $taxonomy_site_id ][] = $taxonomy;
}
$retval = array();
foreach ( $taxonomy_site_map as $taxonomy_site_id => $site_taxonomies ) {
$switched = false;
if ( $taxonomy_site_id !== get_current_blog_id() ) {
switch_to_blog( $taxonomy_site_id );
bp_register_taxonomies();
$switched = true;
}
$site_terms = wp_get_object_terms( $object_ids, $site_taxonomies, $args );
$retval = array_merge( $retval, $site_terms );
if ( $switched ) {
restore_current_blog();
}
}
return $retval;
}
/**
* Remove taxonomy terms on a BuddyPress object.
*
* @since 2.3.0
*
* @see wp_remove_object_terms() for a full description of function and parameters.
*
* @param int $object_id Object ID.
* @param string|array $terms Term or terms to remove.
* @param string $taxonomy Taxonomy name.
* @return bool|WP_Error True on success, false or WP_Error on failure.
*/
function bp_remove_object_terms( $object_id, $terms, $taxonomy ) {
$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;
}
$retval = wp_remove_object_terms( $object_id, $terms, $taxonomy );
if ( $switched ) {
restore_current_blog();
}
/**
* Fires when taxonomy terms have been removed from BuddyPress objects.
*
* @since 2.7.0
*
* @param int $object_id Object ID.
* @param array $terms Term or terms to remove.
* @param string $taxonomy Taxonomy name.
*/
do_action( 'bp_remove_object_terms', $object_id, $terms, $taxonomy );
return $retval;
}
/**
* Retrieve IDs of objects in valid taxonomies and terms for BuddyPress-related taxonomies.
*
* Note that object IDs are from the `bp_get_taxonomy_term_site_id()`, which on some
* multisite configurations may not be the same as the current site.
*
* @since 2.7.0
*
* @see get_objects_in_term() for a full description of function and parameters.
*
* @param int|array $term_ids Term id or array of term ids of terms that will be used.
* @param string|array $taxonomies String of taxonomy name or Array of string values of taxonomy names.
* @param array|string $args Change the order of the object_ids, either ASC or DESC.
*
* @return WP_Error|array If the taxonomy does not exist, then WP_Error will be returned. On success,
* the array can be empty, meaning that there are no $object_ids found. When
* object IDs are found, an array of those IDs will be returned.
*/
function bp_get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
// Different taxonomies may be stored on different sites.
$taxonomy_site_map = array();
foreach ( (array) $taxonomies as $taxonomy ) {
$taxonomy_site_id = bp_get_taxonomy_term_site_id( $taxonomy );
$taxonomy_site_map[ $taxonomy_site_id ][] = $taxonomy;
}
$retval = array();
foreach ( $taxonomy_site_map as $taxonomy_site_id => $site_taxonomies ) {
$switched = false;
if ( $taxonomy_site_id !== get_current_blog_id() ) {
switch_to_blog( $taxonomy_site_id );
bp_register_taxonomies();
$switched = true;
}
$site_objects = get_objects_in_term( $term_ids, $site_taxonomies, $args );
$retval = array_merge( $retval, $site_objects );
if ( $switched ) {
restore_current_blog();
}
}
return $retval;
}
/**
* Get term data for terms in BuddyPress taxonomies.
*
* Note that term data is from the `bp_get_taxonomy_term_site_id()`, which on some
* multisite configurations may not be the same as the current site.
*
* @since 2.7.0
*
* @see get_term_by() for a full description of function and parameters.
*
* @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'.
* @param string|int $value Search for this term value.
* @param string $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
* @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N.
* @param string $filter Optional, default is raw or no WordPress defined filter will applied.
*
* @return WP_Term|bool WP_Term instance on success. Will return false if `$taxonomy` does not exist
* or `$term` was not found.
*/
function bp_get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
$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;
}
$term = get_term_by( $field, $value, $taxonomy, $output, $filter );
if ( $switched ) {
restore_current_blog();
}
return $term;
}
/**
* Add a new taxonomy term to the database.
*
* @since 7.0.0
*
* @param string $term The BP term name to add.
* @param string $taxonomy The BP taxonomy to which to add the BP term.
* @param array $args {
* Optional. Array of arguments for inserting a BP term.
* @type string $description The term description. Default empty string.
* @type string $slug The term slug to use. Default empty string.
* @type array $metas The term metas to add. Default empty array.
* }
* @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
* WP_Error otherwise.
*/
function bp_insert_term( $term, $taxonomy = '', $args = array() ) {
if ( ! taxonomy_exists( $taxonomy ) ) {
return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.', 'buddypress' ) );
}
$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;
}
$term_metas = array();
if ( isset( $args['metas'] ) ) {
$term_metas = (array) $args['metas'];
unset( $args['metas'] );
}
/**
* Fires before a BP Term is added to the database.
*
* @since 7.0.0
*
* @param string $term The BP term name to add.
* @param string $taxonomy The BP taxonomy to which to add the term.
* @param array $args Array of arguments for inserting a BP term.
*/
do_action( 'bp_before_insert_term', $term, $taxonomy, $args );
$tt_id = wp_insert_term( $term, $taxonomy, $args );
if ( is_wp_error( $tt_id ) ) {
return $tt_id;
}
$term_id = reset( $tt_id );
if ( $term_metas ) {
bp_update_type_metadata( $term_id, $taxonomy, $term_metas );
}
if ( $switched ) {
restore_current_blog();
}
/**
* Fires when taxonomy terms have been set on BuddyPress objects.
*
* @since 7.0.0
*
* @param array $tt_ids An array containing the `term_id` and `term_taxonomy_id`.
* @param string $taxonomy Taxonomy name.
* @param array $term_metas The term metadata.
*/
do_action( 'bp_insert_term', $tt_id, $taxonomy, $term_metas );
return $tt_id;
}
/**
* Get taxonomy BP Terms from the database.
*
* @since 7.0.0
*
* @param array $args {
* Array of arguments to query BP Terms.
* @see `get_terms()` for full description of arguments in case of a member type.
* }
* @return array The list of terms matching arguments.
*/
function bp_get_terms( $args = array() ) {
$args = bp_parse_args(
$args,
array(
'taxonomy' => '',
'number' => '',
'hide_empty' => false,
),
'get_terms'
);
if ( ! $args['taxonomy'] ) {
return array();
}
$site_id = bp_get_taxonomy_term_site_id( $args['taxonomy'] );
$switched = false;
if ( $site_id !== get_current_blog_id() ) {
switch_to_blog( $site_id );
bp_register_taxonomies();
$switched = true;
}
$terms = get_terms( $args );
if ( $switched ) {
restore_current_blog();
}
/**
* Filter here to modify the BP Terms found into the database.
*
* @since 7.0.0
*
* @param array $terms The list of terms matching arguments.
* @param array $args Array of arguments used to query BP Terms.
*/
return apply_filters(
'bp_get_terms',
$terms,
$args
);
}
/**
* Deletes a BP Term.
*
* @since 7.0.0
*
* @param int $term_id The BP Term ID. Required.
* @param string $taxonomy The BP Taxonomy Name. Required.
* @return bool|WP_Error True on success, WP_Error on failure.
*/
function bp_delete_term( $term_id = 0, $taxonomy = '' ) {
if ( ! $term_id || ! $taxonomy ) {
return new WP_Error( 'missing_arguments', __( 'Sorry, the term ID and the taxonomy are required arguments.', 'buddypress' ) );
}
$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;
}
/**
* Fires before a BP Term is deleted from the database.
*
* @since 7.0.0
*
* @param int $term_id The BP Term ID.
* @param string $taxonomy The BP Taxonomy Name.
*/
do_action( 'bp_before_delete_term', $term_id, $taxonomy );
$deleted = wp_delete_term( $term_id, $taxonomy );
if ( $switched ) {
restore_current_blog();
}
if ( is_wp_error( $deleted ) ) {
return $deleted;
}
if ( false === $deleted ) {
return new WP_Error( 'inexistant_term', __( 'Sorry, the term does not exist.', 'buddypress' ) );
}
if ( 0 === $deleted ) {
return new WP_Error( 'default_term', __( 'Sorry, the default term cannot be deleted.', 'buddypress' ) );
}
/**
* Fires once a BP Term has been deleted from the database.
*
* @since 7.0.0
*
* @param boolean $deleted True.
* @param int $term_id The deleted BP Term ID.
* @param string $taxonomy The BP Taxonomy Name of the deleted BP Term ID.
*/
do_action( 'bp_delete_term', $deleted, $term_id, $taxonomy );
return $deleted;
}