//
/**
- * Creates the initial taxonomies when 'init' action is fired.
+ * Creates the initial taxonomies.
+ *
+ * This function fires twice: in wp-settings.php before plugins are loaded (for
+ * backwards compatibility reasons), and again on the 'init' action. We must avoid
+ * registering rewrite rules before the 'init' action.
*/
function create_initial_taxonomies() {
- register_taxonomy( 'category', 'post', array('hierarchical' => true, 'update_count_callback' => '_update_post_term_count', 'label' => __('Categories'), 'query_var' => false, 'rewrite' => false) ) ;
- register_taxonomy( 'post_tag', 'post', array('hierarchical' => false, 'update_count_callback' => '_update_post_term_count', 'label' => __('Post Tags'), 'query_var' => false, 'rewrite' => false) ) ;
- register_taxonomy( 'link_category', 'link', array('hierarchical' => false, 'label' => __('Categories'), 'query_var' => false, 'rewrite' => false) ) ;
+ global $wp_rewrite;
+
+ if ( ! did_action( 'init' ) ) {
+ $rewrite = array( 'category' => false, 'post_tag' => false, 'post_format' => false );
+ } else {
+
+ /**
+ * Filter 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(
+ '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' => false,
+ '_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' ),
+ ) );
}
add_action( 'init', 'create_initial_taxonomies', 0 ); // highest priority
+/**
+ * Get a list of registered taxonomy objects.
+ *
+ * @since 3.0.0
+ * @uses $wp_taxonomies
+ * @see register_taxonomy
+ *
+ * @param array $args An array of key => value arguments to match against the taxonomy objects.
+ * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
+ * @param string $operator The logical operation to perform. 'or' means only one element
+ * from the array needs to match; 'and' means all elements must match. The default is '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 all of the taxonomy names that are of $object_type.
*
* <code><?php $taxonomies = get_object_taxonomies('post'); ?></code> Should
* result in <code>Array('category', 'post_tag')</code>
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses $wp_taxonomies
*
* @param array|string|object $object Name of the type of taxonomy object, or an object (row from posts)
+ * @param string $output The type of output to return, either taxonomy 'names' or 'objects'. 'names' is the default.
* @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 ( (array) $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;
* 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.0
*
* @uses $wp_taxonomies
- * @uses is_taxonomy() Checks whether taxonomy exists
+ * @uses taxonomy_exists() Checks whether taxonomy exists
*
* @param string $taxonomy Name of taxonomy object to return
* @return object|bool 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];
/**
* Checks that the taxonomy name exists.
*
- * @package WordPress
- * @subpackage Taxonomy
- * @since 2.3.0
+ * Formerly is_taxonomy(), introduced in 2.3.0.
+ *
+ * @since 3.0.0
*
* @uses $wp_taxonomies
*
* @param string $taxonomy Name of taxonomy object
- * @return bool Whether the taxonomy exists or not.
+ * @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] );
}
/**
*
* A false return value might also mean that the taxonomy does not exist.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
- * @uses is_taxonomy() Checks whether taxonomy exists
+ * @uses taxonomy_exists() 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
*/
function is_taxonomy_hierarchical($taxonomy) {
- if ( ! is_taxonomy($taxonomy) )
+ if ( ! taxonomy_exists($taxonomy) )
return false;
$taxonomy = get_taxonomy($taxonomy);
* parameter), along with strings for the taxonomy name and another string for
* the object type.
*
- * Nothing is returned, so expect error maybe or use is_taxonomy() to check
+ * Nothing is returned, so expect error maybe or use taxonomy_exists() to check
* whether taxonomy exists.
*
* 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.
+ * - label - Name of the taxonomy shown in the menu. Usually plural. If not set, labels['name'] will be used.
+ * - labels - An array of labels for this taxonomy.
+ * * By default tag labels are used for non-hierarchical types and category labels for hierarchical ones.
+ * * You can see accepted values in {@link get_taxonomy_labels()}.
+ * - description - A short descriptive summary of what the taxonomy is for. Defaults to blank.
+ * - public - If the taxonomy should be publicly queryable; //@TODO not implemented.
+ * * Defaults to true.
+ * - hierarchical - Whether the taxonomy is hierarchical (e.g. category). Defaults to false.
+ * - show_ui - Whether to generate a default UI for managing this taxonomy in the admin.
+ * * If not set, the default is inherited from public.
+ * - 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, the default is inherited from show_ui.
+ * - show_in_nav_menus - Makes this taxonomy available for selection in navigation menus.
+ * * If not set, the default is inherited from public.
+ * - show_tagcloud - Whether to list the taxonomy in the Tag Cloud Widget.
+ * * If not set, the default is inherited from show_ui.
+ * - show_admin_column - Whether to display a column for the taxonomy on its post type listing screens.
+ * * Defaults to false.
+ * - meta_box_cb - Provide a callback function for the meta box display.
+ * * If not set, defaults to post_categories_meta_box for hierarchical taxonomies
+ * and post_tags_meta_box for non-hierarchical.
+ * * If false, no meta box is shown.
+ * - capabilities - Array of capabilities for this taxonomy.
+ * * You can see accepted values in this function.
+ * - rewrite - Triggers the handling of rewrites for this taxonomy. Defaults to 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
+ * * 'slug' => string Customize the permastruct slug. Defaults to $taxonomy key
+ * * 'with_front' => bool Should the permastruct be prepended with WP_Rewrite::$front. Defaults to true.
+ * * 'hierarchical' => bool Either hierarchical rewrite tag or not. Defaults to false.
+ * * 'ep_mask' => const Assign an endpoint mask.
+ * * If not specified, defaults to EP_NONE.
+ * - query_var - Sets the query_var key for this taxonomy. Defaults to $taxonomy key
+ * * If false, a taxonomy cannot be loaded at ?{query_var}={term_slug}
+ * * If specified as a string, the query ?{query_var_string}={term_slug} will be valid.
+ * - update_count_callback - Works much like a hook, in that it will be called when the count is updated.
+ * * Defaults to _update_post_term_count() for taxonomies attached to post types, which then confirms
+ * that the objects are published before counting them.
+ * * Defaults to _update_generic_term_count() for taxonomies attached to other object types, such as links.
+ * - _builtin - true if this taxonomy is a native or "built-in" taxonomy. THIS IS FOR INTERNAL USE ONLY!
*
- * query_var - false to prevent queries, or string to customize query var
- * (?$query_var=$term); default will use $taxonomy as query var.
- *
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses $wp_taxonomies Inserts new taxonomy object into the list
- * @uses $wp_rewrite Adds rewrite tags and permastructs
* @uses $wp Adds query vars
*
- * @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 See optional args description above.
+ * @return null|WP_Error WP_Error if errors, otherwise null.
*/
function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
- global $wp_taxonomies, $wp_rewrite, $wp;
+ global $wp_taxonomies, $wp;
- if (!is_array($wp_taxonomies))
+ if ( ! is_array( $wp_taxonomies ) )
$wp_taxonomies = array();
- $defaults = array('hierarchical' => false, 'update_count_callback' => '', 'rewrite' => true, 'query_var' => true);
- $args = wp_parse_args($args, $defaults);
+ $defaults = array(
+ 'labels' => array(),
+ 'description' => '',
+ 'public' => true,
+ 'hierarchical' => false,
+ 'show_ui' => null,
+ 'show_in_menu' => null,
+ 'show_in_nav_menus' => null,
+ 'show_tagcloud' => null,
+ 'show_admin_column' => false,
+ 'meta_box_cb' => null,
+ 'capabilities' => array(),
+ 'rewrite' => true,
+ 'query_var' => $taxonomy,
+ 'update_count_callback' => '',
+ '_builtin' => false,
+ );
+ $args = wp_parse_args( $args, $defaults );
+
+ if ( strlen( $taxonomy ) > 32 ) {
+ _doing_it_wrong( __FUNCTION__, __( 'Taxonomies cannot exceed 32 characters in length' ), '4.0' );
+ return new WP_Error( 'taxonomy_too_long', __( 'Taxonomies cannot exceed 32 characters in length' ) );
+ }
- if ( false !== $args['query_var'] && !empty($wp) ) {
+ if ( false !== $args['query_var'] && ! 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'] );
}
- 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 ( 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 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'];
+
+ $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 metabox
+ 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 );
+}
+
+/**
+ * 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 <code>parent_item</code>, but with colon <code>:</code> 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 - This string isn't used on hierarchical taxonomies. Default is "No tags found", used in the meta box.
+ *
+ * Above, the first default value is for non-hierarchical taxonomies (like tags) and the second one is for hierarchical taxonomies (like categories).
+ *
+ * @since 3.0.0
+ * @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.' ), null ),
+ );
+ $nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];
+
+ return _get_custom_object_labels( $tax, $nohier_vs_hier_defaults );
+}
+
+/**
+ * Add an already registered taxonomy to an object type.
+ *
+ * @since 3.0.0
+ * @uses $wp_taxonomies Modifies taxonomy object
+ *
+ * @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;
+
+ return true;
+}
+
+/**
+ * Remove an already registered taxonomy from an object type.
+ *
+ * @since 3.7.0
+ *
+ * @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;
}
//
* 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.0
*
* @uses $wpdb
* @uses wp_parse_args() Creates an array from string $args.
*
- * @param string|array $terms String of term or array of string values of terms that will be used
+ * @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);
-
+ if ( ! is_array( $term_ids ) ) {
+ $term_ids = array( $term_ids );
+ }
+ if ( ! is_array( $taxonomies ) ) {
+ $taxonomies = array( $taxonomies );
+ }
foreach ( (array) $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' ) );
+ }
}
- $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( "', '", $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;
}
+/**
+ * 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 );
+}
+
+/**
+ * Container class for a multiple taxonomy query.
+ *
+ * @since 3.1.0
+ */
+class WP_Tax_Query {
+
+ /**
+ * List of taxonomy queries. A single taxonomy query is an associative array:
+ * - 'taxonomy' string The taxonomy being queried. Optional when using the term_taxonomy_id field.
+ * - 'terms' string|array The list of terms
+ * - 'field' string (optional) Which term field is being used.
+ * Possible values: 'term_id', 'slug', 'name', or 'term_taxonomy_id'
+ * Default: 'term_id'
+ * - 'operator' string (optional)
+ * Possible values: 'AND', 'IN' or 'NOT IN'.
+ * Default: 'IN'
+ * - 'include_children' bool (optional) Whether to include child terms. Requires that a taxonomy be specified.
+ * Default: true
+ *
+ * @since 3.1.0
+ * @access public
+ * @var array
+ */
+ public $queries = array();
+
+ /**
+ * The relation between the queries. Can be one of 'AND' or 'OR'.
+ *
+ * @since 3.1.0
+ * @access public
+ * @var string
+ */
+ public $relation;
+
+ /**
+ * Standard response when the query should not return any rows.
+ *
+ * @since 3.2.0
+ * @access private
+ * @var string
+ */
+ private static $no_results = array( 'join' => '', 'where' => ' AND 0 = 1' );
+
+ /**
+ * Constructor.
+ *
+ * Parses a compact tax query and sets defaults.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @param array $tax_query A compact tax query:
+ * array(
+ * 'relation' => 'OR',
+ * array(
+ * 'taxonomy' => 'tax1',
+ * 'terms' => array( 'term1', 'term2' ),
+ * 'field' => 'slug',
+ * ),
+ * array(
+ * 'taxonomy' => 'tax2',
+ * 'terms' => array( 'term-a', 'term-b' ),
+ * 'field' => 'slug',
+ * ),
+ * )
+ */
+ public function __construct( $tax_query ) {
+ if ( isset( $tax_query['relation'] ) && strtoupper( $tax_query['relation'] ) == 'OR' ) {
+ $this->relation = 'OR';
+ } else {
+ $this->relation = 'AND';
+ }
+
+ $defaults = array(
+ 'taxonomy' => '',
+ 'terms' => array(),
+ 'include_children' => true,
+ 'field' => 'term_id',
+ 'operator' => 'IN',
+ );
+
+ foreach ( $tax_query as $query ) {
+ if ( ! is_array( $query ) )
+ continue;
+
+ $query = array_merge( $defaults, $query );
+
+ $query['terms'] = (array) $query['terms'];
+
+ $this->queries[] = $query;
+ }
+ }
+
+ /**
+ * Generates SQL clauses to be appended to a main query.
+ *
+ * @since 3.1.0
+ * @access public
+ *
+ * @param string $primary_table
+ * @param string $primary_id_column
+ * @return array
+ */
+ public function get_sql( $primary_table, $primary_id_column ) {
+ global $wpdb;
+
+ $join = '';
+ $where = array();
+ $i = 0;
+ $count = count( $this->queries );
+
+ foreach ( $this->queries as $index => $query ) {
+ $this->clean_query( $query );
+
+ if ( is_wp_error( $query ) ) {
+ return self::$no_results;
+ }
+
+ $terms = $query['terms'];
+ $operator = strtoupper( $query['operator'] );
+
+ if ( 'IN' == $operator ) {
+
+ if ( empty( $terms ) ) {
+ if ( 'OR' == $this->relation ) {
+ if ( ( $index + 1 === $count ) && empty( $where ) ) {
+ return self::$no_results;
+ }
+ continue;
+ } else {
+ return self::$no_results;
+ }
+ }
+
+ $terms = implode( ',', $terms );
+
+ $alias = $i ? 'tt' . $i : $wpdb->term_relationships;
+
+ $join .= " INNER JOIN $wpdb->term_relationships";
+ $join .= $i ? " AS $alias" : '';
+ $join .= " ON ($primary_table.$primary_id_column = $alias.object_id)";
+
+ $where[] = "$alias.term_taxonomy_id $operator ($terms)";
+ } elseif ( 'NOT IN' == $operator ) {
+
+ if ( empty( $terms ) ) {
+ continue;
+ }
+
+ $terms = implode( ',', $terms );
+
+ $where[] = "$primary_table.$primary_id_column NOT IN (
+ SELECT object_id
+ FROM $wpdb->term_relationships
+ WHERE term_taxonomy_id IN ($terms)
+ )";
+ } elseif ( 'AND' == $operator ) {
+
+ if ( empty( $terms ) ) {
+ continue;
+ }
+
+ $num_terms = count( $terms );
+
+ $terms = implode( ',', $terms );
+
+ $where[] = "(
+ SELECT COUNT(1)
+ FROM $wpdb->term_relationships
+ WHERE term_taxonomy_id IN ($terms)
+ AND object_id = $primary_table.$primary_id_column
+ ) = $num_terms";
+ }
+
+ $i++;
+ }
+
+ if ( ! empty( $where ) ) {
+ $where = ' AND ( ' . implode( " $this->relation ", $where ) . ' )';
+ } else {
+ $where = '';
+ }
+ return compact( 'join', 'where' );
+ }
+
+ /**
+ * Validates a single query.
+ *
+ * @since 3.2.0
+ * @access private
+ *
+ * @param array &$query The single query
+ */
+ private function clean_query( &$query ) {
+ if ( empty( $query['taxonomy'] ) ) {
+ if ( 'term_taxonomy_id' !== $query['field'] ) {
+ $query = new WP_Error( 'Invalid taxonomy' );
+ return;
+ }
+
+ // so long as there are shared terms, include_children requires that a taxonomy is set
+ $query['include_children'] = false;
+ } elseif ( ! taxonomy_exists( $query['taxonomy'] ) ) {
+ $query = new WP_Error( 'Invalid taxonomy' );
+ return;
+ }
+
+ $query['terms'] = array_unique( (array) $query['terms'] );
+
+ if ( is_taxonomy_hierarchical( $query['taxonomy'] ) && $query['include_children'] ) {
+ $this->transform_query( $query, 'term_id' );
+
+ if ( is_wp_error( $query ) )
+ return;
+
+ $children = array();
+ foreach ( $query['terms'] as $term ) {
+ $children = array_merge( $children, get_term_children( $term, $query['taxonomy'] ) );
+ $children[] = $term;
+ }
+ $query['terms'] = $children;
+ }
+
+ $this->transform_query( $query, 'term_taxonomy_id' );
+ }
+
+ /**
+ * Transforms a single query, from one field to another.
+ *
+ * @since 3.2.0
+ *
+ * @param array &$query The single query
+ * @param string $resulting_field The resulting field
+ */
+ public function transform_query( &$query, $resulting_field ) {
+ global $wpdb;
+
+ if ( empty( $query['terms'] ) )
+ return;
+
+ if ( $query['field'] == $resulting_field )
+ return;
+
+ $resulting_field = sanitize_key( $resulting_field );
+
+ switch ( $query['field'] ) {
+ case 'slug':
+ case 'name':
+ $terms = "'" . implode( "','", array_map( 'sanitize_title_for_query', $query['terms'] ) ) . "'";
+ $terms = $wpdb->get_col( "
+ SELECT $wpdb->term_taxonomy.$resulting_field
+ FROM $wpdb->term_taxonomy
+ INNER JOIN $wpdb->terms USING (term_id)
+ WHERE taxonomy = '{$query['taxonomy']}'
+ AND $wpdb->terms.{$query['field']} IN ($terms)
+ " );
+ break;
+ case 'term_taxonomy_id':
+ $terms = implode( ',', array_map( 'intval', $query['terms'] ) );
+ $terms = $wpdb->get_col( "
+ SELECT $resulting_field
+ FROM $wpdb->term_taxonomy
+ WHERE term_taxonomy_id IN ($terms)
+ " );
+ break;
+ default:
+ $terms = implode( ',', array_map( 'intval', $query['terms'] ) );
+ $terms = $wpdb->get_col( "
+ SELECT $resulting_field
+ FROM $wpdb->term_taxonomy
+ WHERE taxonomy = '{$query['taxonomy']}'
+ AND term_id IN ($terms)
+ " );
+ }
+
+ if ( 'AND' == $query['operator'] && count( $terms ) < count( $query['terms'] ) ) {
+ $query = new WP_Error( 'Inexistent terms' );
+ return;
+ }
+
+ $query['terms'] = $terms;
+ $query['field'] = $resulting_field;
+ }
+}
+
/**
* Get all Term data from database by Term ID.
*
* 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.0
*
* @uses $wpdb
* @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.
*/
-function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
+function get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
global $wpdb;
if ( empty($term) ) {
return $error;
}
- if ( ! is_taxonomy($taxonomy) ) {
- $error = new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ if ( ! taxonomy_exists($taxonomy) ) {
+ $error = new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
return $error;
}
} else {
if ( is_object($term) )
$term = $term->term_id;
- $term = (int) $term;
+ if ( !$term = (int) $term )
+ return null;
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) );
+ $_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 = %d LIMIT 1", $taxonomy, $term) );
+ if ( ! $_term )
+ return null;
wp_cache_add($term, $_term, $taxonomy);
}
}
- $_term = apply_filters('get_term', $_term, $taxonomy);
- $_term = apply_filters("get_$taxonomy", $_term, $taxonomy);
+ /**
+ * Filter a term.
+ *
+ * @since 2.3.0
+ *
+ * @param int|object $_term Term object or ID.
+ * @param string $taxonomy The taxonomy slug.
+ */
+ $_term = apply_filters( 'get_term', $_term, $taxonomy );
+
+ /**
+ * Filter a taxonomy.
+ *
+ * The dynamic portion of the filter name, $taxonomy, refers
+ * to the taxonomy slug.
+ *
+ * @since 2.3.0
+ *
+ * @param int|object $_term Term object or ID.
+ * @param string $taxonomy The taxonomy slug.
+ */
+ $_term = apply_filters( "get_$taxonomy", $_term, $taxonomy );
$_term = sanitize_term($_term, $taxonomy, $filter);
if ( $output == OBJECT ) {
* 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.0
*
* @uses $wpdb
* @uses sanitize_term() Cleanses the term based on $filter context before returning.
* @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 $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
* @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw') {
global $wpdb;
- if ( ! is_taxonomy($taxonomy) )
+ if ( ! taxonomy_exists($taxonomy) )
return false;
if ( 'slug' == $field ) {
return false;
} else if ( 'name' == $field ) {
// Assume already escaped
- $value = stripslashes($value);
+ $value = wp_unslash($value);
$field = 't.name';
- } else {
- $field = 't.term_id';
+ } else if ( 'term_taxonomy_id' == $field ) {
$value = (int) $value;
+ $field = 'tt.term_taxonomy_id';
+ } else {
+ $term = get_term( (int) $value, $taxonomy, $output, $filter);
+ if ( is_wp_error( $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) );
wp_cache_add($term->term_id, $term, $taxonomy);
+ /** This filter is documented in wp-includes/taxonomy.php */
+ $term = apply_filters( 'get_term', $term, $taxonomy );
+
+ /** This filter is documented in wp-includes/taxonomy.php */
+ $term = apply_filters( "get_$taxonomy", $term, $taxonomy );
+
$term = sanitize_term($term, $taxonomy, $filter);
if ( $output == OBJECT ) {
*
* Will return an empty array if $term does not exist in $taxonomy.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses $wpdb
* @uses _get_term_hierarchy()
* @uses get_term_children() Used to get the children of both $taxonomy and the parent $term
*
- * @param string $term ID of Term to get children
+ * @param string $term_id ID 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
+ * @return array|WP_Error List of Term IDs. WP_Error returned if $taxonomy does not exist
*/
function get_term_children( $term_id, $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'));
$term_id = intval( $term_id );
$children = $terms[$term_id];
foreach ( (array) $terms[$term_id] as $child ) {
+ if ( $term_id == $child ) {
+ continue;
+ }
+
if ( isset($terms[$child]) )
$children = array_merge($children, get_term_children($child, $taxonomy));
}
* reasons and for simplicity of usage. See sanitize_term_field() for more
* information.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
* 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.0
*
* @uses sanitize_term() Passes the return value on success
*
* The 'get_terms_orderby' filter passes the ORDER BY clause for the query
* along with the $args array.
-
+ *
* The 'get_terms_fields' filter passes the fields for the SELECT query
* along with the $args array.
*
- * The list of arguments that $args can contain, which will overwrite the defaults:
- *
- * orderby - Default is 'name'. Can be name, count, term_group, slug or nothing
- * (will use term_id), Passing a custom value other than these will cause it to
- * order based on the custom value.
- *
- * order - Default is ASC. Can use DESC.
- *
- * hide_empty - Default is true. Will not return empty terms, which means
- * terms whose count is 0 according to the given taxonomy.
- *
- * exclude - Default is an empty string. A comma- or space-delimited string
- * of term ids to exclude from the return array. If 'include' is non-empty,
- * 'exclude' is ignored.
- *
- * exclude_tree - A comma- or space-delimited string of term ids to exclude
- * from the return array, along with all of their descendant terms according to
- * the primary taxonomy. If 'include' is non-empty, 'exclude_tree' is ignored.
- *
- * include - Default is an empty string. A comma- or space-delimited string
- * of term ids to include in the return array.
- *
- * number - The maximum number of terms to return. Default is empty.
- *
- * offset - The number by which to offset the terms query.
- *
- * fields - Default is 'all', which returns an array of term objects.
- * If 'fields' is 'ids' or 'names', returns an array of
- * integers or strings, respectively.
- *
- * slug - Returns terms whose "slug" matches this value. Default is empty string.
- *
- * hierarchical - Whether to include terms that have non-empty descendants
- * (even if 'hide_empty' is set to true).
- *
- * search - Returned terms' names will contain the value of 'search',
- * case-insensitive. Default is an empty string.
- *
- * name__like - Returned terms' names will begin with the value of 'name__like',
- * case-insensitive. Default is empty string.
- *
- * The argument 'pad_counts', if set to true will include the quantity of a term's
- * children in the quantity of each term's "count" object variable.
- *
- * The 'get' argument, if set to 'all' instead of its default empty string,
- * returns terms regardless of ancestry or whether the terms are empty.
- *
- * The 'child_of' argument, when used, should be set to the integer of a term ID. Its default
- * is 0. If set to a non-zero value, all returned terms will be descendants
- * of that term according to the given taxonomy. Hence 'child_of' is set to 0
- * if more than one taxonomy is passed in $taxonomies, because multiple taxonomies
- * make term ancestry ambiguous.
- *
- * The 'parent' argument, when used, should be set to the integer of a term ID. Its default is
- * the empty string '', which has a different meaning from the integer 0.
- * If set to an integer value, all returned terms will have as an immediate
- * ancestor the term whose ID is specified by that integer according to the given taxonomy.
- * The 'parent' argument is different from 'child_of' in that a term X is considered a 'parent'
- * of term Y only if term X is the father of term Y, not its grandfather or great-grandfather, etc.
- *
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
- * @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.
+ * @global wpdb $wpdb WordPress database access abstraction object.
+ *
+ * @param string|array $taxonomies Taxonomy name or list of Taxonomy names.
+ * @param array|string $args {
+ * Optional. Array or string of arguments to get terms.
+ *
+ * @type string $orderby Field(s) to order terms by. Accepts term fields, though
+ * empty defaults to 'term_id'. Default '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 $number Maximum number of terms to return. Accepts 1+ or -1 (all).
+ * Default -1.
+ * @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
+ * term objects), 'ids' or 'names' (returns an array of integers
+ * or strings, respectively. Default 'all'.
+ * @type string $slug Slug 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 string $cache_domain Unique cache key to be produced when this query is stored in an
+ * object cache. Default is 'core'.
+ * }
+ * @return array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies
+ * do not exist.
*/
-function &get_terms($taxonomies, $args = '') {
+function get_terms( $taxonomies, $args = '' ) {
global $wpdb;
$empty_array = array();
- $single_taxonomy = false;
- if ( !is_array($taxonomies) ) {
- $single_taxonomy = true;
- $taxonomies = array($taxonomies);
+ $single_taxonomy = ! is_array( $taxonomies ) || 1 === count( $taxonomies );
+ if ( ! is_array( $taxonomies ) ) {
+ $taxonomies = array( $taxonomies );
}
- foreach ( (array) $taxonomies as $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) ) {
- $error = & new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ foreach ( $taxonomies as $taxonomy ) {
+ if ( ! taxonomy_exists($taxonomy) ) {
+ $error = new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
return $error;
}
}
- $in_taxonomies = "'" . implode("', '", $taxonomies) . "'";
-
$defaults = array('orderby' => 'name', 'order' => 'ASC',
- 'hide_empty' => true, 'exclude' => '', 'exclude_tree' => '', 'include' => '',
+ 'hide_empty' => true, 'exclude' => array(), 'exclude_tree' => array(), 'include' => array(),
'number' => '', 'fields' => 'all', 'slug' => '', 'parent' => '',
- 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '',
- 'pad_counts' => false, 'offset' => '', 'search' => '');
+ 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '', 'description__like' => '',
+ 'pad_counts' => false, 'offset' => '', 'search' => '', 'cache_domain' => 'core' );
$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'] ) {
+ if ( !$single_taxonomy || ! is_taxonomy_hierarchical( reset( $taxonomies ) ) ||
+ ( '' !== $args['parent'] && 0 !== $args['parent'] ) ) {
$args['child_of'] = 0;
$args['hierarchical'] = false;
$args['pad_counts'] = false;
$args['hierarchical'] = false;
$args['pad_counts'] = false;
}
- extract($args, EXTR_SKIP);
+ /**
+ * Filter the terms query arguments.
+ *
+ * @since 3.1.0
+ *
+ * @param array $args An array of arguments.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ */
+ $args = apply_filters( 'get_terms_args', $args, $taxonomies );
+
+ $child_of = $args['child_of'];
if ( $child_of ) {
- $hierarchy = _get_term_hierarchy($taxonomies[0]);
- if ( !isset($hierarchy[$child_of]) )
+ $hierarchy = _get_term_hierarchy( reset( $taxonomies ) );
+ if ( ! isset( $hierarchy[ $child_of ] ) ) {
return $empty_array;
+ }
}
+ $parent = $args['parent'];
if ( $parent ) {
- $hierarchy = _get_term_hierarchy($taxonomies[0]);
- if ( !isset($hierarchy[$parent]) )
+ $hierarchy = _get_term_hierarchy( reset( $taxonomies ) );
+ if ( ! isset( $hierarchy[ $parent ] ) ) {
return $empty_array;
+ }
}
// $args can be whatever, only use the args defined in defaults to compute the key
$filter_key = ( has_filter('list_terms_exclusions') ) ? serialize($GLOBALS['wp_filter']['list_terms_exclusions']) : '';
- $key = md5( serialize( compact(array_keys($defaults)) ) . serialize( $taxonomies ) . $filter_key );
- $last_changed = wp_cache_get('last_changed', 'terms');
- if ( !$last_changed ) {
- $last_changed = time();
- wp_cache_set('last_changed', $last_changed, 'terms');
+ $key = md5( serialize( wp_array_slice_assoc( $args, array_keys( $defaults ) ) ) . serialize( $taxonomies ) . $filter_key );
+ $last_changed = wp_cache_get( 'last_changed', 'terms' );
+ if ( ! $last_changed ) {
+ $last_changed = microtime();
+ wp_cache_set( 'last_changed', $last_changed, 'terms' );
}
$cache_key = "get_terms:$key:$last_changed";
$cache = wp_cache_get( $cache_key, 'terms' );
if ( false !== $cache ) {
- $cache = apply_filters('get_terms', $cache, $taxonomies, $args);
+
+ /**
+ * Filter the given taxonomy's terms cache.
+ *
+ * @since 2.3.0
+ *
+ * @param array $cache Cached array of terms for the given taxonomy.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ * @param array $args An array of arguments to get terms.
+ */
+ $cache = apply_filters( 'get_terms', $cache, $taxonomies, $args );
return $cache;
}
- $_orderby = strtolower($orderby);
- if ( 'count' == $_orderby )
+ $_orderby = strtolower( $args['orderby'] );
+ if ( 'count' == $_orderby ) {
$orderby = 'tt.count';
- else if ( 'name' == $_orderby )
+ } else if ( 'name' == $_orderby ) {
$orderby = 't.name';
- else if ( 'slug' == $_orderby )
+ } else if ( 'slug' == $_orderby ) {
$orderby = 't.slug';
- else if ( 'term_group' == $_orderby )
+ } else if ( 'term_group' == $_orderby ) {
$orderby = 't.term_group';
- elseif ( empty($_orderby) || 'id' == $_orderby )
+ } else if ( 'none' == $_orderby ) {
+ $orderby = '';
+ } elseif ( empty($_orderby) || 'id' == $_orderby ) {
$orderby = 't.term_id';
+ } else {
+ $orderby = 't.name';
+ }
+ /**
+ * Filter the ORDERBY clause of the terms query.
+ *
+ * @since 2.8.0
+ *
+ * @param string $orderby ORDERBY clause of the terms query.
+ * @param array $args An array of terms query arguments.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ */
+ $orderby = apply_filters( 'get_terms_orderby', $orderby, $args, $taxonomies );
+
+ $order = strtoupper( $args['order'] );
+ if ( ! empty( $orderby ) ) {
+ $orderby = "ORDER BY $orderby";
+ } else {
+ $order = '';
+ }
- $orderby = apply_filters( 'get_terms_orderby', $orderby, $args );
+ if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) ) {
+ $order = 'ASC';
+ }
+
+ $where = "tt.taxonomy IN ('" . implode("', '", $taxonomies) . "')";
+
+ $exclude = $args['exclude'];
+ $exclude_tree = $args['exclude_tree'];
+ $include = $args['include'];
- $where = '';
$inclusions = '';
- if ( !empty($include) ) {
+ if ( ! empty( $include ) ) {
$exclude = '';
$exclude_tree = '';
- $interms = preg_split('/[\s,]+/',$include);
- if ( count($interms) ) {
- foreach ( (array) $interms as $interm ) {
- if (empty($inclusions))
- $inclusions = ' AND ( t.term_id = ' . intval($interm) . ' ';
- else
- $inclusions .= ' OR t.term_id = ' . intval($interm) . ' ';
- }
- }
+ $inclusions = implode( ',', wp_parse_id_list( $include ) );
}
- if ( !empty($inclusions) )
- $inclusions .= ')';
- $where .= $inclusions;
+ if ( ! empty( $inclusions ) ) {
+ $inclusions = ' AND t.term_id IN ( ' . $inclusions . ' )';
+ $where .= $inclusions;
+ }
- $exclusions = '';
if ( ! empty( $exclude_tree ) ) {
- $excluded_trunks = preg_split('/[\s,]+/',$exclude_tree);
- foreach( (array) $excluded_trunks as $extrunk ) {
- $excluded_children = (array) get_terms($taxonomies[0], array('child_of' => intval($extrunk), 'fields' => 'ids'));
- $excluded_children[] = $extrunk;
- foreach( (array) $excluded_children as $exterm ) {
- if ( empty($exclusions) )
- $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
- else
- $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
-
- }
+ $exclude_tree = wp_parse_id_list( $exclude_tree );
+ $excluded_children = $exclude_tree;
+ foreach ( $exclude_tree as $extrunk ) {
+ $excluded_children = array_merge(
+ $excluded_children,
+ (array) get_terms( $taxonomies[0], array( 'child_of' => intval( $extrunk ), 'fields' => 'ids', 'hide_empty' => 0 ) )
+ );
}
+ $exclusions = implode( ',', array_map( 'intval', $excluded_children ) );
+ } else {
+ $exclusions = '';
}
- if ( !empty($exclude) ) {
- $exterms = preg_split('/[\s,]+/',$exclude);
- if ( count($exterms) ) {
- foreach ( (array) $exterms as $exterm ) {
- if ( empty($exclusions) )
- $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' ';
- else
- $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' ';
- }
+
+ if ( ! empty( $exclude ) ) {
+ $exterms = wp_parse_id_list( $exclude );
+ if ( empty( $exclusions ) ) {
+ $exclusions = implode( ',', $exterms );
+ } else {
+ $exclusions .= ', ' . implode( ',', $exterms );
}
}
- if ( !empty($exclusions) )
- $exclusions .= ')';
- $exclusions = apply_filters('list_terms_exclusions', $exclusions, $args );
- $where .= $exclusions;
+ if ( ! empty( $exclusions ) ) {
+ $exclusions = ' AND t.term_id NOT IN (' . $exclusions . ')';
+ }
+
+ /**
+ * Filter the terms to exclude from the terms query.
+ *
+ * @since 2.3.0
+ *
+ * @param string $exclusions NOT IN clause of the terms query.
+ * @param array $args An array of terms query arguments.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ */
+ $exclusions = apply_filters( 'list_terms_exclusions', $exclusions, $args, $taxonomies );
- if ( !empty($slug) ) {
- $slug = sanitize_title($slug);
+ if ( ! empty( $exclusions ) ) {
+ $where .= $exclusions;
+ }
+
+ if ( ! empty( $args['slug'] ) ) {
+ $slug = sanitize_title( $args['slug'] );
$where .= " AND t.slug = '$slug'";
}
- if ( !empty($name__like) )
- $where .= " AND t.name LIKE '{$name__like}%'";
+ if ( ! empty( $args['name__like'] ) ) {
+ $where .= $wpdb->prepare( " AND t.name LIKE %s", '%' . $wpdb->esc_like( $args['name__like'] ) . '%' );
+ }
+
+ if ( ! empty( $args['description__like'] ) ) {
+ $where .= $wpdb->prepare( " AND tt.description LIKE %s", '%' . $wpdb->esc_like( $args['description__like'] ) . '%' );
+ }
if ( '' !== $parent ) {
$parent = (int) $parent;
$where .= " AND tt.parent = '$parent'";
}
- if ( $hide_empty && !$hierarchical )
+ $hierarchical = $args['hierarchical'];
+ if ( 'count' == $args['fields'] ) {
+ $hierarchical = false;
+ }
+ if ( $args['hide_empty'] && !$hierarchical ) {
$where .= ' AND tt.count > 0';
+ }
- // don't limit the query results when we have to descend the family tree
- if ( ! empty($number) && ! $hierarchical && empty( $child_of ) && '' === $parent ) {
- if( $offset )
- $limit = 'LIMIT ' . $offset . ',' . $number;
- else
- $limit = 'LIMIT ' . $number;
+ $number = $args['number'];
+ $offset = $args['offset'];
- } else
- $limit = '';
+ // don't limit the query results when we have to descend the family tree
+ if ( $number && ! $hierarchical && ! $child_of && '' === $parent ) {
+ if ( $offset ) {
+ $limits = 'LIMIT ' . $offset . ',' . $number;
+ } else {
+ $limits = 'LIMIT ' . $number;
+ }
+ } else {
+ $limits = '';
+ }
- if ( !empty($search) ) {
- $search = like_escape($search);
- $where .= " AND (t.name LIKE '%$search%')";
+ if ( ! empty( $args['search'] ) ) {
+ $like = '%' . $wpdb->esc_like( $args['search'] ) . '%';
+ $where .= $wpdb->prepare( ' AND ((t.name LIKE %s) OR (t.slug LIKE %s))', $like, $like );
}
$selects = array();
- if ( 'all' == $fields )
- $selects = array('t.*', 'tt.*');
- else if ( 'ids' == $fields )
- $selects = array('t.term_id', 'tt.parent', 'tt.count');
- else if ( 'names' == $fields )
- $selects = array('t.term_id', 'tt.parent', 'tt.count', 't.name');
- $select_this = implode(', ', apply_filters( 'get_terms_fields', $selects, $args ));
-
- $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 $limit";
+ switch ( $args['fields'] ) {
+ case 'all':
+ $selects = array( 't.*', 'tt.*' );
+ break;
+ case 'ids':
+ case 'id=>parent':
+ $selects = array( 't.term_id', 'tt.parent', 'tt.count' );
+ break;
+ case 'names':
+ $selects = array( 't.term_id', 'tt.parent', 'tt.count', 't.name' );
+ break;
+ case 'count':
+ $orderby = '';
+ $order = '';
+ $selects = array( 'COUNT(*)' );
+ break;
+ case 'id=>name':
+ $selects = array( 't.term_id', 't.name' );
+ break;
+ case 'id=>slug':
+ $selects = array( 't.term_id', 't.slug' );
+ break;
+ }
+
+ $_fields = $args['fields'];
+
+ /**
+ * Filter the fields to select in the terms query.
+ *
+ * @since 2.8.0
+ *
+ * @param array $selects An array of fields to select for the terms query.
+ * @param array $args An array of term query arguments.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ */
+ $fields = implode( ', ', apply_filters( 'get_terms_fields', $selects, $args, $taxonomies ) );
+
+ $join = "INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id";
+
+ $pieces = array( 'fields', 'join', 'where', 'orderby', 'order', 'limits' );
+
+ /**
+ * Filter the terms query SQL clauses.
+ *
+ * @since 3.1.0
+ *
+ * @param array $pieces Terms query SQL clauses.
+ * @param string|array $taxonomies A taxonomy or array of taxonomies.
+ * @param array $args An array of terms query arguments.
+ */
+ $clauses = apply_filters( 'terms_clauses', compact( $pieces ), $taxonomies, $args );
+ $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : '';
+ $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : '';
+ $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : '';
+ $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : '';
+ $order = isset( $clauses[ 'order' ] ) ? $clauses[ 'order' ] : '';
+ $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : '';
+
+ $query = "SELECT $fields FROM $wpdb->terms AS t $join WHERE $where $orderby $order $limits";
+
+ if ( 'count' == $_fields ) {
+ $term_count = $wpdb->get_var($query);
+ return $term_count;
+ }
$terms = $wpdb->get_results($query);
- if ( 'all' == $fields ) {
+ if ( 'all' == $_fields ) {
update_term_cache($terms);
}
if ( empty($terms) ) {
- wp_cache_add( $cache_key, array(), 'terms' );
- $terms = apply_filters('get_terms', array(), $taxonomies, $args);
+ wp_cache_add( $cache_key, array(), 'terms', DAY_IN_SECONDS );
+
+ /** This filter is documented in wp-includes/taxonomy.php */
+ $terms = apply_filters( 'get_terms', array(), $taxonomies, $args );
return $terms;
}
if ( $child_of ) {
- $children = _get_term_hierarchy($taxonomies[0]);
- if ( ! empty($children) )
- $terms = & _get_term_children($child_of, $terms, $taxonomies[0]);
+ $children = _get_term_hierarchy( reset( $taxonomies ) );
+ if ( ! empty( $children ) ) {
+ $terms = _get_term_children( $child_of, $terms, reset( $taxonomies ) );
+ }
}
// Update term counts to include children.
- if ( $pad_counts && 'all' == $fields )
- _pad_term_counts($terms, $taxonomies[0]);
-
+ if ( $args['pad_counts'] && 'all' == $_fields ) {
+ _pad_term_counts( $terms, reset( $taxonomies ) );
+ }
// Make sure we show empty categories that have children.
- if ( $hierarchical && $hide_empty && is_array($terms) ) {
+ if ( $hierarchical && $args['hide_empty'] && is_array( $terms ) ) {
foreach ( $terms as $k => $term ) {
if ( ! $term->count ) {
- $children = _get_term_children($term->term_id, $terms, $taxonomies[0]);
- if( is_array($children) )
- foreach ( $children as $child )
- if ( $child->count )
+ $children = get_term_children( $term->term_id, reset( $taxonomies ) );
+ if ( is_array( $children ) ) {
+ foreach ( $children as $child_id ) {
+ $child = get_term( $child_id, reset( $taxonomies ) );
+ if ( $child->count ) {
continue 2;
+ }
+ }
+ }
// It really is empty
unset($terms[$k]);
}
}
}
- reset ( $terms );
+ reset( $terms );
$_terms = array();
- if ( 'ids' == $fields ) {
- while ( $term = array_shift($terms) )
+ if ( 'id=>parent' == $_fields ) {
+ while ( $term = array_shift( $terms ) ) {
+ $_terms[$term->term_id] = $term->parent;
+ }
+ } elseif ( 'ids' == $_fields ) {
+ while ( $term = array_shift( $terms ) ) {
$_terms[] = $term->term_id;
- $terms = $_terms;
- } elseif ( 'names' == $fields ) {
- while ( $term = array_shift($terms) )
+ }
+ } elseif ( 'names' == $_fields ) {
+ while ( $term = array_shift( $terms ) ) {
$_terms[] = $term->name;
+ }
+ } elseif ( 'id=>name' == $_fields ) {
+ while ( $term = array_shift( $terms ) ) {
+ $_terms[$term->term_id] = $term->name;
+ }
+ } elseif ( 'id=>slug' == $_fields ) {
+ while ( $term = array_shift( $terms ) ) {
+ $_terms[$term->term_id] = $term->slug;
+ }
+ }
+
+ if ( ! empty( $_terms ) ) {
$terms = $_terms;
}
- if ( 0 < $number && intval(@count($terms)) > $number ) {
- $terms = array_slice($terms, $offset, $number);
+ if ( $number && is_array( $terms ) && count( $terms ) > $number ) {
+ $terms = array_slice( $terms, $offset, $number );
}
- wp_cache_add( $cache_key, $terms, 'terms' );
+ wp_cache_add( $cache_key, $terms, 'terms', DAY_IN_SECONDS );
- $terms = apply_filters('get_terms', $terms, $taxonomies, $args);
+ /** This filter is documented in wp-includes/taxonomy */
+ $terms = apply_filters( 'get_terms', $terms, $taxonomies, $args );
return $terms;
}
/**
* 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.0
+ * @since 3.0.0
*
* @uses $wpdb
*
* @param int|string $term The term to check
* @param string $taxonomy The taxonomy name to use
* @param int $parent ID of parent term under which to confine the exists search.
- * @return mixed Get the term id or Term Object, if exists.
+ * @return mixed Returns 0 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
+ * if the taxonomy is specified and the pairing exists.
*/
-function is_term($term, $taxonomy = '', $parent = 0) {
+function term_exists($term, $taxonomy = '', $parent = 0) {
global $wpdb;
$select = "SELECT term_id FROM $wpdb->terms as t WHERE ";
return $wpdb->get_var( $wpdb->prepare( $select . $where, $term ) );
}
- $term = trim( stripslashes( $term ) );
+ $term = trim( wp_unslash( $term ) );
if ( '' === $slug = sanitize_title($term) )
return 0;
return $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $else_where", $else_where_fields) );
}
+/**
+ * Check if a term is an ancestor of another term.
+ *
+ * You can use either an id or the term object for both parameters.
+ *
+ * @since 3.4.0
+ *
+ * @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 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.
*
- * Relys on sanitize_term_field() to sanitize the term. The difference is that
+ * 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().
*
* The $term is expected to be either an array or an object.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses sanitize_term_field Used to sanitize all fields in a term
*/
function sanitize_term($term, $taxonomy, $context = 'display') {
- if ( 'raw' == $context )
- return $term;
-
- $fields = array('term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group');
+ $fields = array( 'term_id', 'name', 'description', 'slug', 'count', 'parent', 'term_group', 'term_taxonomy_id', 'object_id' );
- $do_object = false;
- if ( is_object($term) )
- $do_object = true;
+ $do_object = is_object( $term );
$term_id = $do_object ? $term->term_id : (isset($term['term_id']) ? $term['term_id'] : 0);
* without creating your own filter function. Simply create a function that
* hooks into the filter you need.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses $wpdb
* @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);
+
+ /**
+ * Filter 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 );
+
+ /**
+ * Filter 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 = esc_attr($value);
} else if ( 'db' == $context ) {
- $value = apply_filters("pre_term_$field", $value, $taxonomy);
- $value = apply_filters("pre_${taxonomy}_$field", $value);
+
+ /**
+ * Filter 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 );
+
+ /**
+ * Filter 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 ) {
+ /**
+ * Filter the category nicename before it is sanitized.
+ *
+ * Use the 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);
+
+ /**
+ * Filter 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 );
+
+ /**
+ * Filter 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);
+
+ /**
+ * Filter 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 );
+
+ /**
+ * Filter 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 )
/**
* 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.0
*
- * @uses $wpdb
+ * @uses get_terms()
* @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 array|string $args Overwrite defaults. See get_terms()
+ * @return int|WP_Error How many terms are in $taxonomy. WP_Error if $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';
+ // backwards compatibility
+ if ( isset($args['ignore_empty']) ) {
+ $args['hide_empty'] = $args['ignore_empty'];
+ unset($args['ignore_empty']);
+ }
+
+ $args['fields'] = 'count';
- return $wpdb->get_var( $wpdb->prepare("SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE taxonomy = %s $where", $taxonomy) );
+ return get_terms($taxonomy, $args);
}
/**
- * 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.0
- * @uses $wpdb
+ * @uses wp_remove_object_terms()
*
* @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 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 ( (array) $taxonomies as $taxonomy ) {
- $tt_ids = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids');
- $in_tt_ids = "'" . implode("', '", $tt_ids) . "'";
- $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id) );
- wp_update_term_count($tt_ids, $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 );
}
}
*
* The $args 'force_default' will force the term supplied as default to be
* assigned even if the object was not going to be termless
- * @package WordPress
- * @subpackage Taxonomy
+ *
* @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.
*
* @param int $term Term ID
* @param string $taxonomy Taxonomy Name
$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'];
}
// Update children to point to new parent
return $term_obj;
$parent = $term_obj->parent;
+ $edit_tt_ids = $wpdb->get_col( "SELECT `term_taxonomy_id` FROM $wpdb->term_taxonomy WHERE `parent` = " . (int)$term_obj->term_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' ) );
+
+ /**
+ * 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 ) );
wp_set_object_terms($object, $terms, $taxonomy);
}
- $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $tt_id ) );
+ // 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( $objects, $object_type );
+
+ // Get the object before deletion so we can pass to actions below
+ $deleted_term = get_term( $term, $taxonomy );
+
+ /**
+ * 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
+ *
+ * @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.
+ */
+ do_action( 'delete_term', $term, $tt_id, $taxonomy, $deleted_term );
+
+ /**
+ * 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
+ *
+ * @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.
+ */
+ do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term );
return true;
}
+/**
+ * Deletes one existing category.
+ *
+ * @since 2.0.0
+ * @uses wp_delete_term()
+ *
+ * @param int $cat_ID
+ * @return mixed 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.
*
* 'all_with_object_id'.
*
* 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
+ * 'all_with_object_id' is chosen 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.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses $wpdb
*
- * @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.
+ * @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 ( (array) $taxonomies as $taxonomy ) {
- if ( ! is_taxonomy($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy'));
+ foreach ( $taxonomies as $taxonomy ) {
+ if ( ! taxonomy_exists($taxonomy) )
+ return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
}
if ( !is_array($object_ids) )
$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';
if ( !empty($orderby) )
$orderby = "ORDER BY $orderby";
+ $order = strtoupper( $order );
+ if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) )
+ $order = 'ASC';
+
$taxonomies = "'" . implode("', '", $taxonomies) . "'";
$object_ids = implode(', ', $object_ids);
$select_this = 't.term_id';
else if ( 'names' == $fields )
$select_this = 't.name';
+ else if ( 'slugs' == $fields )
+ $select_this = 't.slug';
else if ( 'all_with_object_id' == $fields )
$select_this = 't.*, tt.*, tr.object_id';
$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) $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));
+ $_terms = $wpdb->get_results( $query );
+ foreach ( $_terms as $key => $term ) {
+ $_terms[$key] = sanitize_term( $term, $taxonomy, 'raw' );
+ }
+ $terms = array_merge( $terms, $_terms );
+ update_term_cache( $terms );
+ $objects = true;
+ } else if ( '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 );
} 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) $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 )
+ 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;
+ }
- return apply_filters('wp_get_object_terms', $terms, $object_ids, $taxonomies, $args);
+ $_tt_ids[] = $term->term_taxonomy_id;
+ $_terms[] = $term;
+ }
+ $terms = $_terms;
+ } elseif ( ! $objects ) {
+ $terms = array_values( array_unique( $terms ) );
+ }
+ /**
+ * Filter the terms for a given object or objects.
+ *
+ * @since 2.8.0
+ *
+ * @param array $terms An array of terms for the given object or objects.
+ * @param array|int $object_ids Object ID or array of IDs.
+ * @param array|string $taxonomies A taxonomy or array of taxonomies.
+ * @param array $args An array of arguments for retrieving terms for
+ * the given object(s).
+ */
+ return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
}
/**
- * 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.
+ * Add a new term to the database.
*
- * 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.
+ * 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.
*
- * '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.
+ * 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.
*
- * '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 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 '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.
+ * 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.
*
- * @package WordPress
- * @subpackage Taxonomy
+ * @global wpdb $wpdb The WordPress database object.
+
* @since 2.3.0
- * @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
+ * @param string $term The term to add or update.
+ * @param string $taxonomy The taxonomy to which to add the term
+ * @param array|string $args {
+ * Arguments to change values of the inserted 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) )
+ if ( ! taxonomy_exists($taxonomy) ) {
return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
-
- if ( is_int($term) && 0 == $term )
+ }
+ /**
+ * Filter 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) )
+ }
+ 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);
+ $args = wp_parse_args( $args, $defaults );
+
+ if ( $args['parent'] > 0 && ! term_exists( (int) $args['parent'] ) ) {
+ return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
+ }
$args['name'] = $term;
$args['taxonomy'] = $taxonomy;
$args = sanitize_term($args, $taxonomy, 'db');
- extract($args, EXTR_SKIP);
// expected_slashed ($name)
- $name = stripslashes($name);
- $description = stripslashes($description);
-
- if ( empty($slug) )
- $slug = sanitize_title($name);
+ $name = wp_unslash( $args['name'] );
+ $description = wp_unslash( $args['description'] );
+ $parent = (int) $args['parent'];
+
+ $slug_provided = ! empty( $args['slug'] );
+ if ( ! $slug_provided ) {
+ $_name = trim( $name );
+ $existing_term = get_term_by( 'name', $_name, $taxonomy );
+ if ( $existing_term ) {
+ $slug = $existing_term->slug;
+ } else {
+ $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 ( $args['alias_of'] ) {
+ $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $args['alias_of'] ) );
if ( $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.
$term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
+
+ /**
+ * 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', $alias->term_id, $taxonomy );
$wpdb->update($wpdb->terms, compact('term_group'), array('term_id' => $alias->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', $alias->term_id, $taxonomy );
}
}
- 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.
+ if ( $term_id = term_exists($slug) ) {
+ $existing_term = $wpdb->get_row( $wpdb->prepare( "SELECT name FROM $wpdb->terms WHERE term_id = %d", $term_id), ARRAY_A );
+ // We've got an existing term in the same taxonomy, which matches the name of the new term:
+ if ( is_taxonomy_hierarchical($taxonomy) && $existing_term['name'] == $name && $exists = term_exists( (int) $term_id, $taxonomy ) ) {
+ // Hierarchical, and it matches an existing term, Do not allow same "name" in the same level.
+ $siblings = get_terms($taxonomy, array('fields' => 'names', 'get' => 'all', 'parent' => $parent ) );
+ if ( in_array($name, $siblings) ) {
+ if ( $slug_provided ) {
+ return new WP_Error( 'term_exists', __( 'A term with the name and slug provided already exists with this parent.' ), $exists['term_id'] );
+ } else {
+ return new WP_Error( 'term_exists', __( 'A term with the name provided already exists with this parent.' ), $exists['term_id'] );
+ }
+ } else {
+ $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;
+ }
+ } elseif ( $existing_term['name'] != $name ) {
+ // We've got an existing term, with a different name, Create the new term.
+ $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;
+ } elseif ( $exists = term_exists( (int) $term_id, $taxonomy ) ) {
+ // Same name, same slug.
+ return new WP_Error( 'term_exists', __( 'A term with the name and slug provided already exists.' ), $exists['term_id'] );
+ }
+ } else {
+ // This term does not exist at all in the database, Create it.
$slug = wp_unique_term_slug($slug, (object) $args);
- if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) )
+ 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);
-
- $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 );
+
+ /**
+ * Filter 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
+ */
+ 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.
+ *
+ * @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);
}
* A term has no meaning until it is given context by defining which taxonomy it
* exists under.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
- * @uses $wpdb
- *
- * @param int $object_id The object to relate to.
- * @param array|int|string $term The slug or id of the term, will replace all existing
- * related terms in this taxonomy.
- * @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
+ * @uses wp_remove_object_terms()
+ *
+ * @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 array|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 Affected Term IDs.
*/
-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_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 ( (array) $terms as $term) {
if ( !strlen(trim($term)) )
continue;
- if ( !$term_info = is_term($term, $taxonomy) )
+ 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'];
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;
+
+ /**
+ * 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_tt_ids, $tt_ids);
- if ( $delete_terms ) {
- $in_delete_terms = "'" . implode("', '", $delete_terms) . "'";
- $wpdb->query( $wpdb->prepare("DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_delete_terms)", $object_id) );
- 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_tt_ids = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids');
+ $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;
+}
+
+/**
+ * Add term(s) associated with a given object.
+ *
+ * @since 3.6.0
+ * @uses wp_set_object_terms()
+ *
+ * @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 Affected Term IDs
+ */
+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.
+ *
+ * @since 3.6.0
+ * @uses $wpdb
+ *
+ * @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_remove_object_terms( $object_id, $terms, $taxonomy ) {
+ global $wpdb;
+
+ $object_id = (int) $object_id;
+
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid Taxonomy' ) );
}
- do_action('set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append);
- return $tt_ids;
+ 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 ( $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 ) );
+
+ /**
+ * 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 false;
}
/**
* slug has to be globally unique for every taxonomy.
*
* 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.
+ * hierarchical 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.
+ * until it finds a number that is truly unique.
*
* The only purpose for $term is for appending a parent, if one exists.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses $wpdb
*
function wp_unique_term_slug($slug, $term) {
global $wpdb;
+ if ( ! term_exists( $slug ) )
+ return $slug;
+
// 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) ) {
$parent_term = get_term($the_parent, $term->taxonomy);
if ( is_wp_error($parent_term) || empty($parent_term) )
break;
- $slug .= '-' . $parent_term->slug;
+ $slug .= '-' . $parent_term->slug;
+ if ( ! term_exists( $slug ) )
+ return $slug;
+
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.
- if ( !empty($args['term_id']) )
- $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $args['term_id'] );
+ 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 );
* For what can be overrode in $args, check the term scheme can contain and stay
* away from the term keys.
*
- * @package WordPress
- * @subpackage Taxonomy
* @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.
*
* @param int $term_id The ID of the term
* @param string $taxonomy The context in which to relate the term to the object.
function wp_update_term( $term_id, $taxonomy, $args = array() ) {
global $wpdb;
- if ( ! is_taxonomy($taxonomy) )
+ if ( ! taxonomy_exists($taxonomy) )
return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
$term_id = (int) $term_id;
return $term;
// Escape data pulled from DB.
- $term = add_magic_quotes($term);
+ $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'));
$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) );
+ $parsed_args['slug'] = $slug;
+
+ $term_group = isset( $parsed_args['term_group'] ) ? $parsed_args['term_group'] : 0;
+ if ( $args['alias_of'] ) {
+ $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $args['alias_of'] ) );
if ( $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.
$term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edit_terms', $alias->term_id, $taxonomy );
$wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edited_terms', $alias->term_id, $taxonomy );
}
+
+ $parsed_args['term_group'] = $term_group;
}
+ /**
+ * Filter 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) ) {
// 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));
}
+ /** This action is documented in wp-includes/taxonomy.php */
+ 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' ) );
}
+ /** 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) );
+ /**
+ * 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 );
+
+ // Clean the relationship caches for all object types using this term
+ $objects = $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
+ $tax_object = get_taxonomy( $taxonomy );
+ foreach ( $tax_object->object_type as $object_type ) {
+ clean_object_term_cache( $objects, $object_type );
+ }
+
+ /**
+ * 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);
}
/**
* Updates the amount of terms in taxonomy.
*
- * If there is a taxonomy callback applyed, then it will be called for updating
+ * 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.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses $wpdb
*
* @return bool 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 ( (array) $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;
}
// Cache
//
-
/**
* Removes the taxonomy relationship to terms from the cache.
*
* term IDs have to exist within the taxonomy $object_type for the deletion to
* take place.
*
- * @package WordPress
- * @subpackage Taxonomy
* @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.
*
* @param int|array $object_ids Single or list of term object ID(s)
* @param array|string $object_type The taxonomy object type
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 );
}
-
/**
* Will remove all of the term ids from the cache.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses $wpdb
*
* @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.
+ * @param bool $clean_taxonomy Whether to clean taxonomy wide caches (true), or just individual term object caches (false). Default is true.
*/
-function clean_term_cache($ids, $taxonomy = '') {
+function clean_term_cache($ids, $taxonomy = '', $clean_taxonomy = true) {
global $wpdb;
- static $cleaned = array();
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;
+ $ids[] = $term->term_id;
wp_cache_delete($term->term_id, $term->taxonomy);
}
$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, $taxonomy);
+ }
+ }
}
foreach ( $taxonomies as $taxonomy ) {
- if ( isset($cleaned[$taxonomy]) )
- continue;
- $cleaned[$taxonomy] = true;
- 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_set('last_changed', time(), 'terms');
+ /**
+ * Fires once after each taxonomy's term cache has been cleaned.
+ *
+ * @since 2.5.0
+ *
+ * @param array $ids An array of term IDs.
+ * @param string $taxonomy Taxonomy slug.
+ */
+ do_action( 'clean_term_cache', $ids, $taxonomy );
+ }
- do_action('clean_term_cache', $ids, $taxonomy);
+ wp_cache_set( 'last_changed', microtime(), 'terms' );
}
-
/**
* Retrieves the taxonomy relationship to the term object id.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @uses wp_cache_get() Retrieves taxonomy relationship from cache
* @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.
*/
-function &get_object_term_cache($id, $taxonomy) {
+function get_object_term_cache($id, $taxonomy) {
$cache = wp_cache_get($id, "{$taxonomy}_relationships");
return $cache;
}
-
/**
* Updates the cache for Term ID(s).
*
* 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.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
* @uses wp_get_object_terms() Used to get terms from the database to update
*
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'));
$object_terms = array();
foreach ( (array) $terms as $term )
$object_terms[$term->object_id][$term->taxonomy][$term->term_id] = $term;
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" );
}
}
}
-
/**
* Updates Terms to Taxonomy in cache.
*
- * @package WordPress
- * @subpackage Taxonomy
* @since 2.3.0
*
* @param array $terms List of Term objects to change
// Private
//
-
/**
* Retrieves children of taxonomy as Term IDs.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
* @since 2.3.0
*
* option. That is the name of the taxonomy, immediately followed by '_children'.
*
* @param string $taxonomy Taxonomy Name
- * @return array Empty if $taxonomy isn't hierarachical or returns children as Term IDs.
+ * @return array Empty if $taxonomy isn't hierarchical or returns children as Term IDs.
*/
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);
return $children;
}
-
/**
* Get the subset of $terms that are descendants of $term_id.
*
* 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.0
*
* @param string $taxonomy The taxonomy which determines the hierarchy of the terms.
* @return array 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) {
$empty_array = array();
if ( empty($terms) )
return $empty_array;
$use_id = true;
}
- if ( $term->term_id == $term_id )
+ if ( $term->term_id == $term_id ) {
continue;
+ }
if ( $term->parent == $term_id ) {
if ( $use_id )
return $term_list;
}
-
/**
* 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.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
* @since 2.3.0
* @uses $wpdb
}
// 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'");
+ $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] = 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
foreach ( $term_ids as $term_id ) {
$child = $term_id;
- while ( $parent = $terms_by_id[$child]->parent ) {
- if ( !empty($term_items[$term_id]) )
+ while ( !empty( $terms_by_id[$child] ) && $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] = isset($term_items[$parent][$item_id]) ? ++$term_items[$parent][$item_id]: 1;
}
//
/**
- * 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.
*
- * @package WordPress
- * @subpackage Taxonomy
* @access private
* @since 2.3.0
* @uses $wpdb
*
* @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;
+ $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 = $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 ) );
+ $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 );
$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 );
}
}
+/**
+ * Will update term count based on number of objects.
+ *
+ * Default callback for the link_category taxonomy.
+ *
+ * @since 3.3.0
+ * @uses $wpdb
+ *
+ * @param array $terms List of Term taxonomy IDs
+ * @param object $taxonomy Current taxonomy object of terms
+ */
+function _update_generic_term_count( $terms, $taxonomy ) {
+ global $wpdb;
+
+ foreach ( (array) $terms as $term ) {
+ $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term ) );
+
+ /** This action is documented in wp-includes/taxonomy.php */
+ do_action( 'edit_term_taxonomy', $term, $taxonomy );
+ $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 );
+ }
+}
/**
* Generates a permalink for a taxonomy term archive.
* @since 2.5.0
*
* @param object|int|string $term
- * @param string $taxonomy
- * @return string HTML link to taxonomy term archive
+ * @param string $taxonomy (optional if $term is object)
+ * @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 ) {
+function get_term_link( $term, $taxonomy = '') {
global $wp_rewrite;
if ( !is_object($term) ) {
if ( is_int($term) ) {
- $term = &get_term($term, $taxonomy);
+ $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;
- // use legacy functions for core taxonomies until they are fully plugged in
- if ( $taxonomy == 'category' )
- return get_category_link((int) $term->term_id);
- if ( $taxonomy == 'post_tag' )
- return get_tag_link((int) $term->term_id);
+ $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');
- }
- return apply_filters('term_link', $termlink, $term, $taxonomy);
+ if ( $t->rewrite['hierarchical'] ) {
+ $hierarchical_slugs = array();
+ $ancestors = get_ancestors($term->term_id, $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 ) {
+
+ /**
+ * Filter 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 ) {
+
+ /**
+ * Filter 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 );
+ }
+
+ /**
+ * Filter 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 );
}
/**
* 'before' : default is empty string. Display before taxonomies list.
* 'sep' : default is empty string. Separate every taxonomy with value in this.
* 'after' : default is empty string. Display this after the taxonomies list.
+ * 'template' : The template to use for displaying the taxonomy terms.
*
* @since 2.5.0
* @uses get_the_taxonomies()
*
* @param array $args Override the defaults.
*/
-function the_taxonomies($args = array()) {
+function the_taxonomies( $args = array() ) {
$defaults = array(
'post' => 0,
'before' => '',
'sep' => ' ',
'after' => '',
+ /* translators: %s: taxonomy label, %l: list of term links */
+ 'template' => __( '%s: %l.' )
);
$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'];
}
/**
*
* @since 2.5.0
*
- * @param int $post Optional. Post ID or will use Global Post ID (in loop).
- * @return array
+ * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
+ * @param array $args Override the defaults.
+ * @return array List of taxonomies.
*/
-function get_the_taxonomies($post = 0) {
- if ( is_int($post) )
- $post =& get_post($post);
- elseif ( !is_object($post) )
- $post =& $GLOBALS['post'];
+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 term links */
+ 'template' => __( '%s: %l.' ),
+ ) );
$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'];
+ }
+ $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='" . esc_attr(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[] = "<a href='" . esc_attr( get_term_link( $term ) ) . "'>$term->name</a>";
+ }
+ if ( $links ) {
+ $taxonomies[$taxonomy] = wp_sprintf( $t['template'], $t['label'], $links, $terms );
+ }
}
return $taxonomies;
}
* Retrieve all taxonomies of a post with just the names.
*
* @since 2.5.0
+ *
* @uses get_object_taxonomies()
*
- * @param int $post Optional. Post ID
+ * @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);
+function get_post_taxonomies( $post = 0 ) {
+ $post = get_post( $post );
return get_object_taxonomies($post);
}
* @uses get_object_term_cache()
* @uses wp_get_object_terms()
*
- * @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
+ * @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
* @return bool|WP_Error. WP_Error on input error.
*/
function is_object_in_term( $object_id, $taxonomy, $terms = null ) {
return new WP_Error( 'invalid_object', __( 'Invalid object ID' ) );
$object_terms = get_object_term_cache( $object_id, $taxonomy );
- if ( empty( $object_terms ) )
+ if ( false === $object_terms )
$object_terms = wp_get_object_terms( $object_id, $taxonomy );
if ( is_wp_error( $object_terms ) )
return false;
}
-?>
+/**
+ * Determine if the given object type is associated with the given taxonomy.
+ *
+ * @since 3.0.0
+ * @uses get_object_taxonomies()
+ *
+ * @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;
+
+ if ( in_array($taxonomy, $taxonomies) )
+ return true;
+
+ return false;
+}
+
+/**
+ * Get an array of ancestor IDs for a given object.
+ *
+ * @param int $object_id The ID of the object
+ * @param string $object_type The type of object for which we'll be retrieving ancestors.
+ * @return array of ancestors from lowest to highest in the hierarchy.
+ */
+function get_ancestors($object_id = 0, $object_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 );
+ }
+
+ if ( is_taxonomy_hierarchical( $object_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_exists( $object_type ) ) {
+ $ancestors = get_post_ancestors($object_id);
+ }
+
+ /**
+ * Filter a given object's ancestors.
+ *
+ * @since 3.1.0
+ *
+ * @param array $ancestors An array of object ancestors.
+ * @param int $object_id Object ID.
+ * @param string $object_type Type of object.
+ */
+ return apply_filters( 'get_ancestors', $ancestors, $object_id, $object_type );
+}
+
+/**
+ * Returns the term's parent's term_ID
+ *
+ * @since 3.1.0
+ *
+ * @param int $term_id
+ * @param string $taxonomy
+ *
+ * @return int|bool 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 wp_update_term_parent filter.
+ *
+ * @since 3.1.0
+ * @uses wp_find_hierarchy_loop()
+ *
+ * @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