<?php
/**
+ * Core Taxonomy API
+ *
* @package WordPress
* @subpackage Taxonomy
- * @since 2.3
*/
//
//
/**
- * Default Taxonomy Objects
- * @since 2.3
- * @global array $wp_taxonomies
+ * Creates the initial taxonomies.
+ *
+ * This function fires twice: in wp-settings.php before plugins are loaded (for
+ * backward compatibility reasons), and again on the {@see 'init'} action. We must
+ * avoid registering rewrite rules before the {@see 'init'} action.
+ *
+ * @since 2.8.0
+ *
+ * @global WP_Rewrite $wp_rewrite The WordPress rewrite class.
*/
-$wp_taxonomies = array();
-$wp_taxonomies['category'] = (object) array('name' => 'category', 'object_type' => 'post', 'hierarchical' => true, 'update_count_callback' => '_update_post_term_count');
-$wp_taxonomies['post_tag'] = (object) array('name' => 'post_tag', 'object_type' => 'post', 'hierarchical' => false, 'update_count_callback' => '_update_post_term_count');
-$wp_taxonomies['link_category'] = (object) array('name' => 'link_category', 'object_type' => 'link', 'hierarchical' => false);
+function create_initial_taxonomies() {
+ global $wp_rewrite;
+
+ if ( ! did_action( 'init' ) ) {
+ $rewrite = array( 'category' => false, 'post_tag' => false, 'post_format' => false );
+ } else {
+
+ /**
+ * Filters the post formats rewrite base.
+ *
+ * @since 3.1.0
+ *
+ * @param string $context Context of the rewrite base. Default 'type'.
+ */
+ $post_format_base = apply_filters( 'post_format_rewrite_base', 'type' );
+ $rewrite = array(
+ 'category' => array(
+ 'hierarchical' => true,
+ 'slug' => get_option('category_base') ? get_option('category_base') : 'category',
+ 'with_front' => ! get_option('category_base') || $wp_rewrite->using_index_permalinks(),
+ 'ep_mask' => EP_CATEGORIES,
+ ),
+ 'post_tag' => array(
+ 'hierarchical' => false,
+ 'slug' => get_option('tag_base') ? get_option('tag_base') : 'tag',
+ 'with_front' => ! get_option('tag_base') || $wp_rewrite->using_index_permalinks(),
+ 'ep_mask' => EP_TAGS,
+ ),
+ 'post_format' => $post_format_base ? array( 'slug' => $post_format_base ) : false,
+ );
+ }
+
+ register_taxonomy( 'category', 'post', array(
+ 'hierarchical' => true,
+ 'query_var' => 'category_name',
+ 'rewrite' => $rewrite['category'],
+ 'public' => true,
+ 'show_ui' => true,
+ 'show_admin_column' => true,
+ '_builtin' => true,
+ ) );
+
+ register_taxonomy( 'post_tag', 'post', array(
+ 'hierarchical' => false,
+ 'query_var' => 'tag',
+ 'rewrite' => $rewrite['post_tag'],
+ 'public' => true,
+ 'show_ui' => true,
+ 'show_admin_column' => true,
+ '_builtin' => true,
+ ) );
+
+ register_taxonomy( 'nav_menu', 'nav_menu_item', array(
+ 'public' => false,
+ 'hierarchical' => false,
+ 'labels' => array(
+ 'name' => __( 'Navigation Menus' ),
+ 'singular_name' => __( 'Navigation Menu' ),
+ ),
+ 'query_var' => false,
+ 'rewrite' => false,
+ 'show_ui' => false,
+ '_builtin' => true,
+ 'show_in_nav_menus' => false,
+ ) );
+
+ register_taxonomy( 'link_category', 'link', array(
+ 'hierarchical' => false,
+ 'labels' => array(
+ 'name' => __( 'Link Categories' ),
+ 'singular_name' => __( 'Link Category' ),
+ 'search_items' => __( 'Search Link Categories' ),
+ 'popular_items' => null,
+ 'all_items' => __( 'All Link Categories' ),
+ 'edit_item' => __( 'Edit Link Category' ),
+ 'update_item' => __( 'Update Link Category' ),
+ 'add_new_item' => __( 'Add New Link Category' ),
+ 'new_item_name' => __( 'New Link Category Name' ),
+ 'separate_items_with_commas' => null,
+ 'add_or_remove_items' => null,
+ 'choose_from_most_used' => null,
+ ),
+ 'capabilities' => array(
+ 'manage_terms' => 'manage_links',
+ 'edit_terms' => 'manage_links',
+ 'delete_terms' => 'manage_links',
+ 'assign_terms' => 'manage_links',
+ ),
+ 'query_var' => false,
+ 'rewrite' => false,
+ 'public' => false,
+ 'show_ui' => true,
+ '_builtin' => true,
+ ) );
+
+ register_taxonomy( 'post_format', 'post', array(
+ 'public' => true,
+ 'hierarchical' => false,
+ 'labels' => array(
+ 'name' => _x( 'Format', 'post format' ),
+ 'singular_name' => _x( 'Format', 'post format' ),
+ ),
+ 'query_var' => true,
+ 'rewrite' => $rewrite['post_format'],
+ 'show_ui' => false,
+ '_builtin' => true,
+ 'show_in_nav_menus' => current_theme_supports( 'post-formats' ),
+ ) );
+}
/**
- * get_object_taxonomies() - Return all of the taxonomy names that are of $object_type
+ * Retrieves a list of registered taxonomy names or objects.
*
- * It appears that this function can be used to find all of the names inside of
- * $wp_taxonomies global variable.
+ * @since 3.0.0
*
- * <code><?php $taxonomies = get_object_taxonomies('post'); ?></code>
- * Should result in <code>Array('category', 'post_tag')</code>
+ * @global array $wp_taxonomies The registered taxonomies.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @param array $args Optional. An array of `key => value` arguments to match against the taxonomy objects.
+ * Default empty array.
+ * @param string $output Optional. The type of output to return in the array. Accepts either taxonomy 'names'
+ * or 'objects'. Default 'names'.
+ * @param string $operator Optional. The logical operation to perform. Accepts 'and' or 'or'. 'or' means only
+ * one element from the array needs to match; 'and' means all elements must match.
+ * Default 'and'.
+ * @return array A list of taxonomy names or objects.
+ */
+function get_taxonomies( $args = array(), $output = 'names', $operator = 'and' ) {
+ global $wp_taxonomies;
+
+ $field = ('names' == $output) ? 'name' : false;
+
+ return wp_filter_object_list($wp_taxonomies, $args, $operator, $field);
+}
+
+/**
+ * Return the names or objects of the taxonomies which are registered for the requested object or object type, such as
+ * a post object or post type name.
+ *
+ * Example:
+ *
+ * $taxonomies = get_object_taxonomies( 'post' );
+ *
+ * This results in:
+ *
+ * Array( 'category', 'post_tag' )
*
- * @uses $wp_taxonomies
+ * @since 2.3.0
*
- * @param array|string|object $object Name of the type of taxonomy object, or an object (row from posts)
+ * @global array $wp_taxonomies The registered taxonomies.
+ *
+ * @param array|string|WP_Post $object Name of the type of taxonomy object, or an object (row from posts)
+ * @param string $output Optional. The type of output to return in the array. Accepts either
+ * taxonomy 'names' or 'objects'. Default 'names'.
* @return array The names of all taxonomy of $object_type.
*/
-function get_object_taxonomies($object) {
+function get_object_taxonomies( $object, $output = 'names' ) {
global $wp_taxonomies;
if ( is_object($object) ) {
$object = (array) $object;
$taxonomies = array();
- foreach ( $wp_taxonomies as $taxonomy ) {
- if ( array_intersect($object, (array) $taxonomy->object_type) )
- $taxonomies[] = $taxonomy->name;
+ foreach ( (array) $wp_taxonomies as $tax_name => $tax_obj ) {
+ if ( array_intersect($object, (array) $tax_obj->object_type) ) {
+ if ( 'names' == $output )
+ $taxonomies[] = $tax_name;
+ else
+ $taxonomies[ $tax_name ] = $tax_obj;
+ }
}
return $taxonomies;
}
/**
- * get_taxonomy() - Returns the taxonomy object of $taxonomy.
+ * Retrieves the taxonomy object of $taxonomy.
*
* The get_taxonomy function will first check that the parameter string given
* is a taxonomy object and if it is, it will return it.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses $wp_taxonomies
- * @uses is_taxonomy() Checks whether taxonomy exists
+ * @global array $wp_taxonomies The registered taxonomies.
*
- * @param string $taxonomy Name of taxonomy object to return
- * @return object|bool The Taxonomy Object or false if $taxonomy doesn't exist
+ * @param string $taxonomy Name of taxonomy object to return.
+ * @return object|false The Taxonomy Object or false if $taxonomy doesn't exist.
*/
function get_taxonomy( $taxonomy ) {
global $wp_taxonomies;
- if ( ! is_taxonomy($taxonomy) )
+ if ( ! taxonomy_exists( $taxonomy ) )
return false;
return $wp_taxonomies[$taxonomy];
}
/**
- * is_taxonomy() - Checks that the taxonomy name exists
+ * Checks that the taxonomy name exists.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * Formerly is_taxonomy(), introduced in 2.3.0.
+ *
+ * @since 3.0.0
*
- * @uses $wp_taxonomies
+ * @global array $wp_taxonomies The registered taxonomies.
*
- * @param string $taxonomy Name of taxonomy object
- * @return bool Whether the taxonomy exists or not.
+ * @param string $taxonomy Name of taxonomy object.
+ * @return bool Whether the taxonomy exists.
*/
-function is_taxonomy( $taxonomy ) {
+function taxonomy_exists( $taxonomy ) {
global $wp_taxonomies;
- return isset($wp_taxonomies[$taxonomy]);
+ return isset( $wp_taxonomies[$taxonomy] );
}
/**
- * is_taxonomy_hierarchical() - Whether the taxonomy object is hierarchical
+ * Whether the taxonomy object is hierarchical.
*
- * Checks to make sure that the taxonomy is an object first. Then Gets the object, and finally
- * returns the hierarchical value in the object.
+ * Checks to make sure that the taxonomy is an object first. Then Gets the
+ * object, and finally returns the hierarchical value in the object.
*
* A false return value might also mean that the taxonomy does not exist.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses is_taxonomy() Checks whether taxonomy exists
- * @uses get_taxonomy() Used to get the taxonomy object
- *
- * @param string $taxonomy Name of taxonomy object
- * @return bool Whether the taxonomy is hierarchical
+ * @param string $taxonomy Name of taxonomy object.
+ * @return bool Whether the taxonomy is hierarchical.
*/
function is_taxonomy_hierarchical($taxonomy) {
- if ( ! is_taxonomy($taxonomy) )
+ if ( ! taxonomy_exists($taxonomy) )
return false;
$taxonomy = get_taxonomy($taxonomy);
}
/**
- * register_taxonomy() - Create or modify a taxonomy object. Do not use before init.
+ * Creates or modifies a taxonomy object.
*
- * A simple function for creating or modifying a taxonomy object based on the parameters given.
- * The function will accept an array (third optional parameter), along with strings for the
- * taxonomy name and another string for the object type.
+ * Note: Do not use before the {@see 'init'} hook.
*
- * Nothing is returned, so expect error maybe or use is_taxonomy() to check whether taxonomy exists.
+ * A simple function for creating or modifying a taxonomy object based on the
+ * parameters given. The function will accept an array (third optional
+ * parameter), along with strings for the taxonomy name and another string for
+ * the object type.
*
- * Optional $args contents:
- * hierarachical - has some defined purpose at other parts of the API and is a boolean value.
- * update_count_callback - works much like a hook, in that it will be called when the count is updated.
- * rewrite - false to prevent rewrite, or array('slug'=>$slug) to customize permastruct; default will use $taxonomy as slug
- * query_var - false to prevent queries, or string to customize query var (?$query_var=$term); default will use $taxonomy as query var
+ * @since 2.3.0
+ * @since 4.2.0 Introduced `show_in_quick_edit` argument.
+ * @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
+ * @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end.
+ * @since 4.5.0 Introduced `publicly_queryable` argument.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wp_taxonomies Inserts new taxonomy object into the list
- * @uses $wp_rewrite Adds rewrite tags and permastructs
- * @uses $wp Adds query vars
+ * @global array $wp_taxonomies Registered taxonomies.
+ * @global WP $wp WP instance.
*
- * @param string $taxonomy Name of taxonomy object
+ * @param string $taxonomy Taxonomy key, must not exceed 32 characters.
* @param array|string $object_type Name of the object type for the taxonomy object.
- * @param array|string $args See above description for the two keys values.
+ * @param array|string $args {
+ * Optional. Array or query string of arguments for registering a taxonomy.
+ *
+ * @type string $label Name of the taxonomy shown in the menu. Usually plural. If not set,
+ * `$labels['name']` will be used.
+ * @type array $labels An array of labels for this taxonomy. By default, Tag labels are used for
+ * non-hierarchical taxonmies, and Category labels are used for hierarchical
+ * taxonomies. See accepted values in get_taxonomy_labels().
+ * Default empty array.
+ * @type string $description A short descriptive summary of what the taxonomy is for. Default empty.
+ * @type bool $public Whether a taxonomy is intended for use publicly either via
+ * the admin interface or by front-end users. The default settings
+ * of `$publicly_queryable`, `$show_ui`, and `$show_in_nav_menus`
+ * are inherited from `$public`.
+ * @type bool $publicly_queryable Whether the taxonomy is publicly queryable.
+ * If not set, the default is inherited from `$public`
+ * @type bool $hierarchical Whether the taxonomy is hierarchical. Default false.
+ * @type bool $show_ui Whether to generate and allow a UI for managing terms in this taxonomy in
+ * the admin. If not set, the default is inherited from `$public`
+ * (default true).
+ * @type bool $show_in_menu Whether to show the taxonomy in the admin menu. If true, the taxonomy is
+ * shown as a submenu of the object type menu. If false, no menu is shown.
+ * `$show_ui` must be true. If not set, default is inherited from `$show_ui`
+ * (default true).
+ * @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not
+ * set, the default is inherited from `$public` (default true).
+ * @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
+ * the default is inherited from `$show_ui` (default true).
+ * @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
+ * the default is inherited from `$show_ui` (default true).
+ * @type bool $show_admin_column Whether to display a column for the taxonomy on its post type listing
+ * screens. Default false.
+ * @type bool|callable $meta_box_cb Provide a callback function for the meta box display. If not set,
+ * post_categories_meta_box() is used for hierarchical taxonomies, and
+ * post_tags_meta_box() is used for non-hierarchical. If false, no meta
+ * box is shown.
+ * @type array $capabilities {
+ * Array of capabilities for this taxonomy.
+ *
+ * @type string $manage_terms Default 'manage_categories'.
+ * @type string $edit_terms Default 'manage_categories'.
+ * @type string $delete_terms Default 'manage_categories'.
+ * @type string $assign_terms Default 'edit_posts'.
+ * }
+ * @type bool|array $rewrite {
+ * Triggers the handling of rewrites for this taxonomy. Default true, using $taxonomy as slug. To prevent
+ * rewrite, set to false. To specify rewrite rules, an array can be passed with any of these keys:
+ *
+ * @type string $slug Customize the permastruct slug. Default `$taxonomy` key.
+ * @type bool $with_front Should the permastruct be prepended with WP_Rewrite::$front. Default true.
+ * @type bool $hierarchical Either hierarchical rewrite tag or not. Default false.
+ * @type int $ep_mask Assign an endpoint mask. Default `EP_NONE`.
+ * }
+ * @type string $query_var Sets the query var key for this taxonomy. Default `$taxonomy` key. If
+ * false, a taxonomy cannot be loaded at `?{query_var}={term_slug}`. If a
+ * string, the query `?{query_var}={term_slug}` will be valid.
+ * @type callable $update_count_callback Works much like a hook, in that it will be called when the count is
+ * updated. Default _update_post_term_count() for taxonomies attached
+ * to post types, which confirms that the objects are published before
+ * counting them. Default _update_generic_term_count() for taxonomies
+ * attached to other object types, such as users.
+ * @type bool $_builtin This taxonomy is a "built-in" taxonomy. INTERNAL USE ONLY!
+ * Default false.
+ * }
+ * @return WP_Error|void WP_Error, if errors.
*/
function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
- global $wp_taxonomies, $wp_rewrite, $wp;
+ global $wp_taxonomies, $wp;
- $defaults = array('hierarchical' => false, 'update_count_callback' => '', 'rewrite' => true, 'query_var' => true);
- $args = wp_parse_args($args, $defaults);
+ if ( ! is_array( $wp_taxonomies ) )
+ $wp_taxonomies = array();
+
+ $args = wp_parse_args( $args );
+
+ /**
+ * Filters the arguments for registering a taxonomy.
+ *
+ * @since 4.4.0
+ *
+ * @param array $args Array of arguments for registering a taxonomy.
+ * @param string $taxonomy Taxonomy key.
+ * @param array $object_type Array of names of object types for the taxonomy.
+ */
+ $args = apply_filters( 'register_taxonomy_args', $args, $taxonomy, (array) $object_type );
- if ( false !== $args['query_var'] && !empty($wp) ) {
- if ( empty($args['query_var']) )
+ $defaults = array(
+ 'labels' => array(),
+ 'description' => '',
+ 'public' => true,
+ 'publicly_queryable' => null,
+ 'hierarchical' => false,
+ 'show_ui' => null,
+ 'show_in_menu' => null,
+ 'show_in_nav_menus' => null,
+ 'show_tagcloud' => null,
+ 'show_in_quick_edit' => null,
+ 'show_admin_column' => false,
+ 'meta_box_cb' => null,
+ 'capabilities' => array(),
+ 'rewrite' => true,
+ 'query_var' => $taxonomy,
+ 'update_count_callback' => '',
+ '_builtin' => false,
+ );
+ $args = array_merge( $defaults, $args );
+
+ if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) {
+ _doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2.0' );
+ return new WP_Error( 'taxonomy_length_invalid', __( 'Taxonomy names must be between 1 and 32 characters in length.' ) );
+ }
+
+ // If not set, default to the setting for public.
+ if ( null === $args['publicly_queryable'] ) {
+ $args['publicly_queryable'] = $args['public'];
+ }
+
+ // Non-publicly queryable taxonomies should not register query vars, except in the admin.
+ if ( false !== $args['query_var'] && ( is_admin() || false !== $args['publicly_queryable'] ) && ! empty( $wp ) ) {
+ if ( true === $args['query_var'] )
$args['query_var'] = $taxonomy;
- $args['query_var'] = sanitize_title_with_dashes($args['query_var']);
- $wp->add_query_var($args['query_var']);
+ else
+ $args['query_var'] = sanitize_title_with_dashes( $args['query_var'] );
+ $wp->add_query_var( $args['query_var'] );
+ } else {
+ // Force query_var to false for non-public taxonomies.
+ $args['query_var'] = false;
+ }
+
+ if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
+ $args['rewrite'] = wp_parse_args( $args['rewrite'], array(
+ 'with_front' => true,
+ 'hierarchical' => false,
+ 'ep_mask' => EP_NONE,
+ ) );
+
+ if ( empty( $args['rewrite']['slug'] ) )
+ $args['rewrite']['slug'] = sanitize_title_with_dashes( $taxonomy );
+
+ if ( $args['hierarchical'] && $args['rewrite']['hierarchical'] )
+ $tag = '(.+?)';
+ else
+ $tag = '([^/]+)';
+
+ add_rewrite_tag( "%$taxonomy%", $tag, $args['query_var'] ? "{$args['query_var']}=" : "taxonomy=$taxonomy&term=" );
+ add_permastruct( $taxonomy, "{$args['rewrite']['slug']}/%$taxonomy%", $args['rewrite'] );
}
- if ( false !== $args['rewrite'] && !empty($wp_rewrite) ) {
- if ( !is_array($args['rewrite']) )
- $args['rewrite'] = array();
- if ( !isset($args['rewrite']['slug']) )
- $args['rewrite']['slug'] = sanitize_title_with_dashes($taxonomy);
- $wp_rewrite->add_rewrite_tag("%$taxonomy%", '([^/]+)', $args['query_var'] ? "{$args['query_var']}=" : "taxonomy=$taxonomy&term=$term");
- $wp_rewrite->add_permastruct($taxonomy, "{$args['rewrite']['slug']}/%$taxonomy%");
+ // If not set, default to the setting for public.
+ if ( null === $args['show_ui'] )
+ $args['show_ui'] = $args['public'];
+
+ // If not set, default to the setting for show_ui.
+ if ( null === $args['show_in_menu' ] || ! $args['show_ui'] )
+ $args['show_in_menu' ] = $args['show_ui'];
+
+ // If not set, default to the setting for public.
+ if ( null === $args['show_in_nav_menus'] )
+ $args['show_in_nav_menus'] = $args['public'];
+
+ // If not set, default to the setting for show_ui.
+ if ( null === $args['show_tagcloud'] )
+ $args['show_tagcloud'] = $args['show_ui'];
+
+ // If not set, default to the setting for show_ui.
+ if ( null === $args['show_in_quick_edit'] ) {
+ $args['show_in_quick_edit'] = $args['show_ui'];
}
+ $default_caps = array(
+ 'manage_terms' => 'manage_categories',
+ 'edit_terms' => 'manage_categories',
+ 'delete_terms' => 'manage_categories',
+ 'assign_terms' => 'edit_posts',
+ );
+ $args['cap'] = (object) array_merge( $default_caps, $args['capabilities'] );
+ unset( $args['capabilities'] );
+
$args['name'] = $taxonomy;
- $args['object_type'] = $object_type;
- $wp_taxonomies[$taxonomy] = (object) $args;
+ $args['object_type'] = array_unique( (array) $object_type );
+
+ $args['labels'] = get_taxonomy_labels( (object) $args );
+ $args['label'] = $args['labels']->name;
+
+ // If not set, use the default meta box
+ if ( null === $args['meta_box_cb'] ) {
+ if ( $args['hierarchical'] )
+ $args['meta_box_cb'] = 'post_categories_meta_box';
+ else
+ $args['meta_box_cb'] = 'post_tags_meta_box';
+ }
+
+ $wp_taxonomies[ $taxonomy ] = (object) $args;
+
+ // Register callback handling for meta box.
+ add_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+
+ /**
+ * Fires after a taxonomy is registered.
+ *
+ * @since 3.3.0
+ *
+ * @param string $taxonomy Taxonomy slug.
+ * @param array|string $object_type Object type or array of object types.
+ * @param array $args Array of taxonomy registration arguments.
+ */
+ do_action( 'registered_taxonomy', $taxonomy, $object_type, $args );
+}
+
+/**
+ * Unregisters a taxonomy.
+ *
+ * Can not be used to unregister built-in taxonomies.
+ *
+ * @since 4.5.0
+ *
+ * @global WP $wp Current WordPress environment instance.
+ * @global array $wp_taxonomies List of taxonomies.
+ *
+ * @param string $taxonomy Taxonomy name.
+ * @return bool|WP_Error True on success, WP_Error on failure or if the taxonomy doesn't exist.
+ */
+function unregister_taxonomy( $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
+
+ $taxonomy_args = get_taxonomy( $taxonomy );
+
+ // Do not allow unregistering internal taxonomies.
+ if ( $taxonomy_args->_builtin ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed' ) );
+ }
+
+ global $wp, $wp_taxonomies;
+
+ // Remove query var.
+ if ( false !== $taxonomy_args->query_var ) {
+ $wp->remove_query_var( $taxonomy_args->query_var );
+ }
+
+ // Remove rewrite tags and permastructs.
+ if ( false !== $taxonomy_args->rewrite ) {
+ remove_rewrite_tag( "%$taxonomy%" );
+ remove_permastruct( $taxonomy );
+ }
+
+ // Unregister callback handling for meta box.
+ remove_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+
+ // Remove the taxonomy.
+ unset( $wp_taxonomies[ $taxonomy ] );
+
+ /**
+ * Fires after a taxonomy is unregistered.
+ *
+ * @since 4.5.0
+ *
+ * @param string $taxonomy Taxonomy name.
+ */
+ do_action( 'unregistered_taxonomy', $taxonomy );
+
+ return true;
+}
+
+/**
+ * Builds an object with all taxonomy labels out of a taxonomy object
+ *
+ * Accepted keys of the label array in the taxonomy object:
+ *
+ * - name - general name for the taxonomy, usually plural. The same as and overridden by $tax->label. Default is Tags/Categories
+ * - singular_name - name for one object of this taxonomy. Default is Tag/Category
+ * - search_items - Default is Search Tags/Search Categories
+ * - popular_items - This string isn't used on hierarchical taxonomies. Default is Popular Tags
+ * - all_items - Default is All Tags/All Categories
+ * - parent_item - This string isn't used on non-hierarchical taxonomies. In hierarchical ones the default is Parent Category
+ * - parent_item_colon - The same as `parent_item`, but with colon `:` in the end
+ * - edit_item - Default is Edit Tag/Edit Category
+ * - view_item - Default is View Tag/View Category
+ * - update_item - Default is Update Tag/Update Category
+ * - add_new_item - Default is Add New Tag/Add New Category
+ * - new_item_name - Default is New Tag Name/New Category Name
+ * - separate_items_with_commas - This string isn't used on hierarchical taxonomies. Default is "Separate tags with commas", used in the meta box.
+ * - add_or_remove_items - This string isn't used on hierarchical taxonomies. Default is "Add or remove tags", used in the meta box when JavaScript is disabled.
+ * - choose_from_most_used - This string isn't used on hierarchical taxonomies. Default is "Choose from the most used tags", used in the meta box.
+ * - not_found - Default is "No tags found"/"No categories found", used in the meta box and taxonomy list table.
+ * - no_terms - Default is "No tags"/"No categories", used in the posts and media list tables.
+ * - items_list_navigation - String for the table pagination hidden heading.
+ * - items_list - String for the table hidden heading.
+ *
+ * Above, the first default value is for non-hierarchical taxonomies (like tags) and the second one is for hierarchical taxonomies (like categories).
+ *
+ * @todo Better documentation for the labels array.
+ *
+ * @since 3.0.0
+ * @since 4.3.0 Added the `no_terms` label.
+ * @since 4.4.0 Added the `items_list_navigation` and `items_list` labels.
+ *
+ * @param object $tax Taxonomy object.
+ * @return object object with all the labels as member variables.
+ */
+function get_taxonomy_labels( $tax ) {
+ $tax->labels = (array) $tax->labels;
+
+ if ( isset( $tax->helps ) && empty( $tax->labels['separate_items_with_commas'] ) )
+ $tax->labels['separate_items_with_commas'] = $tax->helps;
+
+ if ( isset( $tax->no_tagcloud ) && empty( $tax->labels['not_found'] ) )
+ $tax->labels['not_found'] = $tax->no_tagcloud;
+
+ $nohier_vs_hier_defaults = array(
+ 'name' => array( _x( 'Tags', 'taxonomy general name' ), _x( 'Categories', 'taxonomy general name' ) ),
+ 'singular_name' => array( _x( 'Tag', 'taxonomy singular name' ), _x( 'Category', 'taxonomy singular name' ) ),
+ 'search_items' => array( __( 'Search Tags' ), __( 'Search Categories' ) ),
+ 'popular_items' => array( __( 'Popular Tags' ), null ),
+ 'all_items' => array( __( 'All Tags' ), __( 'All Categories' ) ),
+ 'parent_item' => array( null, __( 'Parent Category' ) ),
+ 'parent_item_colon' => array( null, __( 'Parent Category:' ) ),
+ 'edit_item' => array( __( 'Edit Tag' ), __( 'Edit Category' ) ),
+ 'view_item' => array( __( 'View Tag' ), __( 'View Category' ) ),
+ 'update_item' => array( __( 'Update Tag' ), __( 'Update Category' ) ),
+ 'add_new_item' => array( __( 'Add New Tag' ), __( 'Add New Category' ) ),
+ 'new_item_name' => array( __( 'New Tag Name' ), __( 'New Category Name' ) ),
+ 'separate_items_with_commas' => array( __( 'Separate tags with commas' ), null ),
+ 'add_or_remove_items' => array( __( 'Add or remove tags' ), null ),
+ 'choose_from_most_used' => array( __( 'Choose from the most used tags' ), null ),
+ 'not_found' => array( __( 'No tags found.' ), __( 'No categories found.' ) ),
+ 'no_terms' => array( __( 'No tags' ), __( 'No categories' ) ),
+ 'items_list_navigation' => array( __( 'Tags list navigation' ), __( 'Categories list navigation' ) ),
+ 'items_list' => array( __( 'Tags list' ), __( 'Categories list' ) ),
+ );
+ $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
+
+ $labels = _get_custom_object_labels( $tax, $nohier_vs_hier_defaults );
+
+ $taxonomy = $tax->name;
+
+ $default_labels = clone $labels;
+
+ /**
+ * Filters the labels of a specific taxonomy.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
+ *
+ * @since 4.4.0
+ *
+ * @see get_taxonomy_labels() for the full list of taxonomy labels.
+ *
+ * @param object $labels Object with labels for the taxonomy as member variables.
+ */
+ $labels = apply_filters( "taxonomy_labels_{$taxonomy}", $labels );
+
+ // Ensure that the filtered labels contain all required default values.
+ $labels = (object) array_merge( (array) $default_labels, (array) $labels );
+
+ return $labels;
+}
+
+/**
+ * Add an already registered taxonomy to an object type.
+ *
+ * @since 3.0.0
+ *
+ * @global array $wp_taxonomies The registered taxonomies.
+ *
+ * @param string $taxonomy Name of taxonomy object.
+ * @param string $object_type Name of the object type.
+ * @return bool True if successful, false if not.
+ */
+function register_taxonomy_for_object_type( $taxonomy, $object_type) {
+ global $wp_taxonomies;
+
+ if ( !isset($wp_taxonomies[$taxonomy]) )
+ return false;
+
+ if ( ! get_post_type_object($object_type) )
+ return false;
+
+ if ( ! in_array( $object_type, $wp_taxonomies[$taxonomy]->object_type ) )
+ $wp_taxonomies[$taxonomy]->object_type[] = $object_type;
+
+ // Filter out empties.
+ $wp_taxonomies[ $taxonomy ]->object_type = array_filter( $wp_taxonomies[ $taxonomy ]->object_type );
+
+ return true;
+}
+
+/**
+ * Remove an already registered taxonomy from an object type.
+ *
+ * @since 3.7.0
+ *
+ * @global array $wp_taxonomies The registered taxonomies.
+ *
+ * @param string $taxonomy Name of taxonomy object.
+ * @param string $object_type Name of the object type.
+ * @return bool True if successful, false if not.
+ */
+function unregister_taxonomy_for_object_type( $taxonomy, $object_type ) {
+ global $wp_taxonomies;
+
+ if ( ! isset( $wp_taxonomies[ $taxonomy ] ) )
+ return false;
+
+ if ( ! get_post_type_object( $object_type ) )
+ return false;
+
+ $key = array_search( $object_type, $wp_taxonomies[ $taxonomy ]->object_type, true );
+ if ( false === $key )
+ return false;
+
+ unset( $wp_taxonomies[ $taxonomy ]->object_type[ $key ] );
+ return true;
}
//
//
/**
- * get_objects_in_term() - Return object_ids of valid taxonomy and term
+ * Retrieve object_ids of valid taxonomy and term.
*
- * The strings of $taxonomies must exist before this function will continue. On failure of finding
- * a valid taxonomy, it will return an WP_Error class, kind of like Exceptions in PHP 5, except you
- * can't catch them. Even so, you can still test for the WP_Error class and get the error message.
+ * The strings of $taxonomies must exist before this function will continue. On
+ * failure of finding a valid taxonomy, it will return an WP_Error class, kind
+ * of like Exceptions in PHP 5, except you can't catch them. Even so, you can
+ * still test for the WP_Error class and get the error message.
*
- * The $terms aren't checked the same as $taxonomies, but still need to exist for $object_ids to
- * be returned.
+ * The $terms aren't checked the same as $taxonomies, but still need to exist
+ * for $object_ids to be returned.
*
- * It is possible to change the order that object_ids is returned by either using PHP sort family
- * functions or using the database by using $args with either ASC or DESC array. The value should
- * be in the key named 'order'.
+ * It is possible to change the order that object_ids is returned by either
+ * using PHP sort family functions or using the database by using $args with
+ * either ASC or DESC array. The value should be in the key named 'order'.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses $wpdb
- * @uses wp_parse_args() Creates an array from string $args.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string|array $terms String of term or array of string values 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
+ * @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 or it will return the $object_ids found.
*/
-function get_objects_in_term( $terms, $taxonomies, $args = array() ) {
+function get_objects_in_term( $term_ids, $taxonomies, $args = array() ) {
global $wpdb;
- if ( !is_array( $terms) )
- $terms = array($terms);
-
- if ( !is_array($taxonomies) )
- $taxonomies = array($taxonomies);
-
- foreach ( $taxonomies as $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( ! is_array( $term_ids ) ) {
+ $term_ids = array( $term_ids );
+ }
+ if ( ! is_array( $taxonomies ) ) {
+ $taxonomies = array( $taxonomies );
+ }
+ foreach ( (array) $taxonomies as $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
}
- $defaults = array('order' => 'ASC');
+ $defaults = array( 'order' => 'ASC' );
$args = wp_parse_args( $args, $defaults );
- extract($args, EXTR_SKIP);
- $order = ( 'desc' == strtolower($order) ) ? 'DESC' : 'ASC';
+ $order = ( 'desc' == strtolower( $args['order'] ) ) ? 'DESC' : 'ASC';
- $terms = array_map('intval', $terms);
+ $term_ids = array_map('intval', $term_ids );
- $taxonomies = "'" . implode("', '", $taxonomies) . "'";
- $terms = "'" . implode("', '", $terms) . "'";
+ $taxonomies = "'" . implode( "', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
+ $term_ids = "'" . implode( "', '", $term_ids ) . "'";
- $object_ids = $wpdb->get_col("SELECT tr.object_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tt.taxonomy IN ($taxonomies) AND tt.term_id IN ($terms) ORDER BY tr.object_id $order");
+ $object_ids = $wpdb->get_col("SELECT tr.object_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tt.taxonomy IN ($taxonomies) AND tt.term_id IN ($term_ids) ORDER BY tr.object_id $order");
- if ( ! $object_ids )
+ if ( ! $object_ids ){
return array();
-
+ }
return $object_ids;
}
/**
- * get_term() - Get all Term data from database by Term ID.
+ * Given a taxonomy query, generates SQL to be appended to a main query.
+ *
+ * @since 3.1.0
+ *
+ * @see WP_Tax_Query
+ *
+ * @param array $tax_query A compact tax query
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @return array
+ */
+function get_tax_sql( $tax_query, $primary_table, $primary_id_column ) {
+ $tax_query_obj = new WP_Tax_Query( $tax_query );
+ return $tax_query_obj->get_sql( $primary_table, $primary_id_column );
+}
+
+/**
+ * Get all Term data from database by Term ID.
*
- * The usage of the get_term function is to apply filters to a term object.
- * It is possible to get a term object from the database before applying the
+ * The usage of the get_term function is to apply filters to a term object. It
+ * is possible to get a term object from the database before applying the
* filters.
*
- * $term ID must be part of $taxonomy, to get from the database. Failure, might be
- * able to be captured by the hooks. Failure would be the same value as $wpdb returns for the
- * get_row method.
+ * $term ID must be part of $taxonomy, to get from the database. Failure, might
+ * be able to be captured by the hooks. Failure would be the same value as $wpdb
+ * returns for the get_row method.
*
- * There are two hooks, one is specifically for each term, named 'get_term', and the second is
- * for the taxonomy name, 'term_$taxonomy'. Both hooks gets the term object, and the taxonomy
- * name as parameters. Both hooks are expected to return a Term object.
+ * There are two hooks, one is specifically for each term, named 'get_term', and
+ * the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the
+ * term object, and the taxonomy name as parameters. Both hooks are expected to
+ * return a Term object.
*
- * 'get_term' hook - Takes two parameters the term Object and the taxonomy name. Must return
- * term object. Used in get_term() as a catch-all filter for every $term.
+ * {@see 'get_term'} hook - Takes two parameters the term Object and the taxonomy name.
+ * Must return term object. Used in get_term() as a catch-all filter for every
+ * $term.
*
- * 'get_$taxonomy' hook - Takes two parameters the term Object and the taxonomy name. Must return
- * term object. $taxonomy will be the taxonomy name, so for example, if 'category', it would be
- * 'get_category' as the filter name. Useful for custom taxonomies or plugging into default taxonomies.
+ * {@see 'get_$taxonomy'} hook - Takes two parameters the term Object and the taxonomy
+ * name. Must return term object. $taxonomy will be the taxonomy name, so for
+ * example, if 'category', it would be 'get_category' as the filter name. Useful
+ * for custom taxonomies or plugging into default taxonomies.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @todo Better formatting for DocBlock
*
- * @uses $wpdb
- * @uses sanitize_term() Cleanses the term based on $filter context before returning.
+ * @since 2.3.0
+ * @since 4.4.0 Converted to return a WP_Term object if `$output` is `OBJECT`.
+ * The `$taxonomy` parameter was made optional.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
* @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
*
- * @param int|object $term If integer, will get from database. If object will apply filters and return $term.
- * @param string $taxonomy Taxonomy name that $term is part of.
- * @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 mixed|null|WP_Error Term Row from database. Will return null if $term is empty. If taxonomy does not
- * exist then WP_Error will be returned.
+ * @param int|WP_Term|object $term If integer, term data will be fetched from the database, or from the cache if
+ * available. If stdClass object (as in the results of a database query), will apply
+ * filters and return a `WP_Term` object corresponding to the `$term` data. If `WP_Term`,
+ * will return `$term`.
+ * @param string $taxonomy Optional. Taxonomy name that $term is part of.
+ * @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 array|WP_Term|WP_Error|null Object of the type specified by `$output` on success. When `$output` is 'OBJECT',
+ * a WP_Term instance is returned. If taxonomy does not exist, a WP_Error is
+ * returned. Returns null for miscellaneous failure.
*/
-function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
- global $wpdb;
-
- if ( empty($term) )
- return null;
+function get_term( $term, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
+ if ( empty( $term ) ) {
+ return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
+ }
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( $taxonomy && ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
- if ( is_object($term) ) {
- wp_cache_add($term->term_id, $term, $taxonomy);
+ if ( $term instanceof WP_Term ) {
$_term = $term;
- } else {
- $term = (int) $term;
- if ( ! $_term = wp_cache_get($term, $taxonomy) ) {
- $_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND t.term_id = %s LIMIT 1", $taxonomy, $term) );
- wp_cache_add($term, $_term, $taxonomy);
+ } elseif ( is_object( $term ) ) {
+ if ( empty( $term->filter ) || 'raw' === $term->filter ) {
+ $_term = sanitize_term( $term, $taxonomy, 'raw' );
+ $_term = new WP_Term( $_term );
+ } else {
+ $_term = WP_Term::get_instance( $term->term_id );
}
+ } else {
+ $_term = WP_Term::get_instance( $term, $taxonomy );
}
- $_term = apply_filters('get_term', $_term, $taxonomy);
- $_term = apply_filters("get_$taxonomy", $_term, $taxonomy);
- $_term = sanitize_term($_term, $taxonomy, $filter);
+ if ( is_wp_error( $_term ) ) {
+ return $_term;
+ } elseif ( ! $_term ) {
+ return null;
+ }
- if ( $output == OBJECT ) {
+ /**
+ * Filters a term.
+ *
+ * @since 2.3.0
+ * @since 4.4.0 `$_term` can now also be a WP_Term object.
+ *
+ * @param int|WP_Term $_term Term object or ID.
+ * @param string $taxonomy The taxonomy slug.
+ */
+ $_term = apply_filters( 'get_term', $_term, $taxonomy );
+
+ /**
+ * Filters a taxonomy.
+ *
+ * The dynamic portion of the filter name, `$taxonomy`, refers
+ * to the taxonomy slug.
+ *
+ * @since 2.3.0
+ * @since 4.4.0 `$_term` can now also be a WP_Term object.
+ *
+ * @param int|WP_Term $_term Term object or ID.
+ * @param string $taxonomy The taxonomy slug.
+ */
+ $_term = apply_filters( "get_$taxonomy", $_term, $taxonomy );
+
+ // Bail if a filter callback has changed the type of the `$_term` object.
+ if ( ! ( $_term instanceof WP_Term ) ) {
return $_term;
- } elseif ( $output == ARRAY_A ) {
- return get_object_vars($_term);
+ }
+
+ // Sanitize term, according to the specified filter.
+ $_term->filter( $filter );
+
+ if ( $output == ARRAY_A ) {
+ return $_term->to_array();
} elseif ( $output == ARRAY_N ) {
- return array_values(get_object_vars($_term));
- } else {
- return $_term;
+ return array_values( $_term->to_array() );
}
+
+ return $_term;
}
/**
- * get_term_by() - Get all Term data from database by Term field and data.
+ * Get all Term data from database by Term field and data.
*
- * Warning: $value is not escaped for 'name' $field. You must do it yourself, if required.
+ * Warning: $value is not escaped for 'name' $field. You must do it yourself, if
+ * required.
*
- * The default $field is 'id', therefore it is possible to also use null for field, but not
- * recommended that you do so.
+ * The default $field is 'id', therefore it is possible to also use null for
+ * field, but not recommended that you do so.
*
- * If $value does not exist, the return value will be false. If $taxonomy exists and $field
- * and $value combinations exist, the Term will be returned.
+ * If $value does not exist, the return value will be false. If $taxonomy exists
+ * and $field and $value combinations exist, the Term will be returned.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * This function will always return the first term that matches the `$field`-
+ * `$value`-`$taxonomy` combination specified in the parameters. If your query
+ * is likely to match more than one term (as is likely to be the case when
+ * `$field` is 'name', for example), consider using get_terms() instead; that
+ * way, you will get all matching terms, and can provide your own logic for
+ * deciding which one was intended.
+ *
+ * @todo Better formatting for DocBlock.
+ *
+ * @since 2.3.0
+ * @since 4.4.0 `$taxonomy` is optional if `$field` is 'term_taxonomy_id'. Converted to return
+ * a WP_Term object if `$output` is `OBJECT`.
*
- * @uses $wpdb
- * @uses sanitize_term() Cleanses the term based on $filter context before returning.
+ * @global wpdb $wpdb WordPress database abstraction object.
* @see sanitize_term_field() The $context param lists the available values for get_term_by() $filter param.
*
- * @param string $field Either 'slug', 'name', or 'id'
- * @param string|int $value Search for this term value
- * @param string $taxonomy Taxonomy Name
- * @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 mixed Term Row from database. Will return false if $taxonomy does not exist or $term was not found.
+ * @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 get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw') {
+function get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
global $wpdb;
- if ( ! is_taxonomy($taxonomy) )
+ // 'term_taxonomy_id' lookups don't require taxonomy checks.
+ if ( 'term_taxonomy_id' !== $field && ! taxonomy_exists( $taxonomy ) ) {
return false;
+ }
+
+ $tax_clause = $wpdb->prepare( "AND tt.taxonomy = %s", $taxonomy );
if ( 'slug' == $field ) {
- $field = 't.slug';
+ $_field = 't.slug';
$value = sanitize_title($value);
if ( empty($value) )
return false;
- } else if ( 'name' == $field ) {
+ } elseif ( 'name' == $field ) {
// Assume already escaped
- $field = 't.name';
- } else {
- $field = 't.term_id';
+ $value = wp_unslash($value);
+ $_field = 't.name';
+ } elseif ( 'term_taxonomy_id' == $field ) {
$value = (int) $value;
+ $_field = 'tt.term_taxonomy_id';
+
+ // No `taxonomy` clause when searching by 'term_taxonomy_id'.
+ $tax_clause = '';
+ } else {
+ $term = get_term( (int) $value, $taxonomy, $output, $filter );
+ if ( is_wp_error( $term ) || is_null( $term ) ) {
+ $term = false;
+ }
+ return $term;
}
- $term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND $field = %s LIMIT 1", $taxonomy, $value) );
- if ( !$term )
+ $term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE $_field = %s", $value ) . " $tax_clause LIMIT 1" );
+ if ( ! $term )
return false;
- wp_cache_add($term->term_id, $term, $taxonomy);
+ // In the case of 'term_taxonomy_id', override the provided `$taxonomy` with whatever we find in the db.
+ if ( 'term_taxonomy_id' === $field ) {
+ $taxonomy = $term->taxonomy;
+ }
- $term = sanitize_term($term, $taxonomy, $filter);
+ wp_cache_add( $term->term_id, $term, 'terms' );
- if ( $output == OBJECT ) {
- return $term;
- } elseif ( $output == ARRAY_A ) {
- return get_object_vars($term);
- } elseif ( $output == ARRAY_N ) {
- return array_values(get_object_vars($term));
- } else {
- return $term;
- }
+ return get_term( $term, $taxonomy, $output, $filter );
}
/**
- * get_term_children() - Merge all term children into a single array.
+ * Merge all term children into a single array of their IDs.
*
- * This recursive function will merge all of the children of $term into
- * the same array. Only useful for taxonomies which are hierarchical.
+ * This recursive function will merge all of the children of $term into the same
+ * array of term IDs. Only useful for taxonomies which are hierarchical.
*
* Will return an empty array if $term does not exist in $taxonomy.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- *
- * @uses $wpdb
- * @uses _get_term_hierarchy()
- * @uses get_term_children() Used to get the children of both $taxonomy and the parent $term
+ * @since 2.3.0
*
- * @param string $term Name of Term to get children
- * @param string $taxonomy Taxonomy Name
- * @return array|WP_Error List of Term Objects. WP_Error returned if $taxonomy does not exist
+ * @param string $term_id ID of Term to get children.
+ * @param string $taxonomy Taxonomy Name.
+ * @return array|WP_Error List of Term IDs. WP_Error returned if `$taxonomy` does not exist.
*/
-function get_term_children( $term, $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+function get_term_children( $term_id, $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
+
+ $term_id = intval( $term_id );
$terms = _get_term_hierarchy($taxonomy);
- if ( ! isset($terms[$term]) )
+ if ( ! isset($terms[$term_id]) )
return array();
- $children = $terms[$term];
+ $children = $terms[$term_id];
+
+ foreach ( (array) $terms[$term_id] as $child ) {
+ if ( $term_id == $child ) {
+ continue;
+ }
- foreach ( $terms[$term] as $child ) {
if ( isset($terms[$child]) )
$children = array_merge($children, get_term_children($child, $taxonomy));
}
}
/**
- * get_term_field() - Get sanitized Term field
+ * Get sanitized Term field.
*
- * Does checks for $term, based on the $taxonomy. The function is for
- * contextual reasons and for simplicity of usage. See sanitize_term_field() for
- * more information.
+ * The function is for contextual reasons and for simplicity of usage.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
+ * @since 4.4.0 The `$taxonomy` parameter was made optional. `$term` can also now accept a WP_Term object.
*
- * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
+ * @see sanitize_term_field()
*
- * @param string $field Term field to fetch
- * @param int $term Term ID
- * @param string $taxonomy Taxonomy Name
- * @param string $context Optional, default is display. Look at sanitize_term_field() for available options.
- * @return mixed Will return an empty string if $term is not an object or if $field is not set in $term.
+ * @param string $field Term field to fetch.
+ * @param int|WP_Term $term Term ID or object.
+ * @param string $taxonomy Optional. Taxonomy Name. Default empty.
+ * @param string $context Optional, default is display. Look at sanitize_term_field() for available options.
+ * @return string|int|null|WP_Error Will return an empty string if $term is not an object or if $field is not set in $term.
*/
-function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
- $term = (int) $term;
+function get_term_field( $field, $term, $taxonomy = '', $context = 'display' ) {
$term = get_term( $term, $taxonomy );
if ( is_wp_error($term) )
return $term;
if ( !isset($term->$field) )
return '';
- return sanitize_term_field($field, $term->$field, $term->term_id, $taxonomy, $context);
+ return sanitize_term_field( $field, $term->$field, $term->term_id, $term->taxonomy, $context );
}
/**
- * get_term_to_edit() - Sanitizes Term for editing
+ * Sanitizes Term for editing.
*
- * Return value is sanitize_term() and usage is for sanitizing the term
- * for editing. Function is for contextual and simplicity.
+ * Return value is sanitize_term() and usage is for sanitizing the term for
+ * editing. Function is for contextual and simplicity.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses sanitize_term() Passes the return value on success
- *
- * @param int|object $id Term ID or Object
- * @param string $taxonomy Taxonomy Name
- * @return mixed|null|WP_Error Will return empty string if $term is not an object.
+ * @param int|object $id Term ID or object.
+ * @param string $taxonomy Taxonomy name.
+ * @return string|int|null|WP_Error Will return empty string if $term is not an object.
*/
function get_term_to_edit( $id, $taxonomy ) {
$term = get_term( $id, $taxonomy );
}
/**
- * get_terms() - Retrieve the terms in taxonomy or list of taxonomies.
- *
- * You can fully inject any customizations to the query before it is sent, as well as control
- * the output with a filter.
- *
- * The 'get_terms' filter will be called when the cache has the term and will pass the found
- * term along with the array of $taxonomies and array of $args. This filter is also called
- * before the array of terms is passed and will pass the array of terms, along with the $taxonomies
- * and $args.
- *
- * The 'list_terms_exclusions' filter passes the compiled exclusions along with the $args.
- *
- * The list that $args can contain, which will overwrite the defaults.
- * orderby - Default is 'name'. Can be name, count, or nothing (will use term_id).
- * order - Default is ASC. Can use DESC.
- * hide_empty - Default is true. Will not return empty $terms.
- * fields - Default is all.
- * slug - Any terms that has this value. Default is empty string.
- * hierarchical - Whether to return hierarchical taxonomy. Default is true.
- * name__like - Default is empty string.
- *
- * The argument 'pad_counts' will count all of the children along with the $terms.
- *
- * The 'get' argument allows for overwriting 'hide_empty' and 'child_of', which can be done by
- * setting the value to 'all', instead of its default empty string value.
- *
- * The 'child_of' argument will be used if you use multiple taxonomy or the first $taxonomy
- * isn't hierarchical or 'parent' isn't used. The default is 0, which will be translated to
- * a false value. If 'child_of' is set, then 'child_of' value will be tested against
- * $taxonomy to see if 'child_of' is contained within. Will return an empty array if test
- * fails.
- *
- * If 'parent' is set, then it will be used to test against the first taxonomy. Much like
- * 'child_of'. Will return an empty array if the test fails.
- *
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- *
- * @uses $wpdb
- * @uses wp_parse_args() Merges the defaults with those defined by $args and allows for strings.
- *
- *
- * @param string|array Taxonomy name or list of Taxonomy names
- * @param string|array $args The values of what to search for when returning terms
- * @return array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies do not exist.
+ * Retrieve the terms in a given taxonomy or list of taxonomies.
+ *
+ * You can fully inject any customizations to the query before it is sent, as
+ * well as control the output with a filter.
+ *
+ * The {@see 'get_terms'} filter will be called when the cache has the term and will
+ * pass the found term along with the array of $taxonomies and array of $args.
+ * This filter is also called before the array of terms is passed and will pass
+ * the array of terms, along with the $taxonomies and $args.
+ *
+ * The {@see 'list_terms_exclusions'} filter passes the compiled exclusions along with
+ * the $args.
+ *
+ * The {@see 'get_terms_orderby'} filter passes the `ORDER BY` clause for the query
+ * along with the $args array.
+ *
+ * Prior to 4.5.0, the first parameter of `get_terms()` was a taxonomy or list of taxonomies:
+ *
+ * $terms = get_terms( 'post_tag', array(
+ * 'hide_empty' => false,
+ * ) );
+ *
+ * Since 4.5.0, taxonomies should be passed via the 'taxonomy' argument in the `$args` array:
+ *
+ * $terms = get_terms( array(
+ * 'taxonomy' => 'post_tag',
+ * 'hide_empty' => false,
+ * ) );
+ *
+ * @since 2.3.0
+ * @since 4.2.0 Introduced 'name' and 'childless' parameters.
+ * @since 4.4.0 Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter.
+ * Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return
+ * a list of WP_Term objects.
+ * @since 4.5.0 Changed the function signature so that the `$args` array can be provided as the first parameter.
+ * Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
+ *
+ * @internal The `$deprecated` parameter is parsed for backward compatibility only.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @global array $wp_filter
+ *
+ * @param array|string $args {
+ * Optional. Array or string of arguments to get terms.
+ *
+ * @type string|array $taxonomy Taxonomy name, or array of taxonomies, to which results should
+ * be limited.
+ * @type string $orderby Field(s) to order terms by. Accepts term fields ('name', 'slug',
+ * 'term_group', 'term_id', 'id', 'description'), 'count' for term
+ * taxonomy count, 'include' to match the 'order' of the $include param,
+ * 'meta_value', 'meta_value_num', the value of `$meta_key`, the array
+ * keys of `$meta_query`, or 'none' to omit the ORDER BY clause.
+ * Defaults to 'name'.
+ * @type string $order Whether to order terms in ascending or descending order.
+ * Accepts 'ASC' (ascending) or 'DESC' (descending).
+ * Default 'ASC'.
+ * @type bool|int $hide_empty Whether to hide terms not assigned to any posts. Accepts
+ * 1|true or 0|false. Default 1|true.
+ * @type array|string $include Array or comma/space-separated string of term ids to include.
+ * Default empty array.
+ * @type array|string $exclude Array or comma/space-separated string of term ids to exclude.
+ * If $include is non-empty, $exclude is ignored.
+ * Default empty array.
+ * @type array|string $exclude_tree Array or comma/space-separated string of term ids to exclude
+ * along with all of their descendant terms. If $include is
+ * non-empty, $exclude_tree is ignored. Default empty array.
+ * @type int|string $number Maximum number of terms to return. Accepts ''|0 (all) or any
+ * positive number. Default ''|0 (all).
+ * @type int $offset The number by which to offset the terms query. Default empty.
+ * @type string $fields Term fields to query for. Accepts 'all' (returns an array of complete
+ * term objects), 'ids' (returns an array of ids), 'id=>parent' (returns
+ * an associative array with ids as keys, parent term IDs as values),
+ * 'names' (returns an array of term names), 'count' (returns the number
+ * of matching terms), 'id=>name' (returns an associative array with ids
+ * as keys, term names as values), or 'id=>slug' (returns an associative
+ * array with ids as keys, term slugs as values). Default 'all'.
+ * @type string|array $name Optional. Name or array of names to return term(s) for. Default empty.
+ * @type string|array $slug Optional. Slug or array of slugs to return term(s) for. Default empty.
+ * @type bool $hierarchical Whether to include terms that have non-empty descendants (even
+ * if $hide_empty is set to true). Default true.
+ * @type string $search Search criteria to match terms. Will be SQL-formatted with
+ * wildcards before and after. Default empty.
+ * @type string $name__like Retrieve terms with criteria by which a term is LIKE $name__like.
+ * Default empty.
+ * @type string $description__like Retrieve terms where the description is LIKE $description__like.
+ * Default empty.
+ * @type bool $pad_counts Whether to pad the quantity of a term's children in the quantity
+ * of each term's "count" object variable. Default false.
+ * @type string $get Whether to return terms regardless of ancestry or whether the terms
+ * are empty. Accepts 'all' or empty (disabled). Default empty.
+ * @type int $child_of Term ID to retrieve child terms of. If multiple taxonomies
+ * are passed, $child_of is ignored. Default 0.
+ * @type int|string $parent Parent term ID to retrieve direct-child terms of. Default empty.
+ * @type bool $childless True to limit results to terms that have no children. This parameter
+ * has no effect on non-hierarchical taxonomies. Default false.
+ * @type string $cache_domain Unique cache key to be produced when this query is stored in an
+ * object cache. Default is 'core'.
+ * @type bool $update_term_meta_cache Whether to prime meta caches for matched terms. Default true.
+ * @type array $meta_query Meta query clauses to limit retrieved terms by.
+ * See `WP_Meta_Query`. Default empty.
+ * @type string $meta_key Limit terms to those matching a specific metadata key. Can be used in
+ * conjunction with `$meta_value`.
+ * @type string $meta_value Limit terms to those matching a specific metadata value. Usually used
+ * in conjunction with `$meta_key`.
+ * }
+ * @param array $deprecated Argument array, when using the legacy function parameter format. If present, this
+ * parameter will be interpreted as `$args`, and the first function parameter will
+ * be parsed as a taxonomy or array of taxonomies.
+ * @return array|int|WP_Error List of WP_Term instances and their children. Will return WP_Error, if any of $taxonomies
+ * do not exist.
*/
-function &get_terms($taxonomies, $args = '') {
+function get_terms( $args = array(), $deprecated = '' ) {
global $wpdb;
- $empty_array = array();
- $single_taxonomy = false;
- if ( !is_array($taxonomies) ) {
- $single_taxonomy = true;
- $taxonomies = array($taxonomies);
+ $term_query = new WP_Term_Query();
+
+ /*
+ * Legacy argument format ($taxonomy, $args) takes precedence.
+ *
+ * We detect legacy argument format by checking if
+ * (a) a second non-empty parameter is passed, or
+ * (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
+ */
+ $_args = wp_parse_args( $args );
+ $key_intersect = array_intersect_key( $term_query->query_var_defaults, (array) $_args );
+ $do_legacy_args = $deprecated || empty( $key_intersect );
+
+ if ( $do_legacy_args ) {
+ $taxonomies = (array) $args;
+ $args = wp_parse_args( $deprecated );
+ $args['taxonomy'] = $taxonomies;
+ } else {
+ $args = wp_parse_args( $args );
+ if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
+ $args['taxonomy'] = (array) $args['taxonomy'];
+ }
}
- foreach ( $taxonomies as $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( ! empty( $args['taxonomy'] ) ) {
+ foreach ( $args['taxonomy'] as $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
+ }
}
- $in_taxonomies = "'" . implode("', '", $taxonomies) . "'";
+ $terms = $term_query->query( $args );
- $defaults = array('orderby' => 'name', 'order' => 'ASC',
- 'hide_empty' => true, 'exclude' => '', 'include' => '',
- 'number' => '', 'fields' => 'all', 'slug' => '', 'parent' => '',
- 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '',
- 'pad_counts' => false, 'offset' => '', 'search' => '');
- $args = wp_parse_args( $args, $defaults );
- $args['number'] = absint( $args['number'] );
- $args['offset'] = absint( $args['offset'] );
- if ( !$single_taxonomy || !is_taxonomy_hierarchical($taxonomies[0]) ||
- '' != $args['parent'] ) {
- $args['child_of'] = 0;
- $args['hierarchical'] = false;
- $args['pad_counts'] = false;
- }
-
- if ( 'all' == $args['get'] ) {
- $args['child_of'] = 0;
- $args['hide_empty'] = 0;
- $args['hierarchical'] = false;
- $args['pad_counts'] = false;
+ // Count queries are not filtered, for legacy reasons.
+ if ( ! is_array( $terms ) ) {
+ return $terms;
}
- extract($args, EXTR_SKIP);
- if ( $child_of ) {
- $hierarchy = _get_term_hierarchy($taxonomies[0]);
- if ( !isset($hierarchy[$child_of]) )
- return $empty_array;
- }
+ /**
+ * Filters the found terms.
+ *
+ * @since 2.3.0
+ * @since 4.6.0 Added the `$term_query` parameter.
+ *
+ * @param array $terms Array of found terms.
+ * @param array $taxonomies An array of taxonomies.
+ * @param array $args An array of get_terms() arguments.
+ * @param WP_Term_Query $term_query The WP_Term_Query object.
+ */
+ return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query );
+}
- if ( $parent ) {
- $hierarchy = _get_term_hierarchy($taxonomies[0]);
- if ( !isset($hierarchy[$parent]) )
- return $empty_array;
+/**
+ * Adds metadata to a term.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Metadata value.
+ * @param bool $unique Optional. Whether to bail if an entry with the same key is found for the term.
+ * Default false.
+ * @return int|WP_Error|bool Meta ID on success. WP_Error when term_id is ambiguous between taxonomies.
+ * False on failure.
+ */
+function add_term_meta( $term_id, $meta_key, $meta_value, $unique = false ) {
+ // Bail if term meta table is not installed.
+ if ( get_option( 'db_version' ) < 34370 ) {
+ return false;
}
- // $args can be whatever, only use the args defined in defaults to compute the key
- $key = md5( serialize( compact(array_keys($defaults)) ) . serialize( $taxonomies ) );
-
- if ( $cache = wp_cache_get( 'get_terms', 'terms' ) ) {
- if ( isset( $cache[ $key ] ) )
- return apply_filters('get_terms', $cache[$key], $taxonomies, $args);
+ if ( wp_term_is_shared( $term_id ) ) {
+ return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
}
- if ( 'count' == $orderby )
- $orderby = 'tt.count';
- else if ( 'name' == $orderby )
- $orderby = 't.name';
- else if ( 'slug' == $orderby )
- $orderby = 't.slug';
- else if ( 'term_group' == $orderby )
- $orderby = 't.term_group';
- else
- $orderby = 't.term_id';
+ $added = add_metadata( 'term', $term_id, $meta_key, $meta_value, $unique );
- $where = '';
- $inclusions = '';
- if ( !empty($include) ) {
- $exclude = '';
- $interms = preg_split('/[\s,]+/',$include);
- if ( count($interms) ) {
- foreach ( $interms as $interm ) {
- if (empty($inclusions))
- $inclusions = ' AND ( t.term_id = ' . intval($interm) . ' ';
- else
- $inclusions .= ' OR t.term_id = ' . intval($interm) . ' ';
- }
- }
+ // Bust term query cache.
+ if ( $added ) {
+ wp_cache_set( 'last_changed', microtime(), 'terms' );
}
- if ( !empty($inclusions) )
- $inclusions .= ')';
- $where .= $inclusions;
+ return $added;
+}
- $exclusions = '';
- if ( !empty($exclude) ) {
- $exterms = preg_split('/[\s,]+/',$exclude);
- if ( count($exterms) ) {
- foreach ( $exterms as $exterm ) {
- if (empty($exclusions))
- $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
- else
- $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
- }
- }
+/**
+ * Removes metadata matching criteria from a term.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $meta_key Metadata name.
+ * @param mixed $meta_value Optional. Metadata value. If provided, rows will only be removed that match the value.
+ * @return bool True on success, false on failure.
+ */
+function delete_term_meta( $term_id, $meta_key, $meta_value = '' ) {
+ // Bail if term meta table is not installed.
+ if ( get_option( 'db_version' ) < 34370 ) {
+ return false;
}
- if ( !empty($exclusions) )
- $exclusions .= ')';
- $exclusions = apply_filters('list_terms_exclusions', $exclusions, $args );
- $where .= $exclusions;
+ $deleted = delete_metadata( 'term', $term_id, $meta_key, $meta_value );
- if ( !empty($slug) ) {
- $slug = sanitize_title($slug);
- $where .= " AND t.slug = '$slug'";
+ // Bust term query cache.
+ if ( $deleted ) {
+ wp_cache_set( 'last_changed', microtime(), 'terms' );
}
- if ( !empty($name__like) )
- $where .= " AND t.name LIKE '{$name__like}%'";
+ return $deleted;
+}
- if ( '' != $parent ) {
- $parent = (int) $parent;
- $where .= " AND tt.parent = '$parent'";
+/**
+ * Retrieves metadata for a term.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $key Optional. The meta key to retrieve. If no key is provided, fetches all metadata for the term.
+ * @param bool $single Whether to return a single value. If false, an array of all values matching the
+ * `$term_id`/`$key` pair will be returned. Default: false.
+ * @return mixed If `$single` is false, an array of metadata values. If `$single` is true, a single metadata value.
+ */
+function get_term_meta( $term_id, $key = '', $single = false ) {
+ // Bail if term meta table is not installed.
+ if ( get_option( 'db_version' ) < 34370 ) {
+ return false;
}
- if ( $hide_empty && !$hierarchical )
- $where .= ' AND tt.count > 0';
-
- if ( !empty($number) ) {
- if( $offset )
- $number = 'LIMIT ' . $offset . ',' . $number;
- else
- $number = 'LIMIT ' . $number;
+ return get_metadata( 'term', $term_id, $key, $single );
+}
- } else
- $number = '';
-
- if ( !empty($search) ) {
- $search = like_escape($search);
- $where .= " AND (t.name LIKE '%$search%')";
+/**
+ * Updates term metadata.
+ *
+ * Use the `$prev_value` parameter to differentiate between meta fields with the same key and term ID.
+ *
+ * If the meta field for the term does not exist, it will be added.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $meta_key Metadata key.
+ * @param mixed $meta_value Metadata value.
+ * @param mixed $prev_value Optional. Previous value to check before removing.
+ * @return int|WP_Error|bool Meta ID if the key didn't previously exist. True on successful update.
+ * WP_Error when term_id is ambiguous between taxonomies. False on failure.
+ */
+function update_term_meta( $term_id, $meta_key, $meta_value, $prev_value = '' ) {
+ // Bail if term meta table is not installed.
+ if ( get_option( 'db_version' ) < 34370 ) {
+ return false;
}
- $select_this = '';
- if ( 'all' == $fields )
- $select_this = 't.*, tt.*';
- else if ( 'ids' == $fields )
- $select_this = 't.term_id';
- else if ( 'names' == $fields )
- $select_this = 't.name';
-
- $query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy IN ($in_taxonomies) $where ORDER BY $orderby $order $number";
-
- if ( 'all' == $fields ) {
- $terms = $wpdb->get_results($query);
- update_term_cache($terms);
- } else if ( ('ids' == $fields) || ('names' == $fields) ) {
- $terms = $wpdb->get_col($query);
+ if ( wp_term_is_shared( $term_id ) ) {
+ return new WP_Error( 'ambiguous_term_id', __( 'Term meta cannot be added to terms that are shared between taxonomies.'), $term_id );
}
- if ( empty($terms) ) {
- $cache[ $key ] = array();
- wp_cache_set( 'get_terms', $cache, 'terms' );
- return apply_filters('get_terms', array(), $taxonomies, $args);
- }
+ $updated = update_metadata( 'term', $term_id, $meta_key, $meta_value, $prev_value );
- if ( $child_of || $hierarchical ) {
- $children = _get_term_hierarchy($taxonomies[0]);
- if ( ! empty($children) )
- $terms = & _get_term_children($child_of, $terms, $taxonomies[0]);
+ // Bust term query cache.
+ if ( $updated ) {
+ wp_cache_set( 'last_changed', microtime(), 'terms' );
}
- // Update term counts to include children.
- if ( $pad_counts )
- _pad_term_counts($terms, $taxonomies[0]);
-
- // Make sure we show empty categories that have children.
- if ( $hierarchical && $hide_empty ) {
- foreach ( $terms as $k => $term ) {
- if ( ! $term->count ) {
- $children = _get_term_children($term->term_id, $terms, $taxonomies[0]);
- foreach ( $children as $child )
- if ( $child->count )
- continue 2;
+ return $updated;
+}
- // It really is empty
- unset($terms[$k]);
- }
- }
+/**
+ * Updates metadata cache for list of term IDs.
+ *
+ * Performs SQL query to retrieve all metadata for the terms matching `$term_ids` and stores them in the cache.
+ * Subsequent calls to `get_term_meta()` will not need to query the database.
+ *
+ * @since 4.4.0
+ *
+ * @param array $term_ids List of term IDs.
+ * @return array|false Returns false if there is nothing to update. Returns an array of metadata on success.
+ */
+function update_termmeta_cache( $term_ids ) {
+ // Bail if term meta table is not installed.
+ if ( get_option( 'db_version' ) < 34370 ) {
+ return;
}
- reset ( $terms );
- $cache[ $key ] = $terms;
- wp_cache_set( 'get_terms', $cache, 'terms' );
-
- $terms = apply_filters('get_terms', $terms, $taxonomies, $args);
- return $terms;
+ return update_meta_cache( 'term', $term_ids );
}
/**
- * is_term() - Check if Term exists
+ * Check if Term exists.
*
- * Returns the index of a defined term, or 0 (false) if the term doesn't exist.
+ * Formerly is_term(), introduced in 2.3.0.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 3.0.0
*
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int|string $term The term to check
- * @param string $taxonomy The taxonomy name to use
- * @return mixed Get the term id or Term Object, if exists.
+ * @param int|string $term The term to check
+ * @param string $taxonomy The taxonomy name to use
+ * @param int $parent Optional. ID of parent term under which to confine the exists search.
+ * @return mixed Returns null if the term does not exist. Returns the term ID
+ * if no taxonomy is specified and the term ID exists. Returns
+ * an array of the term ID and the term taxonomy ID the taxonomy
+ * is specified and the pairing exists.
*/
-function is_term($term, $taxonomy = '') {
+function term_exists( $term, $taxonomy = '', $parent = null ) {
global $wpdb;
+ $select = "SELECT term_id FROM $wpdb->terms as t WHERE ";
+ $tax_select = "SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE ";
+
if ( is_int($term) ) {
if ( 0 == $term )
return 0;
- $where = $wpdb->prepare( "t.term_id = %d", $term );
- } else {
- if ( '' === $term = sanitize_title($term) )
- return 0;
- $where = $wpdb->prepare( "t.slug = %s", $term );
+ $where = 't.term_id = %d';
+ if ( !empty($taxonomy) )
+ return $wpdb->get_row( $wpdb->prepare( $tax_select . $where . " AND tt.taxonomy = %s", $term, $taxonomy ), ARRAY_A );
+ else
+ return $wpdb->get_var( $wpdb->prepare( $select . $where, $term ) );
+ }
+
+ $term = trim( wp_unslash( $term ) );
+ $slug = sanitize_title( $term );
+
+ $where = 't.slug = %s';
+ $else_where = 't.name = %s';
+ $where_fields = array($slug);
+ $else_where_fields = array($term);
+ $orderby = 'ORDER BY t.term_id ASC';
+ $limit = 'LIMIT 1';
+ if ( !empty($taxonomy) ) {
+ if ( is_numeric( $parent ) ) {
+ $parent = (int) $parent;
+ $where_fields[] = $parent;
+ $else_where_fields[] = $parent;
+ $where .= ' AND tt.parent = %d';
+ $else_where .= ' AND tt.parent = %d';
+ }
+
+ $where_fields[] = $taxonomy;
+ $else_where_fields[] = $taxonomy;
+
+ if ( $result = $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $where AND tt.taxonomy = %s $orderby $limit", $where_fields), ARRAY_A) )
+ return $result;
+
+ return $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $else_where AND tt.taxonomy = %s $orderby $limit", $else_where_fields), ARRAY_A);
}
- if ( !empty($taxonomy) )
- return $wpdb->get_row("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $where AND tt.taxonomy = '$taxonomy'", ARRAY_A);
+ if ( $result = $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $where $orderby $limit", $where_fields) ) )
+ return $result;
- return $wpdb->get_var("SELECT term_id FROM $wpdb->terms as t WHERE $where");
+ return $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $else_where $orderby $limit", $else_where_fields) );
}
/**
- * sanitize_term() - Sanitize Term all fields
+ * Check if a term is an ancestor of another term.
*
- * Relys on sanitize_term_field() to sanitize the term. The difference
- * is that this function will sanitize <strong>all</strong> fields. The context
- * is based on sanitize_term_field().
+ * You can use either an id or the term object for both parameters.
*
- * The $term is expected to be either an array or an object.
+ * @since 3.4.0
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @param int|object $term1 ID or object to check if this is the parent term.
+ * @param int|object $term2 The child term.
+ * @param string $taxonomy Taxonomy name that $term1 and `$term2` belong to.
+ * @return bool Whether `$term2` is a child of `$term1`.
+ */
+function term_is_ancestor_of( $term1, $term2, $taxonomy ) {
+ if ( ! isset( $term1->term_id ) )
+ $term1 = get_term( $term1, $taxonomy );
+ if ( ! isset( $term2->parent ) )
+ $term2 = get_term( $term2, $taxonomy );
+
+ if ( empty( $term1->term_id ) || empty( $term2->parent ) )
+ return false;
+ if ( $term2->parent == $term1->term_id )
+ return true;
+
+ return term_is_ancestor_of( $term1, get_term( $term2->parent, $taxonomy ), $taxonomy );
+}
+
+/**
+ * Sanitize Term all fields.
+ *
+ * Relies on sanitize_term_field() to sanitize the term. The difference is that
+ * this function will sanitize <strong>all</strong> fields. The context is based
+ * on sanitize_term_field().
*
- * @uses sanitize_term_field Used to sanitize all fields in a term
+ * The $term is expected to be either an array or an object.
+ *
+ * @since 2.3.0
*
- * @param array|object $term The term to check
- * @param string $taxonomy The taxonomy name to use
- * @param string $context Default is 'display'.
- * @return array|object Term with all fields sanitized
+ * @param array|object $term The term to check.
+ * @param string $taxonomy The taxonomy name to use.
+ * @param string $context Optional. Context in which to sanitize the term. Accepts 'edit', 'db',
+ * 'display', 'attribute', or 'js'. Default 'display'.
+ * @return array|object Term with all fields sanitized.
*/
function sanitize_term($term, $taxonomy, $context = 'display') {
+ $fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' );
- if ( 'raw' == $context )
- return $term;
-
- $fields = array('term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group');
+ $do_object = is_object( $term );
- $do_object = false;
- if ( is_object($term) )
- $do_object = true;
+ $term_id = $do_object ? $term->term_id : (isset($term['term_id']) ? $term['term_id'] : 0);
- foreach ( $fields as $field ) {
- if ( $do_object )
- $term->$field = sanitize_term_field($field, $term->$field, $term->term_id, $taxonomy, $context);
- else
- $term[$field] = sanitize_term_field($field, $term[$field], $term['term_id'], $taxonomy, $context);
+ foreach ( (array) $fields as $field ) {
+ if ( $do_object ) {
+ if ( isset($term->$field) )
+ $term->$field = sanitize_term_field($field, $term->$field, $term_id, $taxonomy, $context);
+ } else {
+ if ( isset($term[$field]) )
+ $term[$field] = sanitize_term_field($field, $term[$field], $term_id, $taxonomy, $context);
+ }
}
+ if ( $do_object )
+ $term->filter = $context;
+ else
+ $term['filter'] = $context;
+
return $term;
}
/**
- * sanitize_term_field() - Cleanse the field value in the term based on the context
+ * Cleanse the field value in the term based on the context.
*
- * Passing a term field value through the function should be assumed to have cleansed
- * the value for whatever context the term field is going to be used.
+ * Passing a term field value through the function should be assumed to have
+ * cleansed the value for whatever context the term field is going to be used.
*
- * If no context or an unsupported context is given, then default filters will be applied.
+ * If no context or an unsupported context is given, then default filters will
+ * be applied.
*
- * There are enough filters for each context to support a custom filtering without creating
- * your own filter function. Simply create a function that hooks into the filter you need.
- *
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * There are enough filters for each context to support a custom filtering
+ * without creating your own filter function. Simply create a function that
+ * hooks into the filter you need.
*
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param string $field Term field to sanitize
- * @param string $value Search for this term value
- * @param int $term_id Term ID
- * @param string $taxonomy Taxonomy Name
- * @param string $context Either edit, db, display, attribute, or js.
- * @return mixed sanitized field
+ * @param string $field Term field to sanitize.
+ * @param string $value Search for this term value.
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy Name.
+ * @param string $context Context in which to sanitize the term field. Accepts 'edit', 'db', 'display',
+ * 'attribute', or 'js'.
+ * @return mixed Sanitized field.
*/
function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) {
- if ( 'parent' == $field || 'term_id' == $field || 'count' == $field || 'term_group' == $field ) {
+ $int_fields = array( 'parent', 'term_id', 'count', 'term_group', 'term_taxonomy_id', 'object_id' );
+ if ( in_array( $field, $int_fields ) ) {
$value = (int) $value;
if ( $value < 0 )
$value = 0;
return $value;
if ( 'edit' == $context ) {
- $value = apply_filters("edit_term_$field", $value, $term_id, $taxonomy);
- $value = apply_filters("edit_${taxonomy}_$field", $value, $term_id);
+
+ /**
+ * Filters a term field to edit before it is sanitized.
+ *
+ * The dynamic portion of the filter name, `$field`, refers to the term field.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the term field.
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ $value = apply_filters( "edit_term_{$field}", $value, $term_id, $taxonomy );
+
+ /**
+ * Filters the taxonomy field to edit before it is sanitized.
+ *
+ * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
+ * to the taxonomy slug and taxonomy field, respectively.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the taxonomy field to edit.
+ * @param int $term_id Term ID.
+ */
+ $value = apply_filters( "edit_{$taxonomy}_{$field}", $value, $term_id );
+
if ( 'description' == $field )
- $value = format_to_edit($value);
+ $value = esc_html($value); // textarea_escaped
else
- $value = attribute_escape($value);
- } else if ( 'db' == $context ) {
- $value = apply_filters("pre_term_$field", $value, $taxonomy);
- $value = apply_filters("pre_${taxonomy}_$field", $value);
+ $value = esc_attr($value);
+ } elseif ( 'db' == $context ) {
+
+ /**
+ * Filters a term field value before it is sanitized.
+ *
+ * The dynamic portion of the filter name, `$field`, refers to the term field.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the term field.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ $value = apply_filters( "pre_term_{$field}", $value, $taxonomy );
+
+ /**
+ * Filters a taxonomy field before it is sanitized.
+ *
+ * The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
+ * to the taxonomy slug and field name, respectively.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the taxonomy field.
+ */
+ $value = apply_filters( "pre_{$taxonomy}_{$field}", $value );
+
// Back compat filters
- if ( 'slug' == $field )
- $value = apply_filters('pre_category_nicename', $value);
+ if ( 'slug' == $field ) {
+ /**
+ * Filters the category nicename before it is sanitized.
+ *
+ * Use the {@see 'pre_$taxonomy_$field'} hook instead.
+ *
+ * @since 2.0.3
+ *
+ * @param string $value The category nicename.
+ */
+ $value = apply_filters( 'pre_category_nicename', $value );
+ }
- } else if ( 'rss' == $context ) {
- $value = apply_filters("term_${field}_rss", $value, $taxonomy);
- $value = apply_filters("${taxonomy}_${field}_rss", $value);
+ } elseif ( 'rss' == $context ) {
+
+ /**
+ * Filters the term field for use in RSS.
+ *
+ * The dynamic portion of the filter name, `$field`, refers to the term field.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the term field.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ $value = apply_filters( "term_{$field}_rss", $value, $taxonomy );
+
+ /**
+ * Filters the taxonomy field for use in RSS.
+ *
+ * The dynamic portions of the hook name, `$taxonomy`, and `$field`, refer
+ * to the taxonomy slug and field name, respectively.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the taxonomy field.
+ */
+ $value = apply_filters( "{$taxonomy}_{$field}_rss", $value );
} else {
// Use display filters by default.
- $value = apply_filters("term_$field", $value, $term_id, $taxonomy, $context);
- $value = apply_filters("${taxonomy}_$field", $value, $term_id, $context);
- }
- if ( 'attribute' == $context )
- $value = attribute_escape($value);
- else if ( 'js' == $context )
- $value = js_escape($value);
+ /**
+ * Filters the term field sanitized for display.
+ *
+ * The dynamic portion of the filter name, `$field`, refers to the term field name.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the term field.
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @param string $context Context to retrieve the term field value.
+ */
+ $value = apply_filters( "term_{$field}", $value, $term_id, $taxonomy, $context );
+
+ /**
+ * Filters the taxonomy field sanitized for display.
+ *
+ * The dynamic portions of the filter name, `$taxonomy`, and `$field`, refer
+ * to the taxonomy slug and taxonomy field, respectively.
+ *
+ * @since 2.3.0
+ *
+ * @param mixed $value Value of the taxonomy field.
+ * @param int $term_id Term ID.
+ * @param string $context Context to retrieve the taxonomy field value.
+ */
+ $value = apply_filters( "{$taxonomy}_{$field}", $value, $term_id, $context );
+ }
+ if ( 'attribute' == $context ) {
+ $value = esc_attr($value);
+ } elseif ( 'js' == $context ) {
+ $value = esc_js($value);
+ }
return $value;
}
/**
- * wp_count_terms() - Count how many terms are in Taxonomy
+ * Count how many terms are in Taxonomy.
*
- * Default $args is 'ignore_empty' which can be <code>'ignore_empty=true'</code> or
- * <code>array('ignore_empty' => true);</code>.
+ * Default $args is 'hide_empty' which can be 'hide_empty=true' or array('hide_empty' => true).
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses $wpdb
- * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.
- *
- * @param string $taxonomy Taxonomy name
- * @param array|string $args Overwrite defaults
- * @return int How many terms are in $taxonomy
+ * @param string $taxonomy Taxonomy name.
+ * @param array|string $args Optional. Array of arguments that get passed to get_terms().
+ * Default empty array.
+ * @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.
*/
function wp_count_terms( $taxonomy, $args = array() ) {
- global $wpdb;
-
- $defaults = array('ignore_empty' => false);
+ $defaults = array('hide_empty' => false);
$args = wp_parse_args($args, $defaults);
- extract($args, EXTR_SKIP);
- $where = '';
- if ( $ignore_empty )
- $where = 'AND count > 0';
+ // backward compatibility
+ if ( isset($args['ignore_empty']) ) {
+ $args['hide_empty'] = $args['ignore_empty'];
+ unset($args['ignore_empty']);
+ }
+
+ $args['fields'] = 'count';
- $taxonomy = $wpdb->escape( $taxonomy );
- return $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE taxonomy = '$taxonomy' $where");
+ return get_terms($taxonomy, $args);
}
/**
- * wp_delete_object_term_relationships() - Will unlink the term from the taxonomy
+ * Will unlink the object from the taxonomy or taxonomies.
*
- * Will remove the term's relationship to the taxonomy, not the term or taxonomy itself.
- * The term and taxonomy will still exist. Will require the term's object ID to perform
- * the operation.
+ * Will remove all relationships between the object and any terms in
+ * a particular taxonomy or taxonomies. Does not remove the term or
+ * taxonomy itself.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param int $object_id The term Object Id that refers to the term
- * @param string|array $taxonomy List of Taxonomy Names or single Taxonomy name.
+ * @param int $object_id The term Object Id that refers to the term.
+ * @param string|array $taxonomies List of Taxonomy Names or single Taxonomy name.
*/
function wp_delete_object_term_relationships( $object_id, $taxonomies ) {
- global $wpdb;
-
$object_id = (int) $object_id;
if ( !is_array($taxonomies) )
$taxonomies = array($taxonomies);
- foreach ( $taxonomies as $taxonomy ) {
- $terms = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids');
- $in_terms = "'" . implode("', '", $terms) . "'";
- $wpdb->query("DELETE FROM $wpdb->term_relationships WHERE object_id = '$object_id' AND term_taxonomy_id IN ($in_terms)");
- wp_update_term_count($terms, $taxonomy);
+ foreach ( (array) $taxonomies as $taxonomy ) {
+ $term_ids = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids' ) );
+ $term_ids = array_map( 'intval', $term_ids );
+ wp_remove_object_terms( $object_id, $term_ids, $taxonomy );
}
}
/**
- * wp_delete_term() - Removes a term from the database.
+ * Removes a term from the database.
*
- * If the term is a parent of other terms, then the children will be updated
- * to that term's parent.
+ * If the term is a parent of other terms, then the children will be updated to
+ * that term's parent.
*
- * The $args 'default' will only override the terms found, if there is only one
- * term found. Any other and the found terms are used.
+ * Metadata associated with the term will be deleted.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses $wpdb
- * @uses do_action() Calls both 'delete_term' and 'delete_$taxonomy' action hooks,
- * passing term object, term id. 'delete_term' gets an additional parameter with
- * the $taxonomy parameter.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $term Term ID
- * @param string $taxonomy Taxonomy Name
- * @param array|string $args Optional. Change 'default' term id and override found term ids.
- * @return bool|WP_Error Returns false if not term; true if completes delete action.
+ * @param int $term Term ID.
+ * @param string $taxonomy Taxonomy Name.
+ * @param array|string $args {
+ * Optional. Array of arguments to override the default term ID. Default empty array.
+ *
+ * @type int $default The term ID to make the default term. This will only override
+ * the terms found if there is only one term found. Any other and
+ * the found terms are used.
+ * @type bool $force_default Optional. Whether to force the supplied term as default to be
+ * assigned even if the object was not going to be term-less.
+ * Default false.
+ * }
+ * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted
+ * deletion of default Category. WP_Error if the taxonomy does not exist.
*/
function wp_delete_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
$term = (int) $term;
- if ( ! $ids = is_term($term, $taxonomy) )
+ if ( ! $ids = term_exists($term, $taxonomy) )
return false;
if ( is_wp_error( $ids ) )
return $ids;
$tt_id = $ids['term_taxonomy_id'];
$defaults = array();
+
+ if ( 'category' == $taxonomy ) {
+ $defaults['default'] = get_option( 'default_category' );
+ if ( $defaults['default'] == $term )
+ return 0; // Don't delete the default category
+ }
+
$args = wp_parse_args($args, $defaults);
- extract($args, EXTR_SKIP);
- if ( isset($default) ) {
- $default = (int) $default;
- if ( ! is_term($default, $taxonomy) )
- unset($default);
+ if ( isset( $args['default'] ) ) {
+ $default = (int) $args['default'];
+ if ( ! term_exists( $default, $taxonomy ) ) {
+ unset( $default );
+ }
+ }
+
+ if ( isset( $args['force_default'] ) ) {
+ $force_default = $args['force_default'];
}
+ /**
+ * Fires when deleting a term, before any modifications are made to posts or terms.
+ *
+ * @since 4.1.0
+ *
+ * @param int $term Term ID.
+ * @param string $taxonomy Taxonomy Name.
+ */
+ do_action( 'pre_delete_term', $term, $taxonomy );
+
// Update children to point to new parent
if ( is_taxonomy_hierarchical($taxonomy) ) {
$term_obj = get_term($term, $taxonomy);
return $term_obj;
$parent = $term_obj->parent;
+ $edit_ids = $wpdb->get_results( "SELECT term_id, term_taxonomy_id FROM $wpdb->term_taxonomy WHERE `parent` = " . (int)$term_obj->term_id );
+ $edit_tt_ids = wp_list_pluck( $edit_ids, 'term_taxonomy_id' );
+
+ /**
+ * Fires immediately before a term to delete's children are reassigned a parent.
+ *
+ * @since 2.9.0
+ *
+ * @param array $edit_tt_ids An array of term taxonomy IDs for the given term.
+ */
+ do_action( 'edit_term_taxonomies', $edit_tt_ids );
+
$wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id) + compact( 'taxonomy' ) );
+
+ // Clean the cache for all child terms.
+ $edit_term_ids = wp_list_pluck( $edit_ids, 'term_id' );
+ clean_term_cache( $edit_term_ids, $taxonomy );
+
+ /**
+ * Fires immediately after a term to delete's children are reassigned a parent.
+ *
+ * @since 2.9.0
+ *
+ * @param array $edit_tt_ids An array of term taxonomy IDs for the given term.
+ */
+ do_action( 'edited_term_taxonomies', $edit_tt_ids );
}
- $objects = $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
+ // Get the term before deleting it or its term relationships so we can pass to actions below.
+ $deleted_term = get_term( $term, $taxonomy );
+
+ $object_ids = (array) $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
- foreach ( (array) $objects as $object ) {
- $terms = wp_get_object_terms($object, $taxonomy, 'fields=ids');
- if ( 1 == count($terms) && isset($default) )
+ foreach ( $object_ids as $object_id ) {
+ $terms = wp_get_object_terms( $object_id, $taxonomy, array( 'fields' => 'ids', 'orderby' => 'none' ) );
+ if ( 1 == count($terms) && isset($default) ) {
$terms = array($default);
- else
+ } else {
$terms = array_diff($terms, array($term));
+ if (isset($default) && isset($force_default) && $force_default)
+ $terms = array_merge($terms, array($default));
+ }
$terms = array_map('intval', $terms);
- wp_set_object_terms($object, $terms, $taxonomy);
+ wp_set_object_terms( $object_id, $terms, $taxonomy );
+ }
+
+ // Clean the relationship caches for all object types using this term.
+ $tax_object = get_taxonomy( $taxonomy );
+ foreach ( $tax_object->object_type as $object_type )
+ clean_object_term_cache( $object_ids, $object_type );
+
+ $term_meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->termmeta WHERE term_id = %d ", $term ) );
+ foreach ( $term_meta_ids as $mid ) {
+ delete_metadata_by_mid( 'term', $mid );
}
- $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $tt_id ) );
+ /**
+ * Fires immediately before a term taxonomy ID is deleted.
+ *
+ * @since 2.9.0
+ *
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( 'delete_term_taxonomy', $tt_id );
+ $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) );
+
+ /**
+ * Fires immediately after a term taxonomy ID is deleted.
+ *
+ * @since 2.9.0
+ *
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( 'deleted_term_taxonomy', $tt_id );
// Delete the term if no taxonomies use it.
if ( !$wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term) ) )
- $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->terms WHERE term_id = %d", $term) );
+ $wpdb->delete( $wpdb->terms, array( 'term_id' => $term ) );
clean_term_cache($term, $taxonomy);
- do_action('delete_term', $term, $tt_id, $taxonomy);
- do_action("delete_$taxonomy", $term, $tt_id);
+ /**
+ * Fires after a term is deleted from the database and the cache is cleaned.
+ *
+ * @since 2.5.0
+ * @since 4.5.0 Introduced the `$object_ids` argument.
+ *
+ * @param int $term Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @param mixed $deleted_term Copy of the already-deleted term, in the form specified
+ * by the parent function. WP_Error otherwise.
+ * @param array $object_ids List of term object IDs.
+ */
+ do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term, $object_ids );
+
+ /**
+ * Fires after a term in a specific taxonomy is deleted.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers to the specific
+ * taxonomy the term belonged to.
+ *
+ * @since 2.3.0
+ * @since 4.5.0 Introduced the `$object_ids` argument.
+ *
+ * @param int $term Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param mixed $deleted_term Copy of the already-deleted term, in the form specified
+ * by the parent function. WP_Error otherwise.
+ * @param array $object_ids List of term object IDs.
+ */
+ do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term, $object_ids );
return true;
}
/**
- * wp_get_object_terms() - Retrieves the terms associated with the given object(s), in the supplied taxonomies.
+ * Deletes one existing category.
*
- * The following information has to do the $args parameter and for what can be contained in the string
- * or array of that parameter, if it exists.
+ * @since 2.0.0
*
- * The first argument is called, 'orderby' and has the default value of 'name'. The other value that is
- * supported is 'count'.
- *
- * The second argument is called, 'order' and has the default value of 'ASC'. The only other value that
- * will be acceptable is 'DESC'.
- *
- * The final argument supported is called, 'fields' and has the default value of 'all'. There are
- * multiple other options that can be used instead. Supported values are as follows: 'all', 'ids',
- * 'names', and finally 'all_with_object_id'.
+ * @param int $cat_ID
+ * @return bool|int|WP_Error Returns true if completes delete action; false if term doesn't exist;
+ * Zero on attempted deletion of default Category; WP_Error object is also a possibility.
+ */
+function wp_delete_category( $cat_ID ) {
+ return wp_delete_term( $cat_ID, 'category' );
+}
+
+/**
+ * Retrieves the terms associated with the given object(s), in the supplied taxonomies.
*
- * The fields argument also decides what will be returned. If 'all' or 'all_with_object_id' is choosen or
- * the default kept intact, then all matching terms objects will be returned. If either 'ids' or 'names'
- * is used, then an array of all matching term ids or term names will be returned respectively.
+ * @since 2.3.0
+ * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`.
+ * Introduced `$parent` argument.
+ * @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or
+ * 'all_with_object_id', an array of `WP_Term` objects will be returned.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int|array $object_id The id of the object(s) to retrieve.
+ * @param int|array $object_ids The ID(s) of the object(s) to retrieve.
* @param string|array $taxonomies The taxonomies to retrieve terms from.
- * @param array|string $args Change what is returned
- * @return array|WP_Error The requested term data or empty array if no terms found. WP_Error if $taxonomy does not exist.
+ * @param array|string $args {
+ * Array of arguments.
+ * @type string $orderby Field by which results should be sorted. Accepts 'name', 'count', 'slug',
+ * 'term_group', 'term_order', 'taxonomy', 'parent', or 'term_taxonomy_id'.
+ * Default 'name'.
+ * @type string $order Sort order. Accepts 'ASC' or 'DESC'. Default 'ASC'.
+ * @type string $fields Fields to return for matched terms. Accepts 'all', 'ids', 'names', and
+ * 'all_with_object_id'. Note that 'all' or 'all_with_object_id' will result
+ * in an array of term objects being returned, 'ids' will return an array of
+ * integers, and 'names' an array of strings.
+ * @type int $parent Optional. Limit results to the direct children of a given term ID.
+ * @type bool $update_term_meta_cache Whether to prime termmeta cache for matched terms. Only applies when
+ * `$fields` is 'all', 'all_with_object_id', or 'term_id'. Default true.
+ * @type array $meta_query Meta query clauses to limit retrieved terms by. See `WP_Meta_Query`.
+ * Default empty.
+ * }
+ * @return array|WP_Error The requested term data or empty array if no terms found.
+ * WP_Error if any of the $taxonomies don't exist.
*/
function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
global $wpdb;
+ if ( empty( $object_ids ) || empty( $taxonomies ) )
+ return array();
+
if ( !is_array($taxonomies) )
$taxonomies = array($taxonomies);
foreach ( $taxonomies as $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( ! taxonomy_exists($taxonomy) )
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
if ( !is_array($object_ids) )
$object_ids = array($object_ids);
$object_ids = array_map('intval', $object_ids);
- $defaults = array('orderby' => 'name', 'order' => 'ASC', 'fields' => 'all');
+ $defaults = array(
+ 'orderby' => 'name',
+ 'order' => 'ASC',
+ 'fields' => 'all',
+ 'parent' => '',
+ 'update_term_meta_cache' => true,
+ 'meta_query' => '',
+ );
$args = wp_parse_args( $args, $defaults );
$terms = array();
if ( count($taxonomies) > 1 ) {
foreach ( $taxonomies as $index => $taxonomy ) {
$t = get_taxonomy($taxonomy);
- if ( is_array($t->args) && $args != array_merge($args, $t->args) ) {
+ if ( isset($t->args) && is_array($t->args) && $args != array_merge($args, $t->args) ) {
unset($taxonomies[$index]);
$terms = array_merge($terms, wp_get_object_terms($object_ids, $taxonomy, array_merge($args, $t->args)));
}
}
} else {
$t = get_taxonomy($taxonomies[0]);
- if ( is_array($t->args) )
+ if ( isset($t->args) && is_array($t->args) )
$args = array_merge($args, $t->args);
}
- extract($args, EXTR_SKIP);
+ $orderby = $args['orderby'];
+ $order = $args['order'];
+ $fields = $args['fields'];
- if ( 'count' == $orderby )
- $orderby = 'tt.count';
- else if ( 'name' == $orderby )
- $orderby = 't.name';
- else if ( 'slug' == $orderby )
- $orderby = 't.slug';
- else if ( 'term_group' == $orderby )
- $orderby = 't.term_group';
- else if ( 'term_order' == $orderby )
+ if ( in_array( $orderby, array( 'term_id', 'name', 'slug', 'term_group' ) ) ) {
+ $orderby = "t.$orderby";
+ } elseif ( in_array( $orderby, array( 'count', 'parent', 'taxonomy', 'term_taxonomy_id' ) ) ) {
+ $orderby = "tt.$orderby";
+ } elseif ( 'term_order' === $orderby ) {
$orderby = 'tr.term_order';
- else
+ } elseif ( 'none' === $orderby ) {
+ $orderby = '';
+ $order = '';
+ } else {
$orderby = 't.term_id';
+ }
+
+ // tt_ids queries can only be none or tr.term_taxonomy_id
+ if ( ('tt_ids' == $fields) && !empty($orderby) )
+ $orderby = 'tr.term_taxonomy_id';
- $taxonomies = "'" . implode("', '", $taxonomies) . "'";
+ if ( !empty($orderby) )
+ $orderby = "ORDER BY $orderby";
+
+ $order = strtoupper( $order );
+ if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) )
+ $order = 'ASC';
+
+ $taxonomy_array = $taxonomies;
+ $object_id_array = $object_ids;
+ $taxonomies = "'" . implode("', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
$object_ids = implode(', ', $object_ids);
$select_this = '';
- if ( 'all' == $fields )
+ if ( 'all' == $fields ) {
$select_this = 't.*, tt.*';
- else if ( 'ids' == $fields )
+ } elseif ( 'ids' == $fields ) {
$select_this = 't.term_id';
- else if ( 'names' == $fields )
+ } elseif ( 'names' == $fields ) {
$select_this = 't.name';
- else if ( 'all_with_object_id' == $fields )
+ } elseif ( 'slugs' == $fields ) {
+ $select_this = 't.slug';
+ } elseif ( 'all_with_object_id' == $fields ) {
$select_this = 't.*, tt.*, tr.object_id';
+ }
+
+ $where = array(
+ "tt.taxonomy IN ($taxonomies)",
+ "tr.object_id IN ($object_ids)",
+ );
+
+ if ( '' !== $args['parent'] ) {
+ $where[] = $wpdb->prepare( 'tt.parent = %d', $args['parent'] );
+ }
- $query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON tt.term_id = t.term_id INNER JOIN $wpdb->term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tt.taxonomy IN ($taxonomies) AND tr.object_id IN ($object_ids) ORDER BY $orderby $order";
+ // Meta query support.
+ $meta_query_join = '';
+ if ( ! empty( $args['meta_query'] ) ) {
+ $mquery = new WP_Meta_Query( $args['meta_query'] );
+ $mq_sql = $mquery->get_sql( 'term', 't', 'term_id' );
+ $meta_query_join .= $mq_sql['join'];
+
+ // Strip leading AND.
+ $where[] = preg_replace( '/^\s*AND/', '', $mq_sql['where'] );
+ }
+
+ $where = implode( ' AND ', $where );
+
+ $query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON tt.term_id = t.term_id INNER JOIN $wpdb->term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id $meta_query_join WHERE $where $orderby $order";
+
+ $objects = false;
if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
- $terms = array_merge($terms, $wpdb->get_results($query));
- update_term_cache($terms);
- } else if ( 'ids' == $fields || 'names' == $fields ) {
- $terms = array_merge($terms, $wpdb->get_col($query));
- } else if ( 'tt_ids' == $fields ) {
- $terms = $wpdb->get_col("SELECT tr.term_taxonomy_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tr.object_id IN ($object_ids) AND tt.taxonomy IN ($taxonomies) ORDER BY tr.term_taxonomy_id $order");
+ $_terms = $wpdb->get_results( $query );
+ $object_id_index = array();
+ foreach ( $_terms as $key => $term ) {
+ $term = sanitize_term( $term, $taxonomy, 'raw' );
+ $_terms[ $key ] = $term;
+
+ if ( isset( $term->object_id ) ) {
+ $object_id_index[ $key ] = $term->object_id;
+ }
+ }
+
+ update_term_cache( $_terms );
+ $_terms = array_map( 'get_term', $_terms );
+
+ // Re-add the object_id data, which is lost when fetching terms from cache.
+ if ( 'all_with_object_id' === $fields ) {
+ foreach ( $_terms as $key => $_term ) {
+ if ( isset( $object_id_index[ $key ] ) ) {
+ $_term->object_id = $object_id_index[ $key ];
+ }
+ }
+ }
+
+ $terms = array_merge( $terms, $_terms );
+ $objects = true;
+
+ } elseif ( 'ids' == $fields || 'names' == $fields || 'slugs' == $fields ) {
+ $_terms = $wpdb->get_col( $query );
+ $_field = ( 'ids' == $fields ) ? 'term_id' : 'name';
+ foreach ( $_terms as $key => $term ) {
+ $_terms[$key] = sanitize_term_field( $_field, $term, $term, $taxonomy, 'raw' );
+ }
+ $terms = array_merge( $terms, $_terms );
+ } elseif ( 'tt_ids' == $fields ) {
+ $terms = $wpdb->get_col("SELECT tr.term_taxonomy_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tr.object_id IN ($object_ids) AND tt.taxonomy IN ($taxonomies) $orderby $order");
+ foreach ( $terms as $key => $tt_id ) {
+ $terms[$key] = sanitize_term_field( 'term_taxonomy_id', $tt_id, 0, $taxonomy, 'raw' ); // 0 should be the term id, however is not needed when using raw context.
+ }
}
- if ( ! $terms )
- return array();
+ // Update termmeta cache, if necessary.
+ if ( $args['update_term_meta_cache'] && ( 'all' === $fields || 'all_with_object_id' === $fields || 'ids' === $fields ) ) {
+ if ( 'ids' === $fields ) {
+ $term_ids = $terms;
+ } else {
+ $term_ids = wp_list_pluck( $terms, 'term_id' );
+ }
- return $terms;
+ update_termmeta_cache( $term_ids );
+ }
+
+ if ( ! $terms ) {
+ $terms = array();
+ } elseif ( $objects && 'all_with_object_id' !== $fields ) {
+ $_tt_ids = array();
+ $_terms = array();
+ foreach ( $terms as $term ) {
+ if ( in_array( $term->term_taxonomy_id, $_tt_ids ) ) {
+ continue;
+ }
+
+ $_tt_ids[] = $term->term_taxonomy_id;
+ $_terms[] = $term;
+ }
+ $terms = $_terms;
+ } elseif ( ! $objects ) {
+ $terms = array_values( array_unique( $terms ) );
+ }
+
+ /**
+ * Filters the terms for a given object or objects.
+ *
+ * @since 4.2.0
+ *
+ * @param array $terms An array of terms for the given object or objects.
+ * @param array $object_id_array Array of object IDs for which `$terms` were retrieved.
+ * @param array $taxonomy_array Array of taxonomies from which `$terms` were retrieved.
+ * @param array $args An array of arguments for retrieving terms for the given
+ * object(s). See wp_get_object_terms() for details.
+ */
+ $terms = apply_filters( 'get_object_terms', $terms, $object_id_array, $taxonomy_array, $args );
+
+ /**
+ * Filters the terms for a given object or objects.
+ *
+ * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The
+ * {@see 'get_object_terms'} filter is recommended as an alternative.
+ *
+ * @since 2.8.0
+ *
+ * @param array $terms An array of terms for the given object or objects.
+ * @param int|array $object_ids Object ID or array of IDs.
+ * @param string $taxonomies SQL-formatted (comma-separated and quoted) list of taxonomy names.
+ * @param array $args An array of arguments for retrieving terms for the given object(s).
+ * See wp_get_object_terms() for details.
+ */
+ return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
}
/**
- * wp_insert_term() - Adds a new term to the database. Optionally marks it as an alias of an existing term.
- *
- * Error handling is assigned for the nonexistance of the $taxonomy and $term parameters before inserting.
- * If both the term id and taxonomy exist previously, then an array will be returned that contains the term
- * id and the contents of what is returned. The keys of the array are 'term_id' and 'term_taxonomy_id' containing
- * numeric values.
- *
- * It is assumed that the term does not yet exist or the above will apply. The term will be first added to the term
- * table and then related to the taxonomy if everything is well. If everything is correct, then several actions
- * will be run prior to a filter and then several actions will be run after the filter is run.
- *
- * The arguments decide how the term is handled based on the $args parameter. The following
- * is a list of the available overrides and the defaults.
- *
- * 'alias_of'. There is no default, but if added, expected is the slug that the term will be an alias of.
- * Expected to be a string.
- *
- * 'description'. There is no default. If exists, will be added to the database along with the term. Expected
- * to be a string.
- *
- * 'parent'. Expected to be numeric and default is 0 (zero). Will assign value of 'parent' to the term.
- *
- * 'slug'. Expected to be a string. There is no default.
- *
- * If 'slug' argument exists then the slug will be checked to see if it is not a valid term. If that check
- * succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check
- * is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check
- * succeeds, the term will be inserted and the term id will be given.
- *
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
- *
- * @uses do_action() Calls 'create_term' hook with the term id and taxonomy id as parameters.
- * @uses do_action() Calls 'create_$taxonomy' hook with term id and taxonomy id as parameters.
- * @uses apply_filters() Calls 'term_id_filter' hook with term id and taxonomy id as parameters.
- * @uses do_action() Calls 'created_term' hook with the term id and taxonomy id as parameters.
- * @uses do_action() Calls 'created_$taxonomy' hook with term id and taxonomy id as parameters.
- *
- * @param int|string $term The term to add or update.
- * @param string $taxonomy The taxonomy to which to add the term
- * @param array|string $args Change the values of the inserted term
- * @return array|WP_Error The Term ID and Term Taxonomy ID
+ * Add a new term to the database.
+ *
+ * A non-existent term is inserted in the following sequence:
+ * 1. The term is added to the term table, then related to the taxonomy.
+ * 2. If everything is correct, several actions are fired.
+ * 3. The 'term_id_filter' is evaluated.
+ * 4. The term cache is cleaned.
+ * 5. Several more actions are fired.
+ * 6. An array is returned containing the term_id and term_taxonomy_id.
+ *
+ * If the 'slug' argument is not empty, then it is checked to see if the term
+ * is invalid. If it is not a valid, existing term, it is added and the term_id
+ * is given.
+ *
+ * If the taxonomy is hierarchical, and the 'parent' argument is not empty,
+ * the term is inserted and the term_id will be given.
+ *
+ * Error handling:
+ * If $taxonomy does not exist or $term is empty,
+ * a WP_Error object will be returned.
+ *
+ * If the term already exists on the same hierarchical level,
+ * or the term slug and name are not unique, a WP_Error object will be returned.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @since 2.3.0
+ *
+ * @param string $term The term to add or update.
+ * @param string $taxonomy The taxonomy to which to add the term.
+ * @param array|string $args {
+ * Optional. Array or string of arguments for inserting a term.
+ *
+ * @type string $alias_of Slug of the term to make this term an alias of.
+ * Default empty string. Accepts a term slug.
+ * @type string $description The term description. Default empty string.
+ * @type int $parent The id of the parent term. Default 0.
+ * @type string $slug The term slug to use. Default empty string.
+ * }
+ * @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
+ * WP_Error otherwise.
*/
function wp_insert_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ if ( ! taxonomy_exists($taxonomy) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
+ /**
+ * Filters a term before it is sanitized and inserted into the database.
+ *
+ * @since 3.0.0
+ *
+ * @param string $term The term to add or update.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ $term = apply_filters( 'pre_insert_term', $term, $taxonomy );
+ if ( is_wp_error( $term ) ) {
+ return $term;
+ }
+ if ( is_int( $term ) && 0 == $term ) {
+ return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) );
+ }
+ if ( '' == trim( $term ) ) {
+ return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
+ }
+ $defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
+ $args = wp_parse_args( $args, $defaults );
- if ( is_int($term) && 0 == $term )
- return new WP_Error('invalid_term_id', __('Invalid term ID'));
+ if ( $args['parent'] > 0 && ! term_exists( (int) $args['parent'] ) ) {
+ return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
+ }
- $defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
- $args = wp_parse_args($args, $defaults);
$args['name'] = $term;
$args['taxonomy'] = $taxonomy;
+
+ // Coerce null description to strings, to avoid database errors.
+ $args['description'] = (string) $args['description'];
+
$args = sanitize_term($args, $taxonomy, 'db');
- extract($args, EXTR_SKIP);
// expected_slashed ($name)
- $name = stripslashes($name);
- $description = stripslashes($description);
+ $name = wp_unslash( $args['name'] );
+ $description = wp_unslash( $args['description'] );
+ $parent = (int) $args['parent'];
- if ( empty($slug) )
- $slug = sanitize_title($name);
+ $slug_provided = ! empty( $args['slug'] );
+ if ( ! $slug_provided ) {
+ $slug = sanitize_title( $name );
+ } else {
+ $slug = $args['slug'];
+ }
$term_group = 0;
- if ( $alias_of ) {
- $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $alias_of) );
- if ( $alias->term_group ) {
+ if ( $args['alias_of'] ) {
+ $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
+ if ( ! empty( $alias->term_group ) ) {
// The alias we want is already in a group, so let's use that one.
$term_group = $alias->term_group;
- } else {
- // The alias isn't in a group, so let's create a new one and firstly add the alias term to it.
+ } elseif ( ! empty( $alias->term_id ) ) {
+ /*
+ * The alias is not in a group, so we create a new one
+ * and add the alias to it.
+ */
$term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
- $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->terms SET term_group = %d WHERE term_id = %d", $term_group, $alias->term_id ) );
+
+ wp_update_term( $alias->term_id, $taxonomy, array(
+ 'term_group' => $term_group,
+ ) );
+ }
+ }
+
+ /*
+ * Prevent the creation of terms with duplicate names at the same level of a taxonomy hierarchy,
+ * unless a unique slug has been explicitly provided.
+ */
+ $name_matches = get_terms( $taxonomy, array(
+ 'name' => $name,
+ 'hide_empty' => false,
+ ) );
+
+ /*
+ * The `name` match in `get_terms()` doesn't differentiate accented characters,
+ * so we do a stricter comparison here.
+ */
+ $name_match = null;
+ if ( $name_matches ) {
+ foreach ( $name_matches as $_match ) {
+ if ( strtolower( $name ) === strtolower( $_match->name ) ) {
+ $name_match = $_match;
+ break;
+ }
+ }
+ }
+
+ if ( $name_match ) {
+ $slug_match = get_term_by( 'slug', $slug, $taxonomy );
+ if ( ! $slug_provided || $name_match->slug === $slug || $slug_match ) {
+ if ( is_taxonomy_hierarchical( $taxonomy ) ) {
+ $siblings = get_terms( $taxonomy, array( 'get' => 'all', 'parent' => $parent ) );
+
+ $existing_term = null;
+ if ( $name_match->slug === $slug && in_array( $name, wp_list_pluck( $siblings, 'name' ) ) ) {
+ $existing_term = $name_match;
+ } elseif ( $slug_match && in_array( $slug, wp_list_pluck( $siblings, 'slug' ) ) ) {
+ $existing_term = $slug_match;
+ }
+
+ if ( $existing_term ) {
+ return new WP_Error( 'term_exists', __( 'A term with the name provided already exists with this parent.' ), $existing_term->term_id );
+ }
+ } else {
+ return new WP_Error( 'term_exists', __( 'A term with the name provided already exists in this taxonomy.' ), $name_match->term_id );
+ }
}
}
- if ( ! $term_id = is_term($slug) ) {
- if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) )
- return new WP_Error('db_insert_error', __('Could not insert term into the database'), $wpdb->last_error);
- $term_id = (int) $wpdb->insert_id;
- } else if ( is_taxonomy_hierarchical($taxonomy) && !empty($parent) ) {
- // If the taxonomy supports hierarchy and the term has a parent, make the slug unique
- // by incorporating parent slugs.
- $slug = wp_unique_term_slug($slug, (object) $args);
- if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) )
- return new WP_Error('db_insert_error', __('Could not insert term into the database'), $wpdb->last_error);
- $term_id = (int) $wpdb->insert_id;
+ $slug = wp_unique_term_slug( $slug, (object) $args );
+
+ if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) ) {
+ return new WP_Error( 'db_insert_error', __( 'Could not insert term into the database' ), $wpdb->last_error );
}
+ $term_id = (int) $wpdb->insert_id;
+
+ // Seems unreachable, However, Is used in the case that a term name is provided, which sanitizes to an empty string.
if ( empty($slug) ) {
$slug = sanitize_title($slug, $term_id);
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edit_terms', $term_id, $taxonomy );
$wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edited_terms', $term_id, $taxonomy );
}
$tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id ) );
- if ( !empty($tt_id) )
+ if ( !empty($tt_id) ) {
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
-
+ }
$wpdb->insert( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent') + array( 'count' => 0 ) );
$tt_id = (int) $wpdb->insert_id;
- do_action("create_term", $term_id, $tt_id);
- do_action("create_$taxonomy", $term_id, $tt_id);
+ /*
+ * Sanity check: if we just created a term with the same parent + taxonomy + slug but a higher term_id than
+ * an existing term, then we have unwittingly created a duplicate term. Delete the dupe, and use the term_id
+ * and term_taxonomy_id of the older term instead. Then return out of the function so that the "create" hooks
+ * are not fired.
+ */
+ $duplicate_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.term_id, tt.term_taxonomy_id FROM $wpdb->terms t INNER JOIN $wpdb->term_taxonomy tt ON ( tt.term_id = t.term_id ) WHERE t.slug = %s AND tt.parent = %d AND tt.taxonomy = %s AND t.term_id < %d AND tt.term_taxonomy_id != %d", $slug, $parent, $taxonomy, $term_id, $tt_id ) );
+ if ( $duplicate_term ) {
+ $wpdb->delete( $wpdb->terms, array( 'term_id' => $term_id ) );
+ $wpdb->delete( $wpdb->term_taxonomy, array( 'term_taxonomy_id' => $tt_id ) );
+
+ $term_id = (int) $duplicate_term->term_id;
+ $tt_id = (int) $duplicate_term->term_taxonomy_id;
+
+ clean_term_cache( $term_id, $taxonomy );
+ return array( 'term_id' => $term_id, 'term_taxonomy_id' => $tt_id );
+ }
- $term_id = apply_filters('term_id_filter', $term_id, $tt_id);
+ /**
+ * Fires immediately after a new term is created, before the term cache is cleaned.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( "create_term", $term_id, $tt_id, $taxonomy );
+
+ /**
+ * Fires after a new term is created for a specific taxonomy.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers
+ * to the slug of the taxonomy the term was created for.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( "create_$taxonomy", $term_id, $tt_id );
+
+ /**
+ * Filters the term ID after a new term is created.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Taxonomy term ID.
+ */
+ $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
clean_term_cache($term_id, $taxonomy);
- do_action("created_term", $term_id, $tt_id);
- do_action("created_$taxonomy", $term_id, $tt_id);
+ /**
+ * Fires after a new term is created, and after the term cache has been cleaned.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'created_term', $term_id, $tt_id, $taxonomy );
+
+ /**
+ * Fires after a new term in a specific taxonomy is created, and after the term
+ * cache has been cleaned.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( "created_$taxonomy", $term_id, $tt_id );
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
}
/**
- * wp_set_object_terms() - Create Term and Taxonomy Relationships
+ * Create Term and Taxonomy Relationships.
*
- * Relates an object (post, link etc) to a term and taxonomy type. Creates the term and taxonomy
- * relationship if it doesn't already exist. Creates a term if it doesn't exist (using the slug).
+ * Relates an object (post, link etc) to a term and taxonomy type. Creates the
+ * term and taxonomy relationship if it doesn't already exist. Creates a term if
+ * it doesn't exist (using the slug).
*
- * A relationship means that the term is grouped in or belongs to the taxonomy. A term has no
- * meaning until it is given context by defining which taxonomy it exists under.
+ * A relationship means that the term is grouped in or belongs to the taxonomy.
+ * A term has no meaning until it is given context by defining which taxonomy it
+ * exists under.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
+ *
+ * @global wpdb $wpdb The WordPress database abstraction object.
*
- * @param int $object_id The object to relate to.
- * @param array|int|string $term The slug or id of the term.
- * @param array|string $taxonomy The context in which to relate the term to the object.
- * @param bool $append If false will delete difference of terms.
- * @return array|WP_Error Affected Term IDs
+ * @param int $object_id The object to relate to.
+ * @param array|int|string $terms A single term slug, single term id, or array of either term slugs or ids.
+ * Will replace all existing related terms in this taxonomy.
+ * @param string $taxonomy The context in which to relate the term to the object.
+ * @param bool $append Optional. If false will delete difference of terms. Default false.
+ * @return array|WP_Error Term taxonomy IDs of the affected terms.
*/
-function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) {
+function wp_set_object_terms( $object_id, $terms, $taxonomy, $append = false ) {
global $wpdb;
$object_id = (int) $object_id;
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
if ( !is_array($terms) )
$terms = array($terms);
if ( ! $append )
- $old_terms = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids');
+ $old_tt_ids = wp_get_object_terms($object_id, $taxonomy, array('fields' => 'tt_ids', 'orderby' => 'none'));
+ else
+ $old_tt_ids = array();
$tt_ids = array();
$term_ids = array();
+ $new_tt_ids = array();
- foreach ($terms as $term) {
+ foreach ( (array) $terms as $term) {
if ( !strlen(trim($term)) )
continue;
- if ( !$id = is_term($term, $taxonomy) )
- $id = wp_insert_term($term, $taxonomy);
- if ( is_wp_error($id) )
- return $id;
- $term_ids[] = $id['term_id'];
- $id = $id['term_taxonomy_id'];
- $tt_ids[] = $id;
+ if ( !$term_info = term_exists($term, $taxonomy) ) {
+ // Skip if a non-existent term ID is passed.
+ if ( is_int($term) )
+ continue;
+ $term_info = wp_insert_term($term, $taxonomy);
+ }
+ if ( is_wp_error($term_info) )
+ return $term_info;
+ $term_ids[] = $term_info['term_id'];
+ $tt_id = $term_info['term_taxonomy_id'];
+ $tt_ids[] = $tt_id;
- if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $id ) ) )
+ if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $tt_id ) ) )
continue;
- $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $id ) );
+
+ /**
+ * Fires immediately before an object-term relationship is added.
+ *
+ * @since 2.9.0
+ *
+ * @param int $object_id Object ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( 'add_term_relationship', $object_id, $tt_id );
+ $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $tt_id ) );
+
+ /**
+ * Fires immediately after an object-term relationship is added.
+ *
+ * @since 2.9.0
+ *
+ * @param int $object_id Object ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( 'added_term_relationship', $object_id, $tt_id );
+ $new_tt_ids[] = $tt_id;
}
- wp_update_term_count($tt_ids, $taxonomy);
+ if ( $new_tt_ids )
+ wp_update_term_count( $new_tt_ids, $taxonomy );
if ( ! $append ) {
- $delete_terms = array_diff($old_terms, $tt_ids);
- if ( $delete_terms ) {
- $in_delete_terms = "'" . implode("', '", $delete_terms) . "'";
- $wpdb->query("DELETE FROM $wpdb->term_relationships WHERE object_id = '$object_id' AND term_taxonomy_id IN ($in_delete_terms)");
- wp_update_term_count($delete_terms, $taxonomy);
+ $delete_tt_ids = array_diff( $old_tt_ids, $tt_ids );
+
+ if ( $delete_tt_ids ) {
+ $in_delete_tt_ids = "'" . implode( "', '", $delete_tt_ids ) . "'";
+ $delete_term_ids = $wpdb->get_col( $wpdb->prepare( "SELECT tt.term_id FROM $wpdb->term_taxonomy AS tt WHERE tt.taxonomy = %s AND tt.term_taxonomy_id IN ($in_delete_tt_ids)", $taxonomy ) );
+ $delete_term_ids = array_map( 'intval', $delete_term_ids );
+
+ $remove = wp_remove_object_terms( $object_id, $delete_term_ids, $taxonomy );
+ if ( is_wp_error( $remove ) ) {
+ return $remove;
+ }
}
}
if ( ! $append && isset($t->sort) && $t->sort ) {
$values = array();
$term_order = 0;
- $final_term_ids = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids');
- foreach ( $term_ids as $term_id )
- if ( in_array($term_id, $final_term_ids) )
- $values[] = $wpdb->prepare( "(%d, %d, %d)", $object_id, $term_id, ++$term_order);
+ $final_tt_ids = wp_get_object_terms($object_id, $taxonomy, array('fields' => 'tt_ids'));
+ foreach ( $tt_ids as $tt_id )
+ if ( in_array($tt_id, $final_tt_ids) )
+ $values[] = $wpdb->prepare( "(%d, %d, %d)", $object_id, $tt_id, ++$term_order);
if ( $values )
- $wpdb->query("INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id, term_order) VALUES " . join(',', $values) . " ON DUPLICATE KEY UPDATE term_order = VALUES(term_order)");
+ if ( false === $wpdb->query( "INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id, term_order) VALUES " . join( ',', $values ) . " ON DUPLICATE KEY UPDATE term_order = VALUES(term_order)" ) )
+ return new WP_Error( 'db_insert_error', __( 'Could not insert term relationship into the database' ), $wpdb->last_error );
}
+ wp_cache_delete( $object_id, $taxonomy . '_relationships' );
+
+ /**
+ * Fires after an object's terms have been set.
+ *
+ * @since 2.8.0
+ *
+ * @param int $object_id Object ID.
+ * @param array $terms An array of object terms.
+ * @param array $tt_ids An array of term taxonomy IDs.
+ * @param string $taxonomy Taxonomy slug.
+ * @param bool $append Whether to append new terms to the old terms.
+ * @param array $old_tt_ids Old array of term taxonomy IDs.
+ */
+ do_action( 'set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids );
return $tt_ids;
}
/**
- * wp_unique_term_slug() - Will make slug unique, if it isn't already
+ * Add term(s) associated with a given object.
*
- * The $slug has to be unique global to every taxonomy, meaning that one taxonomy
- * term can't have a matching slug with another taxonomy term. Each slug has to be
- * globally unique for every taxonomy.
+ * @since 3.6.0
*
- * The way this works is that if the taxonomy that the term belongs to is heirarchical
- * and has a parent, it will append that parent to the $slug.
- *
- * If that still doesn't return an unique slug, then it try to append a number until
- * it finds a number that is truely unique.
+ * @param int $object_id The ID of the object to which the terms will be added.
+ * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to add.
+ * @param array|string $taxonomy Taxonomy name.
+ * @return array|WP_Error Term taxonomy IDs of the affected terms.
+ */
+function wp_add_object_terms( $object_id, $terms, $taxonomy ) {
+ return wp_set_object_terms( $object_id, $terms, $taxonomy, true );
+}
+
+/**
+ * Remove term(s) associated with a given object.
*
- * The only purpose for $term is for appending a parent, if one exists.
+ * @since 3.6.0
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $slug The string that will be tried for a unique slug
- * @param object $term The term object that the $slug will belong too
- * @return string Will return a true unique slug.
+ * @param int $object_id The ID of the object from which the terms will be removed.
+ * @param array|int|string $terms The slug(s) or ID(s) of the term(s) to remove.
+ * @param array|string $taxonomy Taxonomy name.
+ * @return bool|WP_Error True on success, false or WP_Error on failure.
*/
-function wp_unique_term_slug($slug, $term) {
+function wp_remove_object_terms( $object_id, $terms, $taxonomy ) {
global $wpdb;
- // If the taxonomy supports hierarchy and the term has a parent, make the slug unique
- // by incorporating parent slugs.
- if ( is_taxonomy_hierarchical($term->taxonomy) && !empty($term->parent) ) {
- $the_parent = $term->parent;
- while ( ! empty($the_parent) ) {
- $parent_term = get_term($the_parent, $term->taxonomy);
- if ( is_wp_error($parent_term) || empty($parent_term) )
- break;
- $slug .= '-' . $parent_term->slug;
- if ( empty($parent_term->parent) )
- break;
- $the_parent = $parent_term->parent;
- }
+ $object_id = (int) $object_id;
+
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
- // If we didn't get a unique slug, try appending a number to make it unique.
- if ( !empty($args['term_id']) )
- $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $args['term_id'] );
- else
- $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
+ if ( ! is_array( $terms ) ) {
+ $terms = array( $terms );
+ }
+
+ $tt_ids = array();
+
+ foreach ( (array) $terms as $term ) {
+ if ( ! strlen( trim( $term ) ) ) {
+ continue;
+ }
+
+ if ( ! $term_info = term_exists( $term, $taxonomy ) ) {
+ // Skip if a non-existent term ID is passed.
+ if ( is_int( $term ) ) {
+ continue;
+ }
+ }
+
+ if ( is_wp_error( $term_info ) ) {
+ return $term_info;
+ }
+
+ $tt_ids[] = $term_info['term_taxonomy_id'];
+ }
- if ( $wpdb->get_var( $query ) ) {
- $num = 2;
- do {
- $alt_slug = $slug . "-$num";
- $num++;
- $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
- } while ( $slug_check );
- $slug = $alt_slug;
+ if ( $tt_ids ) {
+ $in_tt_ids = "'" . implode( "', '", $tt_ids ) . "'";
+
+ /**
+ * Fires immediately before an object-term relationship is deleted.
+ *
+ * @since 2.9.0
+ *
+ * @param int $object_id Object ID.
+ * @param array $tt_ids An array of term taxonomy IDs.
+ */
+ do_action( 'delete_term_relationships', $object_id, $tt_ids );
+ $deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) );
+
+ wp_cache_delete( $object_id, $taxonomy . '_relationships' );
+
+ /**
+ * Fires immediately after an object-term relationship is deleted.
+ *
+ * @since 2.9.0
+ *
+ * @param int $object_id Object ID.
+ * @param array $tt_ids An array of term taxonomy IDs.
+ */
+ do_action( 'deleted_term_relationships', $object_id, $tt_ids );
+
+ wp_update_term_count( $tt_ids, $taxonomy );
+
+ return (bool) $deleted;
}
- return $slug;
+ return false;
}
/**
- * wp_update_term() - Update term based on arguments provided
- *
- * The $args will indiscriminately override all values with the same field name. Care
- * must be taken to not override important information need to update or update will
- * fail (or perhaps create a new term, neither would be acceptable).
+ * Will make slug unique, if it isn't already.
*
- * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not defined
- * in $args already.
+ * The `$slug` has to be unique global to every taxonomy, meaning that one
+ * taxonomy term can't have a matching slug with another taxonomy term. Each
+ * slug has to be globally unique for every taxonomy.
*
- * 'alias_of' will create a term group, if it doesn't already exist, and update it for
- * the $term.
+ * The way this works is that if the taxonomy that the term belongs to is
+ * hierarchical and has a parent, it will append that parent to the $slug.
*
- * If the 'slug' argument in $args is missing, then the 'name' in $args will be used.
- * It should also be noted that if you set 'slug' and it isn't unique then a WP_Error
- * will be passed back. If you don't pass any slug, then a unique one will be created
- * for you.
+ * If that still doesn't return an unique slug, then it try to append a number
+ * until it finds a number that is truly unique.
*
- * For what can be overrode in $args, check the term scheme can contain and stay away
- * from the term keys.
+ * The only purpose for `$term` is for appending a parent, if one exists.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @uses $wpdb
- * @uses do_action() Will call both 'edit_term' and 'edit_$taxonomy' twice.
- * @uses apply_filters() Will call the 'term_id_filter' filter and pass the term id and
- * taxonomy id.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int $term The ID of the term
- * @param string $taxonomy The context in which to relate the term to the object.
- * @param array|string $args Overwrite term field values
- * @return array|WP_Error Returns Term ID and Taxonomy Term ID
+ * @param string $slug The string that will be tried for a unique slug.
+ * @param object $term The term object that the `$slug` will belong to.
+ * @return string Will return a true unique slug.
*/
-function wp_update_term( $term, $taxonomy, $args = array() ) {
+function wp_unique_term_slug( $slug, $term ) {
global $wpdb;
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ $needs_suffix = true;
+ $original_slug = $slug;
- $term_id = (int) $term;
-
- // First, get all of the original args
- $term = get_term ($term_id, $taxonomy, ARRAY_A);
+ // As of 4.1, duplicate slugs are allowed as long as they're in different taxonomies.
+ if ( ! term_exists( $slug ) || get_option( 'db_version' ) >= 30133 && ! get_term_by( 'slug', $slug, $term->taxonomy ) ) {
+ $needs_suffix = false;
+ }
- // Escape data pulled from DB.
- $term = add_magic_quotes($term);
+ /*
+ * If the taxonomy supports hierarchy and the term has a parent, make the slug unique
+ * by incorporating parent slugs.
+ */
+ $parent_suffix = '';
+ if ( $needs_suffix && is_taxonomy_hierarchical( $term->taxonomy ) && ! empty( $term->parent ) ) {
+ $the_parent = $term->parent;
+ while ( ! empty($the_parent) ) {
+ $parent_term = get_term($the_parent, $term->taxonomy);
+ if ( is_wp_error($parent_term) || empty($parent_term) )
+ break;
+ $parent_suffix .= '-' . $parent_term->slug;
+ if ( ! term_exists( $slug . $parent_suffix ) ) {
+ break;
+ }
+
+ if ( empty($parent_term->parent) )
+ break;
+ $the_parent = $parent_term->parent;
+ }
+ }
+
+ // If we didn't get a unique slug, try appending a number to make it unique.
+
+ /**
+ * Filters whether the proposed unique term slug is bad.
+ *
+ * @since 4.3.0
+ *
+ * @param bool $needs_suffix Whether the slug needs to be made unique with a suffix.
+ * @param string $slug The slug.
+ * @param object $term Term object.
+ */
+ if ( apply_filters( 'wp_unique_term_slug_is_bad_slug', $needs_suffix, $slug, $term ) ) {
+ if ( $parent_suffix ) {
+ $slug .= $parent_suffix;
+ } else {
+ if ( ! empty( $term->term_id ) )
+ $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $term->term_id );
+ else
+ $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
+
+ if ( $wpdb->get_var( $query ) ) {
+ $num = 2;
+ do {
+ $alt_slug = $slug . "-$num";
+ $num++;
+ $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
+ } while ( $slug_check );
+ $slug = $alt_slug;
+ }
+ }
+ }
+
+ /**
+ * Filters the unique term slug.
+ *
+ * @since 4.3.0
+ *
+ * @param string $slug Unique term slug.
+ * @param object $term Term object.
+ * @param string $original_slug Slug originally passed to the function for testing.
+ */
+ return apply_filters( 'wp_unique_term_slug', $slug, $term, $original_slug );
+}
+
+/**
+ * Update term based on arguments provided.
+ *
+ * The $args will indiscriminately override all values with the same field name.
+ * Care must be taken to not override important information need to update or
+ * update will fail (or perhaps create a new term, neither would be acceptable).
+ *
+ * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not
+ * defined in $args already.
+ *
+ * 'alias_of' will create a term group, if it doesn't already exist, and update
+ * it for the $term.
+ *
+ * If the 'slug' argument in $args is missing, then the 'name' in $args will be
+ * used. It should also be noted that if you set 'slug' and it isn't unique then
+ * a WP_Error will be passed back. If you don't pass any slug, then a unique one
+ * will be created for you.
+ *
+ * For what can be overrode in `$args`, check the term scheme can contain and stay
+ * away from the term keys.
+ *
+ * @since 2.3.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $term_id The ID of the term
+ * @param string $taxonomy The context in which to relate the term to the object.
+ * @param array|string $args Optional. Array of get_terms() arguments. Default empty array.
+ * @return array|WP_Error Returns Term ID and Taxonomy Term ID
+ */
+function wp_update_term( $term_id, $taxonomy, $args = array() ) {
+ global $wpdb;
+
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
+
+ $term_id = (int) $term_id;
+
+ // First, get all of the original args
+ $term = get_term( $term_id, $taxonomy );
+
+ if ( is_wp_error( $term ) ) {
+ return $term;
+ }
+
+ if ( ! $term ) {
+ return new WP_Error( 'invalid_term', __( 'Empty Term' ) );
+ }
+
+ $term = (array) $term->data;
+
+ // Escape data pulled from DB.
+ $term = wp_slash( $term );
// Merge old and new args with new args overwriting old ones.
$args = array_merge($term, $args);
$defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
$args = wp_parse_args($args, $defaults);
$args = sanitize_term($args, $taxonomy, 'db');
- extract($args, EXTR_SKIP);
+ $parsed_args = $args;
// expected_slashed ($name)
- $name = stripslashes($name);
- $description = stripslashes($description);
+ $name = wp_unslash( $args['name'] );
+ $description = wp_unslash( $args['description'] );
+
+ $parsed_args['name'] = $name;
+ $parsed_args['description'] = $description;
+
+ if ( '' == trim( $name ) ) {
+ return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
+ }
+
+ if ( $parsed_args['parent'] > 0 && ! term_exists( (int) $parsed_args['parent'] ) ) {
+ return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
+ }
$empty_slug = false;
- if ( empty($slug) ) {
+ if ( empty( $args['slug'] ) ) {
$empty_slug = true;
$slug = sanitize_title($name);
+ } else {
+ $slug = $args['slug'];
}
- if ( $alias_of ) {
- $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $alias_of) );
- if ( $alias->term_group ) {
+ $parsed_args['slug'] = $slug;
+
+ $term_group = isset( $parsed_args['term_group'] ) ? $parsed_args['term_group'] : 0;
+ if ( $args['alias_of'] ) {
+ $alias = get_term_by( 'slug', $args['alias_of'], $taxonomy );
+ if ( ! empty( $alias->term_group ) ) {
// The alias we want is already in a group, so let's use that one.
$term_group = $alias->term_group;
- } else {
- // The alias isn't in a group, so let's create a new one and firstly add the alias term to it.
+ } elseif ( ! empty( $alias->term_id ) ) {
+ /*
+ * The alias is not in a group, so we create a new one
+ * and add the alias to it.
+ */
$term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
- $wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) );
+
+ wp_update_term( $alias->term_id, $taxonomy, array(
+ 'term_group' => $term_group,
+ ) );
}
+
+ $parsed_args['term_group'] = $term_group;
}
+ /**
+ * Filters the term parent.
+ *
+ * Hook to this filter to see if it will cause a hierarchy loop.
+ *
+ * @since 3.1.0
+ *
+ * @param int $parent ID of the parent term.
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @param array $parsed_args An array of potentially altered update arguments for the given term.
+ * @param array $args An array of update arguments for the given term.
+ */
+ $parent = apply_filters( 'wp_update_term_parent', $args['parent'], $term_id, $taxonomy, $parsed_args, $args );
+
// Check for duplicate slug
- $id = $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->terms WHERE slug = %s", $slug ) );
- if ( $id && ($id != $term_id) ) {
+ $duplicate = get_term_by( 'slug', $slug, $taxonomy );
+ if ( $duplicate && $duplicate->term_id != $term_id ) {
// If an empty slug was passed or the parent changed, reset the slug to something unique.
// Otherwise, bail.
- if ( $empty_slug || ( $parent != $term->parent) )
+ if ( $empty_slug || ( $parent != $term['parent']) )
$slug = wp_unique_term_slug($slug, (object) $args);
else
- return new WP_Error('duplicate_term_slug', sprintf(__('The slug "%s" is already in use by another term'), $slug));
+ return new WP_Error('duplicate_term_slug', sprintf(__('The slug “%s” is already in use by another term'), $slug));
}
- $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
+ $tt_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id) );
+
+ // Check whether this is a shared term that needs splitting.
+ $_term_id = _split_shared_term( $term_id, $tt_id );
+ if ( ! is_wp_error( $_term_id ) ) {
+ $term_id = $_term_id;
+ }
+ /**
+ * Fires immediately before the given terms are edited.
+ *
+ * @since 2.9.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'edit_terms', $term_id, $taxonomy );
+ $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
if ( empty($slug) ) {
$slug = sanitize_title($name, $term_id);
$wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
}
- $tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id) );
+ /**
+ * Fires immediately after the given terms are edited.
+ *
+ * @since 2.9.0
+ *
+ * @param int $term_id Term ID
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'edited_terms', $term_id, $taxonomy );
+
+ /**
+ * Fires immediate before a term-taxonomy relationship is updated.
+ *
+ * @since 2.9.0
+ *
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'edit_term_taxonomy', $tt_id, $taxonomy );
$wpdb->update( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ), array( 'term_taxonomy_id' => $tt_id ) );
- do_action("edit_term", $term_id, $tt_id);
- do_action("edit_$taxonomy", $term_id, $tt_id);
-
- $term_id = apply_filters('term_id_filter', $term_id, $tt_id);
+ /**
+ * Fires immediately after a term-taxonomy relationship is updated.
+ *
+ * @since 2.9.0
+ *
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'edited_term_taxonomy', $tt_id, $taxonomy );
+
+ /**
+ * Fires after a term has been updated, but before the term cache has been cleaned.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( "edit_term", $term_id, $tt_id, $taxonomy );
+
+ /**
+ * Fires after a term in a specific taxonomy has been updated, but before the term
+ * cache has been cleaned.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( "edit_$taxonomy", $term_id, $tt_id );
+
+ /** This filter is documented in wp-includes/taxonomy.php */
+ $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
clean_term_cache($term_id, $taxonomy);
- do_action("edited_term", $term_id, $tt_id);
- do_action("edited_$taxonomy", $term_id, $tt_id);
+ /**
+ * Fires after a term has been updated, and the term cache has been cleaned.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( "edited_term", $term_id, $tt_id, $taxonomy );
+
+ /**
+ * Fires after a term for a specific taxonomy has been updated, and the term
+ * cache has been cleaned.
+ *
+ * The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
+ *
+ * @since 2.3.0
+ *
+ * @param int $term_id Term ID.
+ * @param int $tt_id Term taxonomy ID.
+ */
+ do_action( "edited_$taxonomy", $term_id, $tt_id );
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
}
-// enable or disable term count deferring
-// if no value is supplied, the current value of the defer setting is returned
-function wp_defer_term_counting($defer=NULL) {
+/**
+ * Enable or disable term counting.
+ *
+ * @since 2.5.0
+ *
+ * @staticvar bool $_defer
+ *
+ * @param bool $defer Optional. Enable if true, disable if false.
+ * @return bool Whether term counting is enabled or disabled.
+ */
+function wp_defer_term_counting($defer=null) {
static $_defer = false;
if ( is_bool($defer) ) {
$_defer = $defer;
// flush any deferred counts
if ( !$defer )
- wp_update_term_count( NULL, NULL, true );
+ wp_update_term_count( null, null, true );
}
return $_defer;
}
/**
- * wp_update_term_count() - Updates the amount of terms in taxonomy
+ * Updates the amount of terms in taxonomy.
*
- * If there is a taxonomy callback applyed, then it will be called for updating the count.
+ * If there is a taxonomy callback applied, then it will be called for updating
+ * the count.
*
- * The default action is to count what the amount of terms have the relationship of term ID.
- * Once that is done, then update the database.
+ * The default action is to count what the amount of terms have the relationship
+ * of term ID. Once that is done, then update the database.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param int|array $terms The ID of the terms
- * @param string $taxonomy The context of the term.
+ * @staticvar array $_deferred
+ *
+ * @param int|array $terms The term_taxonomy_id of the terms.
+ * @param string $taxonomy The context of the term.
+ * @param bool $do_deferred Whether to flush the deferred term counts too. Default false.
* @return bool If no terms will return false, and if successful will return true.
*/
-function wp_update_term_count( $terms, $taxonomy, $do_deferred=false ) {
+function wp_update_term_count( $terms, $taxonomy, $do_deferred = false ) {
static $_deferred = array();
if ( $do_deferred ) {
- foreach ( array_keys($_deferred) as $tax ) {
+ foreach ( (array) array_keys($_deferred) as $tax ) {
wp_update_term_count_now( $_deferred[$tax], $tax );
unset( $_deferred[$tax] );
}
return wp_update_term_count_now( $terms, $taxonomy );
}
+/**
+ * Perform term count update immediately.
+ *
+ * @since 2.5.0
+ *
+ * @param array $terms The term_taxonomy_id of terms to update.
+ * @param string $taxonomy The context of the term.
+ * @return true Always true when complete.
+ */
function wp_update_term_count_now( $terms, $taxonomy ) {
- global $wpdb;
-
$terms = array_map('intval', $terms);
$taxonomy = get_taxonomy($taxonomy);
if ( !empty($taxonomy->update_count_callback) ) {
- call_user_func($taxonomy->update_count_callback, $terms);
+ call_user_func($taxonomy->update_count_callback, $terms, $taxonomy);
} else {
- // Default count updater
- foreach ($terms as $term) {
- $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term) );
- $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
+ $object_types = (array) $taxonomy->object_type;
+ foreach ( $object_types as &$object_type ) {
+ if ( 0 === strpos( $object_type, 'attachment:' ) )
+ list( $object_type ) = explode( ':', $object_type );
}
+ if ( $object_types == array_filter( $object_types, 'post_type_exists' ) ) {
+ // Only post types are attached to this taxonomy
+ _update_post_term_count( $terms, $taxonomy );
+ } else {
+ // Default count updater
+ _update_generic_term_count( $terms, $taxonomy );
+ }
}
- clean_term_cache($terms);
+ clean_term_cache($terms, '', false);
return true;
}
//
/**
- * clean_object_term_cache() - Removes the taxonomy relationship to terms from the cache.
+ * Removes the taxonomy relationship to terms from the cache.
*
- * Will remove the entire taxonomy relationship containing term $object_id. The term IDs
- * have to exist within the taxonomy $object_type for the deletion to take place.
+ * Will remove the entire taxonomy relationship containing term `$object_id`. The
+ * term IDs have to exist within the taxonomy `$object_type` for the deletion to
+ * take place.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @see get_object_taxonomies() for more on $object_type
- * @uses do_action() Will call action hook named, 'clean_object_term_cache' after completion.
- * Passes, function params in same order.
+ * @global bool $_wp_suspend_cache_invalidation
*
- * @param int|array $object_ids Single or list of term object ID(s)
- * @param array|string $object_type The taxonomy object type
+ * @see get_object_taxonomies() for more on $object_type.
+ *
+ * @param int|array $object_ids Single or list of term object ID(s).
+ * @param array|string $object_type The taxonomy object type.
*/
function clean_object_term_cache($object_ids, $object_type) {
+ global $_wp_suspend_cache_invalidation;
+
+ if ( ! empty( $_wp_suspend_cache_invalidation ) ) {
+ return;
+ }
+
if ( !is_array($object_ids) )
$object_ids = array($object_ids);
- foreach ( $object_ids as $id )
- foreach ( get_object_taxonomies($object_type) as $taxonomy )
+ $taxonomies = get_object_taxonomies( $object_type );
+
+ foreach ( $object_ids as $id ) {
+ foreach ( $taxonomies as $taxonomy ) {
wp_cache_delete($id, "{$taxonomy}_relationships");
+ }
+ }
- do_action('clean_object_term_cache', $object_ids, $object_type);
+ /**
+ * Fires after the object term cache has been cleaned.
+ *
+ * @since 2.5.0
+ *
+ * @param array $object_ids An array of object IDs.
+ * @param string $objet_type Object type.
+ */
+ do_action( 'clean_object_term_cache', $object_ids, $object_type );
}
/**
- * clean_term_cache() - Will remove all of the term ids from the cache
+ * Will remove all of the term ids from the cache.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param int|array $ids Single or list of Term IDs
- * @param string $taxonomy Can be empty and will assume tt_ids, else will use for context.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ * @global bool $_wp_suspend_cache_invalidation
+ *
+ * @param int|array $ids Single or list of Term IDs.
+ * @param string $taxonomy Optional. Can be empty and will assume `tt_ids`, else will use for context.
+ * Default empty.
+ * @param bool $clean_taxonomy Optional. Whether to clean taxonomy wide caches (true), or just individual
+ * term object caches (false). Default true.
*/
-function clean_term_cache($ids, $taxonomy = '') {
- global $wpdb;
+function clean_term_cache($ids, $taxonomy = '', $clean_taxonomy = true) {
+ global $wpdb, $_wp_suspend_cache_invalidation;
+
+ if ( ! empty( $_wp_suspend_cache_invalidation ) ) {
+ return;
+ }
if ( !is_array($ids) )
$ids = array($ids);
$taxonomies = array();
// If no taxonomy, assume tt_ids.
if ( empty($taxonomy) ) {
- $tt_ids = implode(', ', $ids);
+ $tt_ids = array_map('intval', $ids);
+ $tt_ids = implode(', ', $tt_ids);
$terms = $wpdb->get_results("SELECT term_id, taxonomy FROM $wpdb->term_taxonomy WHERE term_taxonomy_id IN ($tt_ids)");
+ $ids = array();
foreach ( (array) $terms as $term ) {
$taxonomies[] = $term->taxonomy;
- wp_cache_delete($term->term_id, $term->taxonomy);
+ $ids[] = $term->term_id;
+ wp_cache_delete( $term->term_id, 'terms' );
}
$taxonomies = array_unique($taxonomies);
} else {
- foreach ( $ids as $id ) {
- wp_cache_delete($id, $taxonomy);
- }
$taxonomies = array($taxonomy);
+ foreach ( $taxonomies as $taxonomy ) {
+ foreach ( $ids as $id ) {
+ wp_cache_delete( $id, 'terms' );
+ }
+ }
}
foreach ( $taxonomies as $taxonomy ) {
- wp_cache_delete('all_ids', $taxonomy);
- wp_cache_delete('get', $taxonomy);
- delete_option("{$taxonomy}_children");
- }
+ if ( $clean_taxonomy ) {
+ wp_cache_delete('all_ids', $taxonomy);
+ wp_cache_delete('get', $taxonomy);
+ delete_option("{$taxonomy}_children");
+ // Regenerate {$taxonomy}_children
+ _get_term_hierarchy($taxonomy);
+ }
- wp_cache_delete('get_terms', 'terms');
+ /**
+ * Fires once after each taxonomy's term cache has been cleaned.
+ *
+ * @since 2.5.0
+ * @since 4.5.0 Added the `$clean_taxonomy` parameter.
+ *
+ * @param array $ids An array of term IDs.
+ * @param string $taxonomy Taxonomy slug.
+ * @param bool $clean_taxonomy Whether or not to clean taxonomy-wide caches
+ */
+ do_action( 'clean_term_cache', $ids, $taxonomy, $clean_taxonomy );
+ }
- do_action('clean_term_cache', $ids, $taxonomy);
+ wp_cache_set( 'last_changed', microtime(), 'terms' );
}
/**
- * get_object_term_cache() - Retrieves the taxonomy relationship to the term object id.
+ * Retrieves the taxonomy relationship to the term object id.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * Upstream functions (like get_the_terms() and is_object_in_term()) are
+ * responsible for populating the object-term relationship cache. The current
+ * function only fetches relationship data that is already in the cache.
*
- * @uses wp_cache_get() Retrieves taxonomy relationship from cache
+ * @since 2.3.0
*
- * @param int|array $id Term object ID
- * @param string $taxonomy Taxonomy Name
- * @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id.
+ * @param int $id Term object ID.
+ * @param string $taxonomy Taxonomy name.
+ * @return bool|array Array of `WP_Term` objects, if cached False if cache is empty for `$taxonomy` and `$id`.
*/
-function &get_object_term_cache($id, $taxonomy) {
- $cache = wp_cache_get($id, "{$taxonomy}_relationships");
- return $cache;
+function get_object_term_cache( $id, $taxonomy ) {
+ $_term_ids = wp_cache_get( $id, "{$taxonomy}_relationships" );
+
+ // We leave the priming of relationship caches to upstream functions.
+ if ( false === $_term_ids ) {
+ return false;
+ }
+
+ // Backward compatibility for if a plugin is putting objects into the cache, rather than IDs.
+ $term_ids = array();
+ foreach ( $_term_ids as $term_id ) {
+ if ( is_numeric( $term_id ) ) {
+ $term_ids[] = intval( $term_id );
+ } elseif ( isset( $term_id->term_id ) ) {
+ $term_ids[] = intval( $term_id->term_id );
+ }
+ }
+
+ // Fill the term objects.
+ _prime_term_caches( $term_ids );
+
+ $terms = array();
+ foreach ( $term_ids as $term_id ) {
+ $terms[] = wp_cache_get( $term_id, 'terms' );
+ }
+
+ return array_map( 'get_term', $terms );
}
/**
- * update_object_term_cache() - Updates the cache for Term ID(s)
+ * Updates the cache for the given term object ID(s).
*
- * Will only update the cache for terms not already cached.
+ * Note: Due to performance concerns, great care should be taken to only update
+ * term caches when necessary. Processing time can increase exponentially depending
+ * on both the number of passed term IDs and the number of taxonomies those terms
+ * belong to.
*
- * The $object_ids expects that the ids be separated by commas, if it is
- * a string.
+ * Caches will only be updated for terms not already cached.
*
- * It should be noted that update_object_term_cache() is very time extensive.
- * It is advised that the function is not called very often or at least not
- * for a lot of terms that exist in a lot of taxonomies. The amount of time
- * increases for each term and it also increases for each taxonomy the term
- * belongs to.
+ * @since 2.3.0
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
- * @uses wp_get_object_terms() Used to get terms from the database to update
- *
- * @param string|array $object_ids Single or list of term object ID(s)
- * @param array|string $object_type The taxonomy object type
- * @return null|bool Null value is given with empty $object_ids. False if
+ * @param string|array $object_ids Comma-separated list or array of term object IDs.
+ * @param array|string $object_type The taxonomy object type.
+ * @return void|false False if all of the terms in `$object_ids` are already cached.
*/
function update_object_term_cache($object_ids, $object_type) {
if ( empty($object_ids) )
if ( empty( $ids ) )
return false;
- $terms = wp_get_object_terms($ids, $taxonomies, 'fields=all_with_object_id');
+ $terms = wp_get_object_terms( $ids, $taxonomies, array(
+ 'fields' => 'all_with_object_id',
+ 'orderby' => 'name',
+ 'update_term_meta_cache' => false,
+ ) );
$object_terms = array();
- foreach ( (array) $terms as $term )
- $object_terms[$term->object_id][$term->taxonomy][$term->term_id] = $term;
+ foreach ( (array) $terms as $term ) {
+ $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id;
+ }
foreach ( $ids as $id ) {
- foreach ( $taxonomies as $taxonomy ) {
+ foreach ( $taxonomies as $taxonomy ) {
if ( ! isset($object_terms[$id][$taxonomy]) ) {
if ( !isset($object_terms[$id]) )
$object_terms[$id] = array();
foreach ( $object_terms as $id => $value ) {
foreach ( $value as $taxonomy => $terms ) {
- wp_cache_set($id, $terms, "{$taxonomy}_relationships");
+ wp_cache_add( $id, $terms, "{$taxonomy}_relationships" );
}
}
}
/**
- * update_term_cache() - Updates Terms to Taxonomy in cache.
+ * Updates Terms to Taxonomy in cache.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3
+ * @since 2.3.0
*
- * @param array $terms List of Term objects to change
- * @param string $taxonomy Optional. Update Term to this taxonomy in cache
+ * @param array $terms List of term objects to change.
+ * @param string $taxonomy Optional. Update Term to this taxonomy in cache. Default empty.
*/
-function update_term_cache($terms, $taxonomy = '') {
- foreach ( $terms as $term ) {
- $term_taxonomy = $taxonomy;
- if ( empty($term_taxonomy) )
- $term_taxonomy = $term->taxonomy;
+function update_term_cache( $terms, $taxonomy = '' ) {
+ foreach ( (array) $terms as $term ) {
+ // Create a copy in case the array was passed by reference.
+ $_term = clone $term;
- wp_cache_add($term->term_id, $term, $term_taxonomy);
+ // Object ID should not be cached.
+ unset( $_term->object_id );
+
+ wp_cache_add( $term->term_id, $_term, 'terms' );
}
}
//
/**
- * _get_term_hierarchy() - Retrieves children of taxonomy
- *
- * @package WordPress
- * @subpackage Taxonomy
- * @access private
- * @since 2.3
+ * Retrieves children of taxonomy as Term IDs.
*
- * @uses update_option() Stores all of the children in "$taxonomy_children" option.
- * That is the name of the taxonomy, immediately followed by '_children'.
+ * @ignore
+ * @since 2.3.0
*
- * @param string $taxonomy Taxonomy Name
- * @return array Empty if $taxonomy isn't hierarachical or returns children.
+ * @param string $taxonomy Taxonomy name.
+ * @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs.
*/
-function _get_term_hierarchy($taxonomy) {
+function _get_term_hierarchy( $taxonomy ) {
if ( !is_taxonomy_hierarchical($taxonomy) )
return array();
$children = get_option("{$taxonomy}_children");
+
if ( is_array($children) )
return $children;
-
$children = array();
- $terms = get_terms($taxonomy, 'get=all');
- foreach ( $terms as $term ) {
- if ( $term->parent > 0 )
- $children[$term->parent][] = $term->term_id;
+ $terms = get_terms($taxonomy, array('get' => 'all', 'orderby' => 'id', 'fields' => 'id=>parent'));
+ foreach ( $terms as $term_id => $parent ) {
+ if ( $parent > 0 )
+ $children[$parent][] = $term_id;
}
update_option("{$taxonomy}_children", $children);
}
/**
- * _get_term_children() - Get array of child terms
+ * Get the subset of $terms that are descendants of $term_id.
*
- * If $terms is an array of objects, then objects will returned from the function.
- * If $terms is an array of IDs, then an array of ids of children will be returned.
+ * If `$terms` is an array of objects, then _get_term_children() returns an array of objects.
+ * If `$terms` is an array of IDs, then _get_term_children() returns an array of IDs.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
- * @since 2.3
- *
- * @param int $term_id Look for this Term ID in $terms
- * @param array $terms List of Term IDs
- * @param string $taxonomy Term Context
- * @return array Empty if $terms is empty else returns full list of child terms.
+ * @since 2.3.0
+ *
+ * @param int $term_id The ancestor term: all returned terms should be descendants of `$term_id`.
+ * @param array $terms The set of terms - either an array of term objects or term IDs - from which those that
+ * are descendants of $term_id will be chosen.
+ * @param string $taxonomy The taxonomy which determines the hierarchy of the terms.
+ * @param array $ancestors Optional. Term ancestors that have already been identified. Passed by reference, to keep
+ * track of found terms when recursing the hierarchy. The array of located ancestors is used
+ * to prevent infinite recursion loops. For performance, `term_ids` are used as array keys,
+ * with 1 as value. Default empty array.
+ * @return array|WP_Error The subset of $terms that are descendants of $term_id.
*/
-function &_get_term_children($term_id, $terms, $taxonomy) {
+function _get_term_children( $term_id, $terms, $taxonomy, &$ancestors = array() ) {
$empty_array = array();
if ( empty($terms) )
return $empty_array;
if ( ( 0 != $term_id ) && ! isset($has_children[$term_id]) )
return $empty_array;
- foreach ( $terms as $term ) {
+ // Include the term itself in the ancestors array, so we can properly detect when a loop has occurred.
+ if ( empty( $ancestors ) ) {
+ $ancestors[ $term_id ] = 1;
+ }
+
+ foreach ( (array) $terms as $term ) {
$use_id = false;
if ( !is_object($term) ) {
$term = get_term($term, $taxonomy);
$use_id = true;
}
- if ( $term->term_id == $term_id )
+ // Don't recurse if we've already identified the term as a child - this indicates a loop.
+ if ( isset( $ancestors[ $term->term_id ] ) ) {
continue;
+ }
if ( $term->parent == $term_id ) {
if ( $use_id )
if ( !isset($has_children[$term->term_id]) )
continue;
- if ( $children = _get_term_children($term->term_id, $terms, $taxonomy) )
+ $ancestors[ $term->term_id ] = 1;
+
+ if ( $children = _get_term_children( $term->term_id, $terms, $taxonomy, $ancestors) )
$term_list = array_merge($term_list, $children);
}
}
}
/**
- * _pad_term_counts() - Add count of children to parent count
+ * Add count of children to parent count.
*
- * Recalculates term counts by including items from child terms.
- * Assumes all relevant children are already in the $terms argument
+ * Recalculates term counts by including items from child terms. Assumes all
+ * relevant children are already in the $terms argument.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param array $terms List of Term IDs
- * @param string $taxonomy Term Context
- * @return null Will break from function if conditions are not met.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $terms List of term objects, passed by reference.
+ * @param string $taxonomy Term context.
*/
-function _pad_term_counts(&$terms, $taxonomy) {
+function _pad_term_counts( &$terms, $taxonomy ) {
global $wpdb;
- // This function only works for post categories.
- if ( 'category' != $taxonomy )
+ // This function only works for hierarchical taxonomies like post categories.
+ if ( !is_taxonomy_hierarchical( $taxonomy ) )
return;
$term_hier = _get_term_hierarchy($taxonomy);
return;
$term_items = array();
+ $terms_by_id = array();
+ $term_ids = array();
- foreach ( $terms as $key => $term ) {
+ foreach ( (array) $terms as $key => $term ) {
$terms_by_id[$term->term_id] = & $terms[$key];
$term_ids[$term->term_taxonomy_id] = $term->term_id;
}
- // Get the object and term ids and stick them in a lookup table
- $results = $wpdb->get_results("SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships INNER JOIN $wpdb->posts ON object_id = ID WHERE term_taxonomy_id IN (".join(',', array_keys($term_ids)).") AND post_type = 'post' AND post_status = 'publish'");
+ // Get the object and term ids and stick them in a lookup table.
+ $tax_obj = get_taxonomy($taxonomy);
+ $object_types = esc_sql($tax_obj->object_type);
+ $results = $wpdb->get_results("SELECT object_id, term_taxonomy_id FROM $wpdb->term_relationships INNER JOIN $wpdb->posts ON object_id = ID WHERE term_taxonomy_id IN (" . implode(',', array_keys($term_ids)) . ") AND post_type IN ('" . implode("', '", $object_types) . "') AND post_status = 'publish'");
foreach ( $results as $row ) {
$id = $term_ids[$row->term_taxonomy_id];
- ++$term_items[$id][$row->object_id];
+ $term_items[$id][$row->object_id] = isset($term_items[$id][$row->object_id]) ? ++$term_items[$id][$row->object_id] : 1;
}
- // Touch every ancestor's lookup row for each post in each term
+ // Touch every ancestor's lookup row for each post in each term.
foreach ( $term_ids as $term_id ) {
$child = $term_id;
- while ( $parent = $terms_by_id[$child]->parent ) {
- if ( !empty($term_items[$term_id]) )
- foreach ( $term_items[$term_id] as $item_id => $touches )
- ++$term_items[$parent][$item_id];
+ $ancestors = array();
+ while ( !empty( $terms_by_id[$child] ) && $parent = $terms_by_id[$child]->parent ) {
+ $ancestors[] = $child;
+ if ( !empty( $term_items[$term_id] ) )
+ foreach ( $term_items[$term_id] as $item_id => $touches ) {
+ $term_items[$parent][$item_id] = isset($term_items[$parent][$item_id]) ? ++$term_items[$parent][$item_id]: 1;
+ }
$child = $parent;
+
+ if ( in_array( $parent, $ancestors ) ) {
+ break;
+ }
}
}
- // Transfer the touched cells
+ // Transfer the touched cells.
foreach ( (array) $term_items as $id => $items )
if ( isset($terms_by_id[$id]) )
$terms_by_id[$id]->count = count($items);
}
+/**
+ * Adds any terms from the given IDs to the cache that do not already exist in cache.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $term_ids Array of term IDs.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
+ */
+function _prime_term_caches( $term_ids, $update_meta_cache = true ) {
+ global $wpdb;
+
+ $non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' );
+ if ( ! empty( $non_cached_ids ) ) {
+ $fresh_terms = $wpdb->get_results( sprintf( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+ update_term_cache( $fresh_terms, $update_meta_cache );
+
+ if ( $update_meta_cache ) {
+ update_termmeta_cache( $non_cached_ids );
+ }
+ }
+}
+
//
// Default callbacks
//
/**
- * _update_post_term_count() - Will update term count based on posts
+ * Will update term count based on object types of the current taxonomy.
*
- * Private function for the default callback for post_tag and category taxonomies.
+ * Private function for the default callback for post_tag and category
+ * taxonomies.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
- * @since 2.3
- * @uses $wpdb
+ * @since 2.3.0
*
- * @param array $terms List of Term IDs
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $terms List of Term taxonomy IDs.
+ * @param object $taxonomy Current taxonomy object of terms.
*/
-function _update_post_term_count( $terms ) {
+function _update_post_term_count( $terms, $taxonomy ) {
global $wpdb;
- foreach ( $terms as $term ) {
- $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status = 'publish' AND post_type = 'post' AND term_taxonomy_id = %d", $term ) );
+ $object_types = (array) $taxonomy->object_type;
+
+ foreach ( $object_types as &$object_type )
+ list( $object_type ) = explode( ':', $object_type );
+
+ $object_types = array_unique( $object_types );
+
+ if ( false !== ( $check_attachments = array_search( 'attachment', $object_types ) ) ) {
+ unset( $object_types[ $check_attachments ] );
+ $check_attachments = true;
+ }
+
+ if ( $object_types )
+ $object_types = esc_sql( array_filter( $object_types, 'post_type_exists' ) );
+
+ foreach ( (array) $terms as $term ) {
+ $count = 0;
+
+ // Attachments can be 'inherit' status, we need to base count off the parent's status if so.
+ if ( $check_attachments )
+ $count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts p1 WHERE p1.ID = $wpdb->term_relationships.object_id AND ( post_status = 'publish' OR ( post_status = 'inherit' AND post_parent > 0 AND ( SELECT post_status FROM $wpdb->posts WHERE ID = p1.post_parent ) = 'publish' ) ) AND post_type = 'attachment' AND term_taxonomy_id = %d", $term ) );
+
+ if ( $object_types )
+ $count += (int) $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships, $wpdb->posts WHERE $wpdb->posts.ID = $wpdb->term_relationships.object_id AND post_status = 'publish' AND post_type IN ('" . implode("', '", $object_types ) . "') AND term_taxonomy_id = %d", $term ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edit_term_taxonomy', $term, $taxonomy->name );
$wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edited_term_taxonomy', $term, $taxonomy->name );
}
}
/**
- * get_term_link() - Generates a permalink for a taxonomy term archive
+ * Will update term count based on number of objects.
+ *
+ * Default callback for the 'link_category' taxonomy.
+ *
+ * @since 3.3.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param object|int|string $term
- * @param string $taxonomy
- * @return string HTML link to taxonomy term archive
+ * @param array $terms List of term taxonomy IDs.
+ * @param object $taxonomy Current taxonomy object of terms.
*/
-function get_term_link( $term, $taxonomy ) {
- global $wp_rewrite;
+function _update_generic_term_count( $terms, $taxonomy ) {
+ global $wpdb;
- // use legacy functions for core taxonomies until they are fully plugged in
- if ( $taxonomy == 'category' )
- return get_category_link($term);
- if ( $taxonomy == 'post_tag' )
- return get_tag_link($term);
+ foreach ( (array) $terms as $term ) {
+ $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term ) );
- $termlink = $wp_rewrite->get_extra_permastruct($taxonomy);
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edit_term_taxonomy', $term, $taxonomy->name );
+ $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edited_term_taxonomy', $term, $taxonomy->name );
+ }
+}
+
+/**
+ * Create a new term for a term_taxonomy item that currently shares its term
+ * with another term_taxonomy.
+ *
+ * @ignore
+ * @since 4.2.0
+ * @since 4.3.0 Introduced `$record` parameter. Also, `$term_id` and
+ * `$term_taxonomy_id` can now accept objects.
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int|object $term_id ID of the shared term, or the shared term object.
+ * @param int|object $term_taxonomy_id ID of the term_taxonomy item to receive a new term, or the term_taxonomy object
+ * (corresponding to a row from the term_taxonomy table).
+ * @param bool $record Whether to record data about the split term in the options table. The recording
+ * process has the potential to be resource-intensive, so during batch operations
+ * it can be beneficial to skip inline recording and do it just once, after the
+ * batch is processed. Only set this to `false` if you know what you are doing.
+ * Default: true.
+ * @return int|WP_Error When the current term does not need to be split (or cannot be split on the current
+ * database schema), `$term_id` is returned. When the term is successfully split, the
+ * new term_id is returned. A WP_Error is returned for miscellaneous errors.
+ */
+function _split_shared_term( $term_id, $term_taxonomy_id, $record = true ) {
+ global $wpdb;
+
+ if ( is_object( $term_id ) ) {
+ $shared_term = $term_id;
+ $term_id = intval( $shared_term->term_id );
+ }
+
+ if ( is_object( $term_taxonomy_id ) ) {
+ $term_taxonomy = $term_taxonomy_id;
+ $term_taxonomy_id = intval( $term_taxonomy->term_taxonomy_id );
+ }
+
+ // If there are no shared term_taxonomy rows, there's nothing to do here.
+ $shared_tt_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy tt WHERE tt.term_id = %d AND tt.term_taxonomy_id != %d", $term_id, $term_taxonomy_id ) );
+
+ if ( ! $shared_tt_count ) {
+ return $term_id;
+ }
+
+ /*
+ * Verify that the term_taxonomy_id passed to the function is actually associated with the term_id.
+ * If there's a mismatch, it may mean that the term is already split. Return the actual term_id from the db.
+ */
+ $check_term_id = $wpdb->get_var( $wpdb->prepare( "SELECT term_id FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );
+ if ( $check_term_id != $term_id ) {
+ return $check_term_id;
+ }
+
+ // Pull up data about the currently shared slug, which we'll use to populate the new one.
+ if ( empty( $shared_term ) ) {
+ $shared_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.* FROM $wpdb->terms t WHERE t.term_id = %d", $term_id ) );
+ }
+
+ $new_term_data = array(
+ 'name' => $shared_term->name,
+ 'slug' => $shared_term->slug,
+ 'term_group' => $shared_term->term_group,
+ );
+
+ if ( false === $wpdb->insert( $wpdb->terms, $new_term_data ) ) {
+ return new WP_Error( 'db_insert_error', __( 'Could not split shared term.' ), $wpdb->last_error );
+ }
+
+ $new_term_id = (int) $wpdb->insert_id;
+
+ // Update the existing term_taxonomy to point to the newly created term.
+ $wpdb->update( $wpdb->term_taxonomy,
+ array( 'term_id' => $new_term_id ),
+ array( 'term_taxonomy_id' => $term_taxonomy_id )
+ );
+
+ // Reassign child terms to the new parent.
+ if ( empty( $term_taxonomy ) ) {
+ $term_taxonomy = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $term_taxonomy_id ) );
+ }
+
+ $children_tt_ids = $wpdb->get_col( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_taxonomy WHERE parent = %d AND taxonomy = %s", $term_id, $term_taxonomy->taxonomy ) );
+ if ( ! empty( $children_tt_ids ) ) {
+ foreach ( $children_tt_ids as $child_tt_id ) {
+ $wpdb->update( $wpdb->term_taxonomy,
+ array( 'parent' => $new_term_id ),
+ array( 'term_taxonomy_id' => $child_tt_id )
+ );
+ clean_term_cache( $term_id, $term_taxonomy->taxonomy );
+ }
+ } else {
+ // If the term has no children, we must force its taxonomy cache to be rebuilt separately.
+ clean_term_cache( $new_term_id, $term_taxonomy->taxonomy );
+ }
+
+ // Clean the cache for term taxonomies formerly shared with the current term.
+ $shared_term_taxonomies = $wpdb->get_row( $wpdb->prepare( "SELECT taxonomy FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) );
+ if ( $shared_term_taxonomies ) {
+ foreach ( $shared_term_taxonomies as $shared_term_taxonomy ) {
+ clean_term_cache( $term_id, $shared_term_taxonomy );
+ }
+ }
+
+ // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term().
+ if ( $record ) {
+ $split_term_data = get_option( '_split_terms', array() );
+ if ( ! isset( $split_term_data[ $term_id ] ) ) {
+ $split_term_data[ $term_id ] = array();
+ }
+
+ $split_term_data[ $term_id ][ $term_taxonomy->taxonomy ] = $new_term_id;
+ update_option( '_split_terms', $split_term_data );
+ }
+
+ // If we've just split the final shared term, set the "finished" flag.
+ $shared_terms_exist = $wpdb->get_results(
+ "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt
+ LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id
+ GROUP BY t.term_id
+ HAVING term_tt_count > 1
+ LIMIT 1"
+ );
+ if ( ! $shared_terms_exist ) {
+ update_option( 'finished_splitting_shared_terms', true );
+ }
+
+ /**
+ * Fires after a previously shared taxonomy term is split into two separate terms.
+ *
+ * @since 4.2.0
+ *
+ * @param int $term_id ID of the formerly shared term.
+ * @param int $new_term_id ID of the new term created for the $term_taxonomy_id.
+ * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split.
+ * @param string $taxonomy Taxonomy for the split term.
+ */
+ do_action( 'split_shared_term', $term_id, $new_term_id, $term_taxonomy_id, $term_taxonomy->taxonomy );
+
+ return $new_term_id;
+}
+
+/**
+ * Splits a batch of shared taxonomy terms.
+ *
+ * @since 4.3.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ */
+function _wp_batch_split_terms() {
+ global $wpdb;
+
+ $lock_name = 'term_split.lock';
+
+ // Try to lock.
+ $lock_result = $wpdb->query( $wpdb->prepare( "INSERT IGNORE INTO `$wpdb->options` ( `option_name`, `option_value`, `autoload` ) VALUES (%s, %s, 'no') /* LOCK */", $lock_name, time() ) );
+
+ if ( ! $lock_result ) {
+ $lock_result = get_option( $lock_name );
+
+ // Bail if we were unable to create a lock, or if the existing lock is still valid.
+ if ( ! $lock_result || ( $lock_result > ( time() - HOUR_IN_SECONDS ) ) ) {
+ wp_schedule_single_event( time() + ( 5 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' );
+ return;
+ }
+ }
+
+ // Update the lock, as by this point we've definitely got a lock, just need to fire the actions.
+ update_option( $lock_name, time() );
+
+ // Get a list of shared terms (those with more than one associated row in term_taxonomy).
+ $shared_terms = $wpdb->get_results(
+ "SELECT tt.term_id, t.*, count(*) as term_tt_count FROM {$wpdb->term_taxonomy} tt
+ LEFT JOIN {$wpdb->terms} t ON t.term_id = tt.term_id
+ GROUP BY t.term_id
+ HAVING term_tt_count > 1
+ LIMIT 10"
+ );
+
+ // No more terms, we're done here.
+ if ( ! $shared_terms ) {
+ update_option( 'finished_splitting_shared_terms', true );
+ delete_option( $lock_name );
+ return;
+ }
+
+ // Shared terms found? We'll need to run this script again.
+ wp_schedule_single_event( time() + ( 2 * MINUTE_IN_SECONDS ), 'wp_split_shared_term_batch' );
+
+ // Rekey shared term array for faster lookups.
+ $_shared_terms = array();
+ foreach ( $shared_terms as $shared_term ) {
+ $term_id = intval( $shared_term->term_id );
+ $_shared_terms[ $term_id ] = $shared_term;
+ }
+ $shared_terms = $_shared_terms;
+
+ // Get term taxonomy data for all shared terms.
+ $shared_term_ids = implode( ',', array_keys( $shared_terms ) );
+ $shared_tts = $wpdb->get_results( "SELECT * FROM {$wpdb->term_taxonomy} WHERE `term_id` IN ({$shared_term_ids})" );
+
+ // Split term data recording is slow, so we do it just once, outside the loop.
+ $split_term_data = get_option( '_split_terms', array() );
+ $skipped_first_term = $taxonomies = array();
+ foreach ( $shared_tts as $shared_tt ) {
+ $term_id = intval( $shared_tt->term_id );
+
+ // Don't split the first tt belonging to a given term_id.
+ if ( ! isset( $skipped_first_term[ $term_id ] ) ) {
+ $skipped_first_term[ $term_id ] = 1;
+ continue;
+ }
+
+ if ( ! isset( $split_term_data[ $term_id ] ) ) {
+ $split_term_data[ $term_id ] = array();
+ }
+
+ // Keep track of taxonomies whose hierarchies need flushing.
+ if ( ! isset( $taxonomies[ $shared_tt->taxonomy ] ) ) {
+ $taxonomies[ $shared_tt->taxonomy ] = 1;
+ }
+
+ // Split the term.
+ $split_term_data[ $term_id ][ $shared_tt->taxonomy ] = _split_shared_term( $shared_terms[ $term_id ], $shared_tt, false );
+ }
+
+ // Rebuild the cached hierarchy for each affected taxonomy.
+ foreach ( array_keys( $taxonomies ) as $tax ) {
+ delete_option( "{$tax}_children" );
+ _get_term_hierarchy( $tax );
+ }
+
+ update_option( '_split_terms', $split_term_data );
+
+ delete_option( $lock_name );
+}
+
+/**
+ * In order to avoid the _wp_batch_split_terms() job being accidentally removed,
+ * check that it's still scheduled while we haven't finished splitting terms.
+ *
+ * @ignore
+ * @since 4.3.0
+ */
+function _wp_check_for_scheduled_split_terms() {
+ if ( ! get_option( 'finished_splitting_shared_terms' ) && ! wp_next_scheduled( 'wp_split_shared_term_batch' ) ) {
+ wp_schedule_single_event( time() + MINUTE_IN_SECONDS, 'wp_split_shared_term_batch' );
+ }
+}
+
+/**
+ * Check default categories when a term gets split to see if any of them need to be updated.
+ *
+ * @ignore
+ * @since 4.2.0
+ *
+ * @param int $term_id ID of the formerly shared term.
+ * @param int $new_term_id ID of the new term created for the $term_taxonomy_id.
+ * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split.
+ * @param string $taxonomy Taxonomy for the split term.
+ */
+function _wp_check_split_default_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) {
+ if ( 'category' != $taxonomy ) {
+ return;
+ }
+
+ foreach ( array( 'default_category', 'default_link_category', 'default_email_category' ) as $option ) {
+ if ( $term_id == get_option( $option, -1 ) ) {
+ update_option( $option, $new_term_id );
+ }
+ }
+}
+
+/**
+ * Check menu items when a term gets split to see if any of them need to be updated.
+ *
+ * @ignore
+ * @since 4.2.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $term_id ID of the formerly shared term.
+ * @param int $new_term_id ID of the new term created for the $term_taxonomy_id.
+ * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split.
+ * @param string $taxonomy Taxonomy for the split term.
+ */
+function _wp_check_split_terms_in_menus( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) {
+ global $wpdb;
+ $post_ids = $wpdb->get_col( $wpdb->prepare(
+ "SELECT m1.post_id
+ FROM {$wpdb->postmeta} AS m1
+ INNER JOIN {$wpdb->postmeta} AS m2 ON ( m2.post_id = m1.post_id )
+ INNER JOIN {$wpdb->postmeta} AS m3 ON ( m3.post_id = m1.post_id )
+ WHERE ( m1.meta_key = '_menu_item_type' AND m1.meta_value = 'taxonomy' )
+ AND ( m2.meta_key = '_menu_item_object' AND m2.meta_value = '%s' )
+ AND ( m3.meta_key = '_menu_item_object_id' AND m3.meta_value = %d )",
+ $taxonomy,
+ $term_id
+ ) );
+
+ if ( $post_ids ) {
+ foreach ( $post_ids as $post_id ) {
+ update_post_meta( $post_id, '_menu_item_object_id', $new_term_id, $term_id );
+ }
+ }
+}
+
+/**
+ * If the term being split is a nav_menu, change associations.
+ *
+ * @ignore
+ * @since 4.3.0
+ *
+ * @param int $term_id ID of the formerly shared term.
+ * @param int $new_term_id ID of the new term created for the $term_taxonomy_id.
+ * @param int $term_taxonomy_id ID for the term_taxonomy row affected by the split.
+ * @param string $taxonomy Taxonomy for the split term.
+ */
+function _wp_check_split_nav_menu_terms( $term_id, $new_term_id, $term_taxonomy_id, $taxonomy ) {
+ if ( 'nav_menu' !== $taxonomy ) {
+ return;
+ }
+
+ // Update menu locations.
+ $locations = get_nav_menu_locations();
+ foreach ( $locations as $location => $menu_id ) {
+ if ( $term_id == $menu_id ) {
+ $locations[ $location ] = $new_term_id;
+ }
+ }
+ set_theme_mod( 'nav_menu_locations', $locations );
+}
+
+/**
+ * Get data about terms that previously shared a single term_id, but have since been split.
+ *
+ * @since 4.2.0
+ *
+ * @param int $old_term_id Term ID. This is the old, pre-split term ID.
+ * @return array Array of new term IDs, keyed by taxonomy.
+ */
+function wp_get_split_terms( $old_term_id ) {
+ $split_terms = get_option( '_split_terms', array() );
+
+ $terms = array();
+ if ( isset( $split_terms[ $old_term_id ] ) ) {
+ $terms = $split_terms[ $old_term_id ];
+ }
+
+ return $terms;
+}
+
+/**
+ * Get the new term ID corresponding to a previously split term.
+ *
+ * @since 4.2.0
+ *
+ * @param int $old_term_id Term ID. This is the old, pre-split term ID.
+ * @param string $taxonomy Taxonomy that the term belongs to.
+ * @return int|false If a previously split term is found corresponding to the old term_id and taxonomy,
+ * the new term_id will be returned. If no previously split term is found matching
+ * the parameters, returns false.
+ */
+function wp_get_split_term( $old_term_id, $taxonomy ) {
+ $split_terms = wp_get_split_terms( $old_term_id );
+
+ $term_id = false;
+ if ( isset( $split_terms[ $taxonomy ] ) ) {
+ $term_id = (int) $split_terms[ $taxonomy ];
+ }
+
+ return $term_id;
+}
+
+/**
+ * Determine whether a term is shared between multiple taxonomies.
+ *
+ * Shared taxonomy terms began to be split in 4.3, but failed cron tasks or other delays in upgrade routines may cause
+ * shared terms to remain.
+ *
+ * @since 4.4.0
+ *
+ * @param int $term_id
+ * @return bool
+ */
+function wp_term_is_shared( $term_id ) {
+ global $wpdb;
+
+ if ( get_option( 'finished_splitting_shared_terms' ) ) {
+ return false;
+ }
+
+ $tt_count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = %d", $term_id ) );
+
+ return $tt_count > 1;
+}
+
+/**
+ * Generate a permalink for a taxonomy term archive.
+ *
+ * @since 2.5.0
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param object|int|string $term The term object, ID, or slug whose link will be retrieved.
+ * @param string $taxonomy Optional. Taxonomy. Default empty.
+ * @return string|WP_Error HTML link to taxonomy term archive on success, WP_Error if term does not exist.
+ */
+function get_term_link( $term, $taxonomy = '' ) {
+ global $wp_rewrite;
if ( !is_object($term) ) {
- if ( is_int($term) ) {
- $term = &get_term($term, $taxonomy);
+ if ( is_int( $term ) ) {
+ $term = get_term( $term, $taxonomy );
} else {
- $term = &get_term_by('slug', $term, $taxonomy);
+ $term = get_term_by( 'slug', $term, $taxonomy );
}
}
+
+ if ( !is_object($term) )
+ $term = new WP_Error('invalid_term', __('Empty Term'));
+
if ( is_wp_error( $term ) )
return $term;
+ $taxonomy = $term->taxonomy;
+
+ $termlink = $wp_rewrite->get_extra_permastruct($taxonomy);
+
$slug = $term->slug;
+ $t = get_taxonomy($taxonomy);
if ( empty($termlink) ) {
- $file = get_option('home') . '/';
- $t = get_taxonomy($taxonomy);
- if ( $t->query_var )
- $termlink = "$file?$t->query_var=$slug";
+ if ( 'category' == $taxonomy )
+ $termlink = '?cat=' . $term->term_id;
+ elseif ( $t->query_var )
+ $termlink = "?$t->query_var=$slug";
else
- $termlink = "$file?taxonomy=$taxonomy&term=$slug";
+ $termlink = "?taxonomy=$taxonomy&term=$slug";
+ $termlink = home_url($termlink);
} else {
- $termlink = str_replace("%$taxonomy%", $slug, $termlink);
- $termlink = get_option('home') . user_trailingslashit($termlink, 'category');
+ if ( $t->rewrite['hierarchical'] ) {
+ $hierarchical_slugs = array();
+ $ancestors = get_ancestors( $term->term_id, $taxonomy, 'taxonomy' );
+ foreach ( (array)$ancestors as $ancestor ) {
+ $ancestor_term = get_term($ancestor, $taxonomy);
+ $hierarchical_slugs[] = $ancestor_term->slug;
+ }
+ $hierarchical_slugs = array_reverse($hierarchical_slugs);
+ $hierarchical_slugs[] = $slug;
+ $termlink = str_replace("%$taxonomy%", implode('/', $hierarchical_slugs), $termlink);
+ } else {
+ $termlink = str_replace("%$taxonomy%", $slug, $termlink);
+ }
+ $termlink = home_url( user_trailingslashit($termlink, 'category') );
+ }
+ // Back Compat filters.
+ if ( 'post_tag' == $taxonomy ) {
+
+ /**
+ * Filters the tag link.
+ *
+ * @since 2.3.0
+ * @deprecated 2.5.0 Use 'term_link' instead.
+ *
+ * @param string $termlink Tag link URL.
+ * @param int $term_id Term ID.
+ */
+ $termlink = apply_filters( 'tag_link', $termlink, $term->term_id );
+ } elseif ( 'category' == $taxonomy ) {
+
+ /**
+ * Filters the category link.
+ *
+ * @since 1.5.0
+ * @deprecated 2.5.0 Use 'term_link' instead.
+ *
+ * @param string $termlink Category link URL.
+ * @param int $term_id Term ID.
+ */
+ $termlink = apply_filters( 'category_link', $termlink, $term->term_id );
}
- return apply_filters('term_link', $termlink, $term, $taxonomy);
+
+ /**
+ * Filters the term link.
+ *
+ * @since 2.5.0
+ *
+ * @param string $termlink Term link URL.
+ * @param object $term Term object.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ return apply_filters( 'term_link', $termlink, $term, $taxonomy );
}
-function the_taxonomies($args = array()) {
+/**
+ * Display the taxonomies of a post with available options.
+ *
+ * This function can be used within the loop to display the taxonomies for a
+ * post without specifying the Post ID. You can also use it outside the Loop to
+ * display the taxonomies for a specific post.
+ *
+ * @since 2.5.0
+ *
+ * @param array $args {
+ * Arguments about which post to use and how to format the output. Shares all of the arguments
+ * supported by get_the_taxonomies(), in addition to the following.
+ *
+ * @type int|WP_Post $post Post ID or object to get taxonomies of. Default current post.
+ * @type string $before Displays before the taxonomies. Default empty string.
+ * @type string $sep Separates each taxonomy. Default is a space.
+ * @type string $after Displays after the taxonomies. Default empty string.
+ * }
+ */
+function the_taxonomies( $args = array() ) {
$defaults = array(
'post' => 0,
'before' => '',
);
$r = wp_parse_args( $args, $defaults );
- extract( $r, EXTR_SKIP );
- echo $before . join($sep, get_the_taxonomies($post)) . $after;
+ echo $r['before'] . join( $r['sep'], get_the_taxonomies( $r['post'], $r ) ) . $r['after'];
}
-function get_the_taxonomies($post = 0) {
- if ( is_int($post) )
- $post =& get_post($post);
- elseif ( !is_object($post) )
- $post =& $GLOBALS['post'];
+/**
+ * Retrieve all taxonomies associated with a post.
+ *
+ * This function can be used within the loop. It will also return an array of
+ * the taxonomies with links to the taxonomy and name.
+ *
+ * @since 2.5.0
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @param array $args {
+ * Optional. Arguments about how to format the list of taxonomies. Default empty array.
+ *
+ * @type string $template Template for displaying a taxonomy label and list of terms.
+ * Default is "Label: Terms."
+ * @type string $term_template Template for displaying a single term in the list. Default is the term name
+ * linked to its archive.
+ * }
+ * @return array List of taxonomies.
+ */
+function get_the_taxonomies( $post = 0, $args = array() ) {
+ $post = get_post( $post );
+
+ $args = wp_parse_args( $args, array(
+ /* translators: %s: taxonomy label, %l: list of terms formatted as per $term_template */
+ 'template' => __( '%s: %l.' ),
+ 'term_template' => '<a href="%1$s">%2$s</a>',
+ ) );
$taxonomies = array();
- if ( !$post )
+ if ( ! $post ) {
return $taxonomies;
+ }
- $template = apply_filters('taxonomy_template', '%s: %l.');
-
- foreach ( get_object_taxonomies($post) as $taxonomy ) {
- $t = (array) get_taxonomy($taxonomy);
- if ( empty($t['label']) )
+ foreach ( get_object_taxonomies( $post ) as $taxonomy ) {
+ $t = (array) get_taxonomy( $taxonomy );
+ if ( empty( $t['label'] ) ) {
$t['label'] = $taxonomy;
- if ( empty($t['args']) )
+ }
+ if ( empty( $t['args'] ) ) {
$t['args'] = array();
- if ( empty($t['template']) )
- $t['template'] = $template;
-
- $terms = get_object_term_cache($post->ID, $taxonomy);
- if ( empty($terms) )
- $terms = wp_get_object_terms($post->ID, $taxonomy, $t['args']);
+ }
+ if ( empty( $t['template'] ) ) {
+ $t['template'] = $args['template'];
+ }
+ if ( empty( $t['term_template'] ) ) {
+ $t['term_template'] = $args['term_template'];
+ }
+ $terms = get_object_term_cache( $post->ID, $taxonomy );
+ if ( false === $terms ) {
+ $terms = wp_get_object_terms( $post->ID, $taxonomy, $t['args'] );
+ }
$links = array();
- foreach ( $terms as $term )
- $links[] = "<a href='" . attribute_escape(get_term_link($term, $taxonomy)) . "'>$term->name</a>";
-
- if ( $links )
- $taxonomies[$taxonomy] = wp_sprintf($t['template'], $t['label'], $links, $terms);
+ foreach ( $terms as $term ) {
+ $links[] = wp_sprintf( $t['term_template'], esc_attr( get_term_link( $term ) ), $term->name );
+ }
+ if ( $links ) {
+ $taxonomies[$taxonomy] = wp_sprintf( $t['template'], $t['label'], $links, $terms );
+ }
}
return $taxonomies;
}
-function get_post_taxonomies($post = 0) {
- $post =& get_post($post);
+/**
+ * Retrieve all taxonomies of a post with just the names.
+ *
+ * @since 2.5.0
+ *
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @return array
+ */
+function get_post_taxonomies( $post = 0 ) {
+ $post = get_post( $post );
return get_object_taxonomies($post);
}
-?>
+/**
+ * Determine if the given object is associated with any of the given terms.
+ *
+ * The given terms are checked against the object's terms' term_ids, names and slugs.
+ * Terms given as integers will only be checked against the object's terms' term_ids.
+ * If no terms are given, determines if object is associated with any terms in the given taxonomy.
+ *
+ * @since 2.7.0
+ *
+ * @param int $object_id ID of the object (post ID, link ID, ...).
+ * @param string $taxonomy Single taxonomy name.
+ * @param int|string|array $terms Optional. Term term_id, name, slug or array of said. Default null.
+ * @return bool|WP_Error WP_Error on input error.
+ */
+function is_object_in_term( $object_id, $taxonomy, $terms = null ) {
+ if ( !$object_id = (int) $object_id )
+ return new WP_Error( 'invalid_object', __( 'Invalid object ID' ) );
+
+ $object_terms = get_object_term_cache( $object_id, $taxonomy );
+ if ( false === $object_terms ) {
+ $object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) );
+ if ( is_wp_error( $object_terms ) ) {
+ return $object_terms;
+ }
+
+ wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" );
+ }
+
+ if ( is_wp_error( $object_terms ) )
+ return $object_terms;
+ if ( empty( $object_terms ) )
+ return false;
+ if ( empty( $terms ) )
+ return ( !empty( $object_terms ) );
+
+ $terms = (array) $terms;
+
+ if ( $ints = array_filter( $terms, 'is_int' ) )
+ $strs = array_diff( $terms, $ints );
+ else
+ $strs =& $terms;
+
+ foreach ( $object_terms as $object_term ) {
+ // If term is an int, check against term_ids only.
+ if ( $ints && in_array( $object_term->term_id, $ints ) ) {
+ return true;
+ }
+
+ if ( $strs ) {
+ // Only check numeric strings against term_id, to avoid false matches due to type juggling.
+ $numeric_strs = array_map( 'intval', array_filter( $strs, 'is_numeric' ) );
+ if ( in_array( $object_term->term_id, $numeric_strs, true ) ) {
+ return true;
+ }
+
+ if ( in_array( $object_term->name, $strs ) ) return true;
+ if ( in_array( $object_term->slug, $strs ) ) return true;
+ }
+ }
+
+ return false;
+}
+
+/**
+ * Determine if the given object type is associated with the given taxonomy.
+ *
+ * @since 3.0.0
+ *
+ * @param string $object_type Object type string.
+ * @param string $taxonomy Single taxonomy name.
+ * @return bool True if object is associated with the taxonomy, otherwise false.
+ */
+function is_object_in_taxonomy( $object_type, $taxonomy ) {
+ $taxonomies = get_object_taxonomies( $object_type );
+ if ( empty( $taxonomies ) ) {
+ return false;
+ }
+ return in_array( $taxonomy, $taxonomies );
+}
+
+/**
+ * Get an array of ancestor IDs for a given object.
+ *
+ * @since 3.1.0
+ * @since 4.1.0 Introduced the `$resource_type` argument.
+ *
+ * @param int $object_id Optional. The ID of the object. Default 0.
+ * @param string $object_type Optional. The type of object for which we'll be retrieving
+ * ancestors. Accepts a post type or a taxonomy name. Default empty.
+ * @param string $resource_type Optional. Type of resource $object_type is. Accepts 'post_type'
+ * or 'taxonomy'. Default empty.
+ * @return array An array of ancestors from lowest to highest in the hierarchy.
+ */
+function get_ancestors( $object_id = 0, $object_type = '', $resource_type = '' ) {
+ $object_id = (int) $object_id;
+
+ $ancestors = array();
+
+ if ( empty( $object_id ) ) {
+
+ /** This filter is documented in wp-includes/taxonomy.php */
+ return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
+ }
+
+ if ( ! $resource_type ) {
+ if ( is_taxonomy_hierarchical( $object_type ) ) {
+ $resource_type = 'taxonomy';
+ } elseif ( post_type_exists( $object_type ) ) {
+ $resource_type = 'post_type';
+ }
+ }
+
+ if ( 'taxonomy' === $resource_type ) {
+ $term = get_term($object_id, $object_type);
+ while ( ! is_wp_error($term) && ! empty( $term->parent ) && ! in_array( $term->parent, $ancestors ) ) {
+ $ancestors[] = (int) $term->parent;
+ $term = get_term($term->parent, $object_type);
+ }
+ } elseif ( 'post_type' === $resource_type ) {
+ $ancestors = get_post_ancestors($object_id);
+ }
+
+ /**
+ * Filters a given object's ancestors.
+ *
+ * @since 3.1.0
+ * @since 4.1.1 Introduced the `$resource_type` parameter.
+ *
+ * @param array $ancestors An array of object ancestors.
+ * @param int $object_id Object ID.
+ * @param string $object_type Type of object.
+ * @param string $resource_type Type of resource $object_type is.
+ */
+ return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type, $resource_type );
+}
+
+/**
+ * Returns the term's parent's term_ID.
+ *
+ * @since 3.1.0
+ *
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy name.
+ * @return int|false False on error.
+ */
+function wp_get_term_taxonomy_parent_id( $term_id, $taxonomy ) {
+ $term = get_term( $term_id, $taxonomy );
+ if ( ! $term || is_wp_error( $term ) ) {
+ return false;
+ }
+ return (int) $term->parent;
+}
+
+/**
+ * Checks the given subset of the term hierarchy for hierarchy loops.
+ * Prevents loops from forming and breaks those that it finds.
+ *
+ * Attached to the {@see 'wp_update_term_parent'} filter.
+ *
+ * @since 3.1.0
+ *
+ * @param int $parent `term_id` of the parent for the term we're checking.
+ * @param int $term_id The term we're checking.
+ * @param string $taxonomy The taxonomy of the term we're checking.
+ *
+ * @return int The new parent for the term.
+ */
+function wp_check_term_hierarchy_for_loops( $parent, $term_id, $taxonomy ) {
+ // Nothing fancy here - bail
+ if ( !$parent )
+ return 0;
+
+ // Can't be its own parent.
+ if ( $parent == $term_id )
+ return 0;
+
+ // Now look for larger loops.
+ if ( !$loop = wp_find_hierarchy_loop( 'wp_get_term_taxonomy_parent_id', $term_id, $parent, array( $taxonomy ) ) )
+ return $parent; // No loop
+
+ // Setting $parent to the given value causes a loop.
+ if ( isset( $loop[$term_id] ) )
+ return 0;
+
+ // There's a loop, but it doesn't contain $term_id. Break the loop.
+ foreach ( array_keys( $loop ) as $loop_member )
+ wp_update_term( $loop_member, $taxonomy, array( 'parent' => 0 ) );
+
+ return $parent;
+}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff