X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/959f97d8ecd5c1668103a3e41c795486b944bc68..refs/tags/wordpress-2.9.2-scripts:/wp-includes/taxonomy.php diff --git a/wp-includes/taxonomy.php b/wp-includes/taxonomy.php index 2407e14e..98282027 100644 --- a/wp-includes/taxonomy.php +++ b/wp-includes/taxonomy.php @@ -1,8 +1,10 @@ 'category', 'object_type' => 'post', 'hierarchical' => true, 'update_count_callback' => '_update_post_term_count'); -$wp_taxonomies['post_tag'] = (object) array('name' => 'post_tag', 'object_type' => 'post', 'hierarchical' => false, 'update_count_callback' => '_update_post_term_count'); -$wp_taxonomies['link_category'] = (object) array('name' => 'link_category', 'object_type' => 'link', 'hierarchical' => false); +function create_initial_taxonomies() { + 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) ) ; +} +add_action( 'init', 'create_initial_taxonomies', 0 ); // highest priority /** - * get_object_taxonomies() - Return all of the taxonomy names that are of $object_type + * Return all of the taxonomy names that are of $object_type. * * It appears that this function can be used to find all of the names inside of * $wp_taxonomies global variable. * - * - * Should result in Array('category', 'post_tag') + * Should + * result in Array('category', 'post_tag') * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @@ -49,7 +51,7 @@ function get_object_taxonomies($object) { $object = (array) $object; $taxonomies = array(); - foreach ( $wp_taxonomies as $taxonomy ) { + foreach ( (array) $wp_taxonomies as $taxonomy ) { if ( array_intersect($object, (array) $taxonomy->object_type) ) $taxonomies[] = $taxonomy->name; } @@ -58,14 +60,14 @@ function get_object_taxonomies($object) { } /** - * get_taxonomy() - Returns the taxonomy object of $taxonomy. + * Retrieves the taxonomy object of $taxonomy. * * The get_taxonomy function will first check that the parameter string given * is a taxonomy object and if it is, it will return it. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @uses is_taxonomy() Checks whether taxonomy exists @@ -83,11 +85,11 @@ function get_taxonomy( $taxonomy ) { } /** - * is_taxonomy() - Checks that the taxonomy name exists + * Checks that the taxonomy name exists. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @@ -101,16 +103,16 @@ function is_taxonomy( $taxonomy ) { } /** - * is_taxonomy_hierarchical() - Whether the taxonomy object is hierarchical + * Whether the taxonomy object is hierarchical. * - * Checks to make sure that the taxonomy is an object first. Then Gets the object, and finally - * returns the hierarchical value in the object. + * Checks to make sure that the taxonomy is an object first. Then Gets the + * object, and finally returns the hierarchical value in the object. * * A false return value might also mean that the taxonomy does not exist. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses is_taxonomy() Checks whether taxonomy exists * @uses get_taxonomy() Used to get the taxonomy object @@ -127,23 +129,33 @@ function is_taxonomy_hierarchical($taxonomy) { } /** - * register_taxonomy() - Create or modify a taxonomy object. Do not use before init. + * Create or modify a taxonomy object. Do not use before init. * - * A simple function for creating or modifying a taxonomy object based on the parameters given. - * The function will accept an array (third optional parameter), along with strings for the - * taxonomy name and another string for the object type. + * A simple function for creating or modifying a taxonomy object based on the + * parameters given. The function will accept an array (third optional + * parameter), along with strings for the taxonomy name and another string for + * the object type. * - * Nothing is returned, so expect error maybe or use is_taxonomy() to check whether taxonomy exists. + * Nothing is returned, so expect error maybe or use is_taxonomy() 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 - * query_var - false to prevent queries, or string to customize query var (?$query_var=$term); default will use $taxonomy as query var + * + * hierarachical - has some defined purpose at other parts of the API and is a + * boolean value. + * + * update_count_callback - works much like a hook, in that it will be called + * when the count is updated. + * + * rewrite - false to prevent rewrite, or array('slug'=>$slug) to customize + * permastruct; default will use $taxonomy as slug. + * + * query_var - false to prevent queries, or string to customize query var + * (?$query_var=$term); default will use $taxonomy as query var. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @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 @@ -155,11 +167,14 @@ function is_taxonomy_hierarchical($taxonomy) { function register_taxonomy( $taxonomy, $object_type, $args = array() ) { global $wp_taxonomies, $wp_rewrite, $wp; + 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); if ( false !== $args['query_var'] && !empty($wp) ) { - if ( empty($args['query_var']) ) + 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']); @@ -184,22 +199,23 @@ function register_taxonomy( $taxonomy, $object_type, $args = array() ) { // /** - * get_objects_in_term() - Return object_ids of valid taxonomy and term + * Retrieve object_ids of valid taxonomy and term. * - * The strings of $taxonomies must exist before this function will continue. On failure of finding - * a valid taxonomy, it will return an WP_Error class, kind of like Exceptions in PHP 5, except you - * can't catch them. Even so, you can still test for the WP_Error class and get the error message. + * The strings of $taxonomies must exist before this function will continue. On + * failure of finding a valid taxonomy, it will return an WP_Error class, kind + * of like Exceptions in PHP 5, except you can't catch them. Even so, you can + * still test for the WP_Error class and get the error message. * - * The $terms aren't checked the same as $taxonomies, but still need to exist for $object_ids to - * be returned. + * The $terms aren't checked the same as $taxonomies, but still need to exist + * for $object_ids to be returned. * - * It is possible to change the order that object_ids is returned by either using PHP sort family - * functions or using the database by using $args with either ASC or DESC array. The value should - * be in the key named 'order'. + * It is possible to change the order that object_ids is returned by either + * using PHP sort family functions or using the database by using $args with + * either ASC or DESC array. The value should be in the key named 'order'. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses wp_parse_args() Creates an array from string $args. @@ -219,7 +235,7 @@ function get_objects_in_term( $terms, $taxonomies, $args = array() ) { if ( !is_array($taxonomies) ) $taxonomies = array($taxonomies); - foreach ( $taxonomies as $taxonomy ) { + foreach ( (array) $taxonomies as $taxonomy ) { if ( ! is_taxonomy($taxonomy) ) return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); } @@ -244,30 +260,33 @@ function get_objects_in_term( $terms, $taxonomies, $args = array() ) { } /** - * get_term() - Get all Term data from database by Term ID. + * Get all Term data from database by Term ID. * - * The usage of the get_term function is to apply filters to a term object. - * It is possible to get a term object from the database before applying the + * The usage of the get_term function is to apply filters to a term object. It + * is possible to get a term object from the database before applying the * filters. * - * $term ID must be part of $taxonomy, to get from the database. Failure, might be - * able to be captured by the hooks. Failure would be the same value as $wpdb returns for the - * get_row method. + * $term ID must be part of $taxonomy, to get from the database. Failure, might + * be able to be captured by the hooks. Failure would be the same value as $wpdb + * returns for the get_row method. * - * There are two hooks, one is specifically for each term, named 'get_term', and the second is - * for the taxonomy name, 'term_$taxonomy'. Both hooks gets the term object, and the taxonomy - * name as parameters. Both hooks are expected to return a Term object. + * There are two hooks, one is specifically for each term, named 'get_term', and + * the second is for the taxonomy name, 'term_$taxonomy'. Both hooks gets the + * term object, and the taxonomy name as parameters. Both hooks are expected to + * return a Term object. * - * 'get_term' hook - Takes two parameters the term Object and the taxonomy name. Must return - * term object. Used in get_term() as a catch-all filter for every $term. + * 'get_term' hook - Takes two parameters the term Object and the taxonomy name. + * Must return term object. Used in get_term() as a catch-all filter for every + * $term. * - * 'get_$taxonomy' hook - Takes two parameters the term Object and the taxonomy name. Must return - * term object. $taxonomy will be the taxonomy name, so for example, if 'category', it would be - * 'get_category' as the filter name. Useful for custom taxonomies or plugging into default taxonomies. + * 'get_$taxonomy' hook - Takes two parameters the term Object and the taxonomy + * name. Must return term object. $taxonomy will be the taxonomy name, so for + * example, if 'category', it would be 'get_category' as the filter name. Useful + * for custom taxonomies or plugging into default taxonomies. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses sanitize_term() Cleanses the term based on $filter context before returning. @@ -282,20 +301,29 @@ function get_objects_in_term( $terms, $taxonomies, $args = array() ) { */ function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') { global $wpdb; + $null = null; - if ( empty($term) ) - return null; + if ( empty($term) ) { + $error = new WP_Error('invalid_term', __('Empty Term')); + return $error; + } - if ( ! is_taxonomy($taxonomy) ) - return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); + if ( ! is_taxonomy($taxonomy) ) { + $error = new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); + return $error; + } - if ( is_object($term) ) { + if ( is_object($term) && empty($term->filter) ) { wp_cache_add($term->term_id, $term, $taxonomy); $_term = $term; } else { + if ( is_object($term) ) + $term = $term->term_id; $term = (int) $term; if ( ! $_term = wp_cache_get($term, $taxonomy) ) { $_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND t.term_id = %s LIMIT 1", $taxonomy, $term) ); + if ( ! $_term ) + return $null; wp_cache_add($term, $_term, $taxonomy); } } @@ -307,28 +335,31 @@ function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') { if ( $output == OBJECT ) { return $_term; } elseif ( $output == ARRAY_A ) { - return get_object_vars($_term); + $__term = get_object_vars($_term); + return $__term; } elseif ( $output == ARRAY_N ) { - return array_values(get_object_vars($_term)); + $__term = array_values(get_object_vars($_term)); + return $__term; } else { return $_term; } } /** - * get_term_by() - Get all Term data from database by Term field and data. + * Get all Term data from database by Term field and data. * - * Warning: $value is not escaped for 'name' $field. You must do it yourself, if required. + * Warning: $value is not escaped for 'name' $field. You must do it yourself, if + * required. * - * The default $field is 'id', therefore it is possible to also use null for field, but not - * recommended that you do so. + * The default $field is 'id', therefore it is possible to also use null for + * field, but not recommended that you do so. * - * If $value does not exist, the return value will be false. If $taxonomy exists and $field - * and $value combinations exist, the Term will be returned. + * If $value does not exist, the return value will be false. If $taxonomy exists + * and $field and $value combinations exist, the Term will be returned. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses sanitize_term() Cleanses the term based on $filter context before returning. @@ -354,6 +385,7 @@ function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw return false; } else if ( 'name' == $field ) { // Assume already escaped + $value = stripslashes($value); $field = 't.name'; } else { $field = 't.term_id'; @@ -380,37 +412,39 @@ function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw } /** - * get_term_children() - Merge all term children into a single array. + * Merge all term children into a single array of their IDs. * - * This recursive function will merge all of the children of $term into - * the same array. Only useful for taxonomies which are hierarchical. + * This recursive function will merge all of the children of $term into the same + * array of term IDs. Only useful for taxonomies which are hierarchical. * * Will return an empty array if $term does not exist in $taxonomy. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @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 Name of Term to get children + * @param string $term 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 */ -function get_term_children( $term, $taxonomy ) { +function get_term_children( $term_id, $taxonomy ) { if ( ! is_taxonomy($taxonomy) ) return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); + $term_id = intval( $term_id ); + $terms = _get_term_hierarchy($taxonomy); - if ( ! isset($terms[$term]) ) + if ( ! isset($terms[$term_id]) ) return array(); - $children = $terms[$term]; + $children = $terms[$term_id]; - foreach ( $terms[$term] as $child ) { + foreach ( (array) $terms[$term_id] as $child ) { if ( isset($terms[$child]) ) $children = array_merge($children, get_term_children($child, $taxonomy)); } @@ -419,15 +453,15 @@ function get_term_children( $term, $taxonomy ) { } /** - * get_term_field() - Get sanitized Term field + * Get sanitized Term field. * - * Does checks for $term, based on the $taxonomy. The function is for - * contextual reasons and for simplicity of usage. See sanitize_term_field() for - * more information. + * Does checks for $term, based on the $taxonomy. The function is for contextual + * reasons and for simplicity of usage. See sanitize_term_field() for more + * information. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success. * @@ -453,14 +487,14 @@ function get_term_field( $field, $term, $taxonomy, $context = 'display' ) { } /** - * get_term_to_edit() - Sanitizes Term for editing + * Sanitizes Term for editing. * - * Return value is sanitize_term() and usage is for sanitizing the term - * for editing. Function is for contextual and simplicity. + * Return value is sanitize_term() and usage is for sanitizing the term for + * editing. Function is for contextual and simplicity. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses sanitize_term() Passes the return value on success * @@ -481,49 +515,92 @@ function get_term_to_edit( $id, $taxonomy ) { } /** - * get_terms() - Retrieve the terms in taxonomy or list of taxonomies. + * Retrieve the terms in a given taxonomy or list of taxonomies. + * + * You can fully inject any customizations to the query before it is sent, as + * well as control the output with a filter. + * + * The 'get_terms' filter will be called when the cache has the term and will + * pass the found term along with the array of $taxonomies and array of $args. + * This filter is also called before the array of terms is passed and will pass + * the array of terms, along with the $taxonomies and $args. + * + * The 'list_terms_exclusions' filter passes the compiled exclusions along with + * the $args. * - * You can fully inject any customizations to the query before it is sent, as well as control - * the output with a filter. + * The 'get_terms_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 'get_terms' filter will be called when the cache has the term and will pass the found - * term along with the array of $taxonomies and array of $args. This filter is also called - * before the array of terms is passed and will pass the array of terms, along with the $taxonomies - * and $args. + * The list of arguments that $args can contain, which will overwrite the defaults: * - * The 'list_terms_exclusions' filter passes the compiled exclusions along with the $args. + * 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. * - * The list that $args can contain, which will overwrite the defaults. - * orderby - Default is 'name'. Can be name, count, or nothing (will use term_id). * order - Default is ASC. Can use DESC. - * hide_empty - Default is true. Will not return empty $terms. - * fields - Default is all. - * slug - Any terms that has this value. Default is empty string. - * hierarchical - Whether to return hierarchical taxonomy. Default is true. - * name__like - Default is empty string. * - * The argument 'pad_counts' will count all of the children along with the $terms. + * 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. * - * The 'get' argument allows for overwriting 'hide_empty' and 'child_of', which can be done by - * setting the value to 'all', instead of its default empty string value. + * offset - The number by which to offset the terms query. * - * The 'child_of' argument will be used if you use multiple taxonomy or the first $taxonomy - * isn't hierarchical or 'parent' isn't used. The default is 0, which will be translated to - * a false value. If 'child_of' is set, then 'child_of' value will be tested against - * $taxonomy to see if 'child_of' is contained within. Will return an empty array if test - * fails. + * 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. * - * If 'parent' is set, then it will be used to test against the first taxonomy. Much like - * 'child_of'. Will return an empty array if the test fails. + * 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 + * @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. @@ -538,15 +615,17 @@ function &get_terms($taxonomies, $args = '') { $taxonomies = array($taxonomies); } - foreach ( $taxonomies as $taxonomy ) { - if ( ! is_taxonomy($taxonomy) ) - return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); + foreach ( (array) $taxonomies as $taxonomy ) { + if ( ! is_taxonomy($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' => '', 'include' => '', + 'hide_empty' => true, 'exclude' => '', 'exclude_tree' => '', 'include' => '', 'number' => '', 'fields' => 'all', 'slug' => '', 'parent' => '', 'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '', 'pad_counts' => false, 'offset' => '', 'search' => ''); @@ -554,7 +633,7 @@ function &get_terms($taxonomies, $args = '') { $args['number'] = absint( $args['number'] ); $args['offset'] = absint( $args['offset'] ); if ( !$single_taxonomy || !is_taxonomy_hierarchical($taxonomies[0]) || - '' != $args['parent'] ) { + '' !== $args['parent'] ) { $args['child_of'] = 0; $args['hierarchical'] = false; $args['pad_counts'] = false; @@ -581,31 +660,42 @@ function &get_terms($taxonomies, $args = '') { } // $args can be whatever, only use the args defined in defaults to compute the key - $key = md5( serialize( compact(array_keys($defaults)) ) . serialize( $taxonomies ) ); - - if ( $cache = wp_cache_get( 'get_terms', 'terms' ) ) { - if ( isset( $cache[ $key ] ) ) - return apply_filters('get_terms', $cache[$key], $taxonomies, $args); - } - - if ( 'count' == $orderby ) + $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'); + } + $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); + return $cache; + } + + $_orderby = strtolower($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'; - else + elseif ( empty($_orderby) || 'id' == $_orderby ) $orderby = 't.term_id'; + $orderby = apply_filters( 'get_terms_orderby', $orderby, $args ); + $where = ''; $inclusions = ''; if ( !empty($include) ) { $exclude = ''; + $exclude_tree = ''; $interms = preg_split('/[\s,]+/',$include); if ( count($interms) ) { - foreach ( $interms as $interm ) { + foreach ( (array) $interms as $interm ) { if (empty($inclusions)) $inclusions = ' AND ( t.term_id = ' . intval($interm) . ' '; else @@ -619,11 +709,25 @@ function &get_terms($taxonomies, $args = '') { $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) . ' '; + + } + } + } if ( !empty($exclude) ) { $exterms = preg_split('/[\s,]+/',$exclude); if ( count($exterms) ) { - foreach ( $exterms as $exterm ) { - if (empty($exclusions)) + foreach ( (array) $exterms as $exterm ) { + if ( empty($exclusions) ) $exclusions = ' AND ( t.term_id <> ' . intval($exterm) . ' '; else $exclusions .= ' AND t.term_id <> ' . intval($exterm) . ' '; @@ -644,7 +748,7 @@ function &get_terms($taxonomies, $args = '') { if ( !empty($name__like) ) $where .= " AND t.name LIKE '{$name__like}%'"; - if ( '' != $parent ) { + if ( '' !== $parent ) { $parent = (int) $parent; $where .= " AND tt.parent = '$parent'"; } @@ -652,61 +756,62 @@ function &get_terms($taxonomies, $args = '') { if ( $hide_empty && !$hierarchical ) $where .= ' AND tt.count > 0'; - if ( !empty($number) ) { + // don't limit the query results when we have to descend the family tree + if ( ! empty($number) && ! $hierarchical && empty( $child_of ) && '' === $parent ) { if( $offset ) - $number = 'LIMIT ' . $offset . ',' . $number; + $limit = 'LIMIT ' . $offset . ',' . $number; else - $number = 'LIMIT ' . $number; + $limit = 'LIMIT ' . $number; } else - $number = ''; + $limit = ''; if ( !empty($search) ) { $search = like_escape($search); $where .= " AND (t.name LIKE '%$search%')"; } - $select_this = ''; + $selects = array(); if ( 'all' == $fields ) - $select_this = 't.*, tt.*'; + $selects = array('t.*', 'tt.*'); else if ( 'ids' == $fields ) - $select_this = 't.term_id'; + $selects = array('t.term_id', 'tt.parent', 'tt.count'); else if ( 'names' == $fields ) - $select_this = 't.name'; + $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 $number"; + $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"; + $terms = $wpdb->get_results($query); if ( 'all' == $fields ) { - $terms = $wpdb->get_results($query); update_term_cache($terms); - } else if ( ('ids' == $fields) || ('names' == $fields) ) { - $terms = $wpdb->get_col($query); } if ( empty($terms) ) { - $cache[ $key ] = array(); - wp_cache_set( 'get_terms', $cache, 'terms' ); - return apply_filters('get_terms', array(), $taxonomies, $args); + wp_cache_add( $cache_key, array(), 'terms' ); + $terms = apply_filters('get_terms', array(), $taxonomies, $args); + return $terms; } - if ( $child_of || $hierarchical ) { + if ( $child_of ) { $children = _get_term_hierarchy($taxonomies[0]); if ( ! empty($children) ) $terms = & _get_term_children($child_of, $terms, $taxonomies[0]); } // Update term counts to include children. - if ( $pad_counts ) + if ( $pad_counts && 'all' == $fields ) _pad_term_counts($terms, $taxonomies[0]); // Make sure we show empty categories that have children. - if ( $hierarchical && $hide_empty ) { + if ( $hierarchical && $hide_empty && is_array($terms) ) { foreach ( $terms as $k => $term ) { if ( ! $term->count ) { $children = _get_term_children($term->term_id, $terms, $taxonomies[0]); - foreach ( $children as $child ) - if ( $child->count ) - continue 2; + if( is_array($children) ) + foreach ( $children as $child ) + if ( $child->count ) + continue 2; // It really is empty unset($terms[$k]); @@ -715,59 +820,104 @@ function &get_terms($taxonomies, $args = '') { } reset ( $terms ); - $cache[ $key ] = $terms; - wp_cache_set( 'get_terms', $cache, 'terms' ); + $_terms = array(); + if ( 'ids' == $fields ) { + while ( $term = array_shift($terms) ) + $_terms[] = $term->term_id; + $terms = $_terms; + } elseif ( 'names' == $fields ) { + while ( $term = array_shift($terms) ) + $_terms[] = $term->name; + $terms = $_terms; + } + + if ( 0 < $number && intval(@count($terms)) > $number ) { + $terms = array_slice($terms, $offset, $number); + } + + wp_cache_add( $cache_key, $terms, 'terms' ); $terms = apply_filters('get_terms', $terms, $taxonomies, $args); return $terms; } /** - * is_term() - Check if Term exists + * Check if Term exists. * * Returns the index of a defined term, or 0 (false) if the term doesn't exist. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.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. */ -function is_term($term, $taxonomy = '') { +function is_term($term, $taxonomy = '', $parent = 0) { global $wpdb; + $select = "SELECT term_id FROM $wpdb->terms as t WHERE "; + $tax_select = "SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE "; + if ( is_int($term) ) { if ( 0 == $term ) return 0; - $where = $wpdb->prepare( "t.term_id = %d", $term ); - } else { - if ( '' === $term = sanitize_title($term) ) - return 0; - $where = $wpdb->prepare( "t.slug = %s", $term ); + $where = 't.term_id = %d'; + if ( !empty($taxonomy) ) + return $wpdb->get_row( $wpdb->prepare( $tax_select . $where . " AND tt.taxonomy = %s", $term, $taxonomy ), ARRAY_A ); + else + return $wpdb->get_var( $wpdb->prepare( $select . $where, $term ) ); } - if ( !empty($taxonomy) ) - return $wpdb->get_row("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $where AND tt.taxonomy = '$taxonomy'", ARRAY_A); + $term = trim( stripslashes( $term ) ); + + if ( '' === $slug = sanitize_title($term) ) + return 0; - return $wpdb->get_var("SELECT term_id FROM $wpdb->terms as t WHERE $where"); + $where = 't.slug = %s'; + $else_where = 't.name = %s'; + $where_fields = array($slug); + $else_where_fields = array($term); + if ( !empty($taxonomy) ) { + $parent = (int) $parent; + if ( $parent > 0 ) { + $where_fields[] = $parent; + $else_where_fields[] = $parent; + $where .= ' AND tt.parent = %d'; + $else_where .= ' AND tt.parent = %d'; + } + + $where_fields[] = $taxonomy; + $else_where_fields[] = $taxonomy; + + if ( $result = $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $where AND tt.taxonomy = %s", $where_fields), ARRAY_A) ) + return $result; + + return $wpdb->get_row( $wpdb->prepare("SELECT tt.term_id, tt.term_taxonomy_id FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy as tt ON tt.term_id = t.term_id WHERE $else_where AND tt.taxonomy = %s", $else_where_fields), ARRAY_A); + } + + if ( $result = $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $where", $where_fields) ) ) + return $result; + + return $wpdb->get_var( $wpdb->prepare("SELECT term_id FROM $wpdb->terms as t WHERE $else_where", $else_where_fields) ); } /** - * sanitize_term() - Sanitize Term all fields + * Sanitize Term all fields. * - * Relys on sanitize_term_field() to sanitize the term. The difference - * is that this function will sanitize all fields. The context - * is based on sanitize_term_field(). + * Relys on sanitize_term_field() to sanitize the term. The difference is that + * this function will sanitize all 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 + * @since 2.3.0 * * @uses sanitize_term_field Used to sanitize all fields in a term * @@ -787,30 +937,42 @@ function sanitize_term($term, $taxonomy, $context = 'display') { if ( is_object($term) ) $do_object = true; - foreach ( $fields as $field ) { - if ( $do_object ) - $term->$field = sanitize_term_field($field, $term->$field, $term->term_id, $taxonomy, $context); - else - $term[$field] = sanitize_term_field($field, $term[$field], $term['term_id'], $taxonomy, $context); + $term_id = $do_object ? $term->term_id : (isset($term['term_id']) ? $term['term_id'] : 0); + + foreach ( (array) $fields as $field ) { + if ( $do_object ) { + if ( isset($term->$field) ) + $term->$field = sanitize_term_field($field, $term->$field, $term_id, $taxonomy, $context); + } else { + if ( isset($term[$field]) ) + $term[$field] = sanitize_term_field($field, $term[$field], $term_id, $taxonomy, $context); + } } + if ( $do_object ) + $term->filter = $context; + else + $term['filter'] = $context; + return $term; } /** - * sanitize_term_field() - Cleanse the field value in the term based on the context + * Cleanse the field value in the term based on the context. * - * Passing a term field value through the function should be assumed to have cleansed - * the value for whatever context the term field is going to be used. + * Passing a term field value through the function should be assumed to have + * cleansed the value for whatever context the term field is going to be used. * - * If no context or an unsupported context is given, then default filters will be applied. + * If no context or an unsupported context is given, then default filters will + * be applied. * - * There are enough filters for each context to support a custom filtering without creating - * your own filter function. Simply create a function that hooks into the filter you need. + * There are enough filters for each context to support a custom filtering + * without creating your own filter function. Simply create a function that + * hooks into the filter you need. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @@ -837,7 +999,7 @@ function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) { if ( 'description' == $field ) $value = format_to_edit($value); else - $value = attribute_escape($value); + $value = esc_attr($value); } else if ( 'db' == $context ) { $value = apply_filters("pre_term_$field", $value, $taxonomy); $value = apply_filters("pre_${taxonomy}_$field", $value); @@ -855,22 +1017,22 @@ function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) { } if ( 'attribute' == $context ) - $value = attribute_escape($value); + $value = esc_attr($value); else if ( 'js' == $context ) - $value = js_escape($value); + $value = esc_js($value); return $value; } /** - * wp_count_terms() - Count how many terms are in Taxonomy + * Count how many terms are in Taxonomy. * - * Default $args is 'ignore_empty' which can be 'ignore_empty=true' or - * array('ignore_empty' => true);. + * Default $args is 'ignore_empty' which can be 'ignore_empty=true' + * or array('ignore_empty' => true);. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array. @@ -890,20 +1052,19 @@ function wp_count_terms( $taxonomy, $args = array() ) { if ( $ignore_empty ) $where = 'AND count > 0'; - $taxonomy = $wpdb->escape( $taxonomy ); - return $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE taxonomy = '$taxonomy' $where"); + return $wpdb->get_var( $wpdb->prepare("SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE taxonomy = %s $where", $taxonomy) ); } /** - * wp_delete_object_term_relationships() - Will unlink the term from the taxonomy + * Will unlink the term from the taxonomy. * - * 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 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. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int $object_id The term Object Id that refers to the term @@ -917,31 +1078,35 @@ function wp_delete_object_term_relationships( $object_id, $taxonomies ) { if ( !is_array($taxonomies) ) $taxonomies = array($taxonomies); - foreach ( $taxonomies as $taxonomy ) { - $terms = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids'); - $in_terms = "'" . implode("', '", $terms) . "'"; - $wpdb->query("DELETE FROM $wpdb->term_relationships WHERE object_id = '$object_id' AND term_taxonomy_id IN ($in_terms)"); - wp_update_term_count($terms, $taxonomy); + foreach ( (array) $taxonomies as $taxonomy ) { + $tt_ids = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids'); + $in_tt_ids = "'" . implode("', '", $tt_ids) . "'"; + do_action( 'delete_term_relationships', $object_id, $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) ); + do_action( 'deleted_term_relationships', $object_id, $tt_ids ); + wp_update_term_count($tt_ids, $taxonomy); } } /** - * wp_delete_term() - Removes a term from the database. + * Removes a term from the database. * - * If the term is a parent of other terms, then the children will be updated - * to that term's parent. + * If the term is a parent of other terms, then the children will be updated to + * that term's parent. * * The $args 'default' will only override the terms found, if there is only one * term found. Any other and the found terms are used. * + * 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 + * @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. + * @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 @@ -977,22 +1142,30 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) { 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 ); + do_action( 'edit_term_taxonomies', $edit_tt_ids ); $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id) + compact( 'taxonomy' ) ); + 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 ) ); foreach ( (array) $objects as $object ) { - $terms = wp_get_object_terms($object, $taxonomy, 'fields=ids'); - if ( 1 == count($terms) && isset($default) ) + $terms = wp_get_object_terms($object, $taxonomy, array('fields' => 'ids', 'orderby' => 'none')); + if ( 1 == count($terms) && isset($default) ) { $terms = array($default); - else + } else { $terms = array_diff($terms, array($term)); + if (isset($default) && isset($force_default) && $force_default) + $terms = array_merge($terms, array($default)); + } $terms = array_map('intval', $terms); wp_set_object_terms($object, $terms, $taxonomy); } + do_action( 'delete_term_taxonomy', $tt_id ); $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $tt_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) ) ) @@ -1007,28 +1180,30 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) { } /** - * wp_get_object_terms() - Retrieves the terms associated with the given object(s), in the supplied taxonomies. + * Retrieves the terms associated with the given object(s), in the supplied taxonomies. * - * The following information has to do the $args parameter and for what can be contained in the string - * or array of that parameter, if it exists. + * The following information has to do the $args parameter and for what can be + * contained in the string or array of that parameter, if it exists. * - * The first argument is called, 'orderby' and has the default value of 'name'. The other value that is - * supported is 'count'. + * The first argument is called, 'orderby' and has the default value of 'name'. + * The other value that is supported is 'count'. * - * The second argument is called, 'order' and has the default value of 'ASC'. The only other value that - * will be acceptable is 'DESC'. + * The second argument is called, 'order' and has the default value of 'ASC'. + * The only other value that will be acceptable is 'DESC'. * - * The final argument supported is called, 'fields' and has the default value of 'all'. There are - * multiple other options that can be used instead. Supported values are as follows: 'all', 'ids', - * 'names', and finally 'all_with_object_id'. + * The final argument supported is called, 'fields' and has the default value of + * 'all'. There are multiple other options that can be used instead. Supported + * values are as follows: 'all', 'ids', 'names', and finally + * 'all_with_object_id'. * - * The fields argument also decides what will be returned. If 'all' or 'all_with_object_id' is choosen or - * the default kept intact, then all matching terms objects will be returned. If either 'ids' or 'names' - * is used, then an array of all matching term ids or term names will be returned respectively. + * The fields argument also decides what will be returned. If 'all' or + * 'all_with_object_id' is choosen or the default kept intact, then all matching + * terms objects will be returned. If either 'ids' or 'names' is used, then an + * array of all matching term ids or term names will be returned respectively. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int|array $object_id The id of the object(s) to retrieve. @@ -1042,7 +1217,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { if ( !is_array($taxonomies) ) $taxonomies = array($taxonomies); - foreach ( $taxonomies as $taxonomy ) { + foreach ( (array) $taxonomies as $taxonomy ) { if ( ! is_taxonomy($taxonomy) ) return new WP_Error('invalid_taxonomy', __('Invalid Taxonomy')); } @@ -1058,14 +1233,14 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { if ( count($taxonomies) > 1 ) { foreach ( $taxonomies as $index => $taxonomy ) { $t = get_taxonomy($taxonomy); - if ( is_array($t->args) && $args != array_merge($args, $t->args) ) { + if ( isset($t->args) && is_array($t->args) && $args != array_merge($args, $t->args) ) { unset($taxonomies[$index]); $terms = array_merge($terms, wp_get_object_terms($object_ids, $taxonomy, array_merge($args, $t->args))); } } } else { $t = get_taxonomy($taxonomies[0]); - if ( is_array($t->args) ) + if ( isset($t->args) && is_array($t->args) ) $args = array_merge($args, $t->args); } @@ -1081,8 +1256,19 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { $orderby = 't.term_group'; else if ( 'term_order' == $orderby ) $orderby = 'tr.term_order'; - else + else if ( 'none' == $orderby ) { + $orderby = ''; + $order = ''; + } else { $orderby = 't.term_id'; + } + + // tt_ids queries can only be none or tr.term_taxonomy_id + if ( ('tt_ids' == $fields) && !empty($orderby) ) + $orderby = 'tr.term_taxonomy_id'; + + if ( !empty($orderby) ) + $orderby = "ORDER BY $orderby"; $taxonomies = "'" . implode("', '", $taxonomies) . "'"; $object_ids = implode(', ', $object_ids); @@ -1097,7 +1283,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { 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) ORDER BY $orderby $order"; + $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"; if ( 'all' == $fields || 'all_with_object_id' == $fields ) { $terms = array_merge($terms, $wpdb->get_results($query)); @@ -1105,48 +1291,54 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { } else if ( 'ids' == $fields || 'names' == $fields ) { $terms = array_merge($terms, $wpdb->get_col($query)); } else if ( 'tt_ids' == $fields ) { - $terms = $wpdb->get_col("SELECT tr.term_taxonomy_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tr.object_id IN ($object_ids) AND tt.taxonomy IN ($taxonomies) ORDER BY tr.term_taxonomy_id $order"); + $terms = $wpdb->get_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"); } if ( ! $terms ) - return array(); + $terms = array(); - return $terms; + return apply_filters('wp_get_object_terms', $terms, $object_ids, $taxonomies, $args); } /** - * wp_insert_term() - Adds a new term to the database. Optionally marks it as an alias of an existing term. + * 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. + * 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. + * It is assumed that the term does not yet exist or the above will apply. The + * term will be first added to the term table and then related to the taxonomy + * if everything is well. If everything is correct, then several actions will be + * run prior to a filter and then several actions will be run after the filter + * is run. * - * The arguments decide how the term is handled based on the $args parameter. The following - * is a list of the available overrides and the defaults. + * The arguments decide how the term is handled based on the $args parameter. + * The following is a list of the available overrides and the defaults. * - * 'alias_of'. There is no default, but if added, expected is the slug that the term will be an alias of. - * Expected to be a string. + * 'alias_of'. There is no default, but if added, expected is the slug that the + * term will be an alias of. Expected to be a string. * - * 'description'. There is no default. If exists, will be added to the database along with the term. Expected - * to be a string. + * '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. + * 'parent'. Expected to be numeric and default is 0 (zero). Will assign value + * of 'parent' to the term. * * 'slug'. Expected to be a string. There is no default. * - * If 'slug' argument exists then the slug will be checked to see if it is not a valid term. If that check - * succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check - * is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check - * succeeds, the term will be inserted and the term id will be given. + * If 'slug' argument exists then the slug will be checked to see if it is not + * a valid term. If that check succeeds (it is not a valid term), then it is + * added and the term id is given. If it fails, then a check is made to whether + * the taxonomy is hierarchical and the parent argument is not empty. If the + * second check succeeds, the term will be inserted and the term id will be + * given. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @uses do_action() Calls 'create_term' hook with the term id and taxonomy id as parameters. @@ -1169,6 +1361,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) { if ( is_int($term) && 0 == $term ) return new WP_Error('invalid_term_id', __('Invalid term ID')); + if ( '' == trim($term) ) + return new WP_Error('empty_term_name', __('A name is required for this term')); + $defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => ''); $args = wp_parse_args($args, $defaults); $args['name'] = $term; @@ -1192,7 +1387,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) { } 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; - $wpdb->query( $wpdb->prepare( "UPDATE $wpdb->terms SET term_group = %d WHERE term_id = %d", $term_group, $alias->term_id ) ); + do_action( 'edit_terms', $alias->term_id ); + $wpdb->update($wpdb->terms, compact('term_group'), array('term_id' => $alias->term_id) ); + do_action( 'edited_terms', $alias->term_id ); } } @@ -1211,7 +1408,9 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) { if ( empty($slug) ) { $slug = sanitize_title($slug, $term_id); + do_action( 'edit_terms', $term_id ); $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) ); + do_action( 'edited_terms', $term_id ); } $tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id ) ); @@ -1222,35 +1421,38 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) { $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_term", $term_id, $tt_id, $taxonomy); do_action("create_$taxonomy", $term_id, $tt_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_term", $term_id, $tt_id, $taxonomy); do_action("created_$taxonomy", $term_id, $tt_id); return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id); } /** - * wp_set_object_terms() - Create Term and Taxonomy Relationships + * Create Term and Taxonomy Relationships. * - * Relates an object (post, link etc) to a term and taxonomy type. Creates the term and taxonomy - * relationship if it doesn't already exist. Creates a term if it doesn't exist (using the slug). + * Relates an object (post, link etc) to a term and taxonomy type. Creates the + * term and taxonomy relationship if it doesn't already exist. Creates a term if + * it doesn't exist (using the slug). * - * A relationship means that the term is grouped in or belongs to the taxonomy. A term has no - * meaning until it is given context by defining which taxonomy it exists under. + * A relationship means that the term is grouped in or belongs to the taxonomy. + * A term has no meaning until it is given context by defining which taxonomy it + * exists under. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @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. + * @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 @@ -1267,35 +1469,39 @@ function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) { $terms = array($terms); if ( ! $append ) - $old_terms = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids'); + $old_tt_ids = wp_get_object_terms($object_id, $taxonomy, array('fields' => 'tt_ids', 'orderby' => 'none')); $tt_ids = array(); $term_ids = array(); - foreach ($terms as $term) { + foreach ( (array) $terms as $term) { if ( !strlen(trim($term)) ) continue; - if ( !$id = is_term($term, $taxonomy) ) - $id = wp_insert_term($term, $taxonomy); - if ( is_wp_error($id) ) - return $id; - $term_ids[] = $id['term_id']; - $id = $id['term_taxonomy_id']; - $tt_ids[] = $id; + if ( !$term_info = is_term($term, $taxonomy) ) + $term_info = wp_insert_term($term, $taxonomy); + if ( is_wp_error($term_info) ) + return $term_info; + $term_ids[] = $term_info['term_id']; + $tt_id = $term_info['term_taxonomy_id']; + $tt_ids[] = $tt_id; - if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $id ) ) ) + if ( $wpdb->get_var( $wpdb->prepare( "SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id = %d", $object_id, $tt_id ) ) ) continue; - $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $id ) ); + do_action( 'add_term_relationship', $object_id, $tt_id ); + $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $tt_id ) ); + do_action( 'added_term_relationship', $object_id, $tt_id ); } wp_update_term_count($tt_ids, $taxonomy); if ( ! $append ) { - $delete_terms = array_diff($old_terms, $tt_ids); + $delete_terms = array_diff($old_tt_ids, $tt_ids); if ( $delete_terms ) { $in_delete_terms = "'" . implode("', '", $delete_terms) . "'"; - $wpdb->query("DELETE FROM $wpdb->term_relationships WHERE object_id = '$object_id' AND term_taxonomy_id IN ($in_delete_terms)"); + do_action( 'delete_term_relationships', $object_id, $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) ); + do_action( 'deleted_term_relationships', $object_id, $delete_terms ); wp_update_term_count($delete_terms, $taxonomy); } } @@ -1304,35 +1510,36 @@ function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) { if ( ! $append && isset($t->sort) && $t->sort ) { $values = array(); $term_order = 0; - $final_term_ids = wp_get_object_terms($object_id, $taxonomy, 'fields=tt_ids'); - foreach ( $term_ids as $term_id ) - if ( in_array($term_id, $final_term_ids) ) - $values[] = $wpdb->prepare( "(%d, %d, %d)", $object_id, $term_id, ++$term_order); + $final_tt_ids = wp_get_object_terms($object_id, $taxonomy, '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)"); } + do_action('set_object_terms', $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids); return $tt_ids; } /** - * wp_unique_term_slug() - Will make slug unique, if it isn't already + * Will make slug unique, if it isn't already. * - * The $slug has to be unique global to every taxonomy, meaning that one taxonomy - * term can't have a matching slug with another taxonomy term. Each slug has to be - * globally unique for every taxonomy. + * The $slug has to be unique global to every taxonomy, meaning that one + * taxonomy term can't have a matching slug with another taxonomy term. Each + * slug has to be globally unique for every taxonomy. * - * 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. + * The way this works is that if the taxonomy that the term belongs to is + * heirarchical and has a parent, it will append that parent to the $slug. * - * If that still doesn't return an unique slug, then it try to append a number until - * it finds a number that is truely unique. + * 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. * * The only purpose for $term is for appending a parent, if one exists. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param string $slug The string that will be tried for a unique slug @@ -1377,51 +1584,54 @@ function wp_unique_term_slug($slug, $term) { } /** - * wp_update_term() - Update term based on arguments provided + * Update term based on arguments provided. * - * The $args will indiscriminately override all values with the same field name. Care - * must be taken to not override important information need to update or update will - * fail (or perhaps create a new term, neither would be acceptable). + * The $args will indiscriminately override all values with the same field name. + * Care must be taken to not override important information need to update or + * update will fail (or perhaps create a new term, neither would be acceptable). * - * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not defined - * in $args already. + * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not + * defined in $args already. * - * 'alias_of' will create a term group, if it doesn't already exist, and update it for - * the $term. + * 'alias_of' will create a term group, if it doesn't already exist, and update + * it for the $term. * - * If the 'slug' argument in $args is missing, then the 'name' in $args will be used. - * It should also be noted that if you set 'slug' and it isn't unique then a WP_Error - * will be passed back. If you don't pass any slug, then a unique one will be created - * for you. + * If the 'slug' argument in $args is missing, then the 'name' in $args will be + * used. It should also be noted that if you set 'slug' and it isn't unique then + * a WP_Error will be passed back. If you don't pass any slug, then a unique one + * will be created for you. * - * For what can be overrode in $args, check the term scheme can contain and stay away - * from the term keys. + * 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 + * @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. + * @uses apply_filters() Will call the 'term_id_filter' filter and pass the term + * id and taxonomy id. * - * @param int $term The ID of the term + * @param int $term_id The ID of the term * @param string $taxonomy The context in which to relate the term to the object. * @param array|string $args Overwrite term field values * @return array|WP_Error Returns Term ID and Taxonomy Term ID */ -function wp_update_term( $term, $taxonomy, $args = array() ) { +function wp_update_term( $term_id, $taxonomy, $args = array() ) { global $wpdb; if ( ! is_taxonomy($taxonomy) ) return new WP_Error('invalid_taxonomy', __('Invalid taxonomy')); - $term_id = (int) $term; + $term_id = (int) $term_id; // First, get all of the original args $term = get_term ($term_id, $taxonomy, ARRAY_A); + if ( is_wp_error( $term ) ) + return $term; + // Escape data pulled from DB. $term = add_magic_quotes($term); @@ -1437,6 +1647,9 @@ function wp_update_term( $term, $taxonomy, $args = array() ) { $name = stripslashes($name); $description = stripslashes($description); + if ( '' == trim($name) ) + return new WP_Error('empty_term_name', __('A name is required for this term')); + $empty_slug = false; if ( empty($slug) ) { $empty_slug = true; @@ -1451,7 +1664,9 @@ function wp_update_term( $term, $taxonomy, $args = array() ) { } 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; + do_action( 'edit_terms', $alias->term_id ); $wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) ); + do_action( 'edited_terms', $alias->term_id ); } } @@ -1463,62 +1678,70 @@ function wp_update_term( $term, $taxonomy, $args = array() ) { if ( $empty_slug || ( $parent != $term->parent) ) $slug = wp_unique_term_slug($slug, (object) $args); else - return new WP_Error('duplicate_term_slug', sprintf(__('The slug "%s" is already in use by another term'), $slug)); + return new WP_Error('duplicate_term_slug', sprintf(__('The slug “%s” is already in use by another term'), $slug)); } - + do_action( 'edit_terms', $term_id ); $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' ) ); } + do_action( 'edited_terms', $term_id ); $tt_id = $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id) ); - + do_action( 'edit_term_taxonomy', $tt_id ); $wpdb->update( $wpdb->term_taxonomy, compact( 'term_id', 'taxonomy', 'description', 'parent' ), array( 'term_taxonomy_id' => $tt_id ) ); + do_action( 'edited_term_taxonomy', $tt_id ); - do_action("edit_term", $term_id, $tt_id); + do_action("edit_term", $term_id, $tt_id, $taxonomy); do_action("edit_$taxonomy", $term_id, $tt_id); $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_term", $term_id, $tt_id, $taxonomy); do_action("edited_$taxonomy", $term_id, $tt_id); return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id); } -// enable or disable term count deferring -// if no value is supplied, the current value of the defer setting is returned -function wp_defer_term_counting($defer=NULL) { +/** + * Enable or disable term counting. + * + * @since 2.5.0 + * + * @param bool $defer Optional. Enable if true, disable if false. + * @return bool Whether term counting is enabled or disabled. + */ +function wp_defer_term_counting($defer=null) { static $_defer = false; if ( is_bool($defer) ) { $_defer = $defer; // flush any deferred counts if ( !$defer ) - wp_update_term_count( NULL, NULL, true ); + wp_update_term_count( null, null, true ); } return $_defer; } /** - * wp_update_term_count() - Updates the amount of terms in taxonomy + * Updates the amount of terms in taxonomy. * - * If there is a taxonomy callback applyed, then it will be called for updating the count. + * If there is a taxonomy callback applyed, then it will be called for updating + * the count. * - * The default action is to count what the amount of terms have the relationship of term ID. - * Once that is done, then update the database. + * The default action is to count what the amount of terms have the relationship + * of term ID. Once that is done, then update the database. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * - * @param int|array $terms The ID of the terms + * @param int|array $terms The term_taxonomy_id of the terms * @param string $taxonomy The context of the term. * @return bool If no terms will return false, and if successful will return true. */ @@ -1526,7 +1749,7 @@ function wp_update_term_count( $terms, $taxonomy, $do_deferred=false ) { static $_deferred = array(); if ( $do_deferred ) { - foreach ( array_keys($_deferred) as $tax ) { + foreach ( (array) array_keys($_deferred) as $tax ) { wp_update_term_count_now( $_deferred[$tax], $tax ); unset( $_deferred[$tax] ); } @@ -1548,6 +1771,15 @@ function wp_update_term_count( $terms, $taxonomy, $do_deferred=false ) { return wp_update_term_count_now( $terms, $taxonomy ); } +/** + * Perform term count update immediately. + * + * @since 2.5.0 + * + * @param array $terms The term_taxonomy_id of terms to update. + * @param string $taxonomy The context of the term. + * @return bool Always true when complete. + */ function wp_update_term_count_now( $terms, $taxonomy ) { global $wpdb; @@ -1558,9 +1790,11 @@ function wp_update_term_count_now( $terms, $taxonomy ) { call_user_func($taxonomy->update_count_callback, $terms); } else { // Default count updater - foreach ($terms as $term) { + foreach ( (array) $terms as $term) { $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $term) ); + do_action( 'edit_term_taxonomy', $term ); $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) ); + do_action( 'edited_term_taxonomy', $term ); } } @@ -1574,15 +1808,17 @@ function wp_update_term_count_now( $terms, $taxonomy ) { // Cache // + /** - * clean_object_term_cache() - Removes the taxonomy relationship to terms from the cache. + * Removes the taxonomy relationship to terms from the cache. * - * Will remove the entire taxonomy relationship containing term $object_id. The term IDs - * have to exist within the taxonomy $object_type for the deletion to take place. + * Will remove the entire taxonomy relationship containing term $object_id. The + * term IDs have to exist within the taxonomy $object_type for the deletion to + * take place. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @see get_object_taxonomies() for more on $object_type * @uses do_action() Will call action hook named, 'clean_object_term_cache' after completion. @@ -1602,12 +1838,13 @@ function clean_object_term_cache($object_ids, $object_type) { do_action('clean_object_term_cache', $object_ids, $object_type); } + /** - * clean_term_cache() - Will remove all of the term ids from the cache + * Will remove all of the term ids from the cache. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int|array $ids Single or list of Term IDs @@ -1615,6 +1852,7 @@ function clean_object_term_cache($object_ids, $object_type) { */ function clean_term_cache($ids, $taxonomy = '') { global $wpdb; + static $cleaned = array(); if ( !is_array($ids) ) $ids = array($ids); @@ -1637,22 +1875,26 @@ function clean_term_cache($ids, $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"); } - wp_cache_delete('get_terms', 'terms'); + wp_cache_set('last_changed', time(), 'terms'); do_action('clean_term_cache', $ids, $taxonomy); } + /** - * get_object_term_cache() - Retrieves the taxonomy relationship to the term object id. + * Retrieves the taxonomy relationship to the term object id. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses wp_cache_get() Retrieves taxonomy relationship from cache * @@ -1665,23 +1907,23 @@ function &get_object_term_cache($id, $taxonomy) { return $cache; } + /** - * update_object_term_cache() - Updates the cache for Term ID(s) + * Updates the cache for Term ID(s). * * Will only update the cache for terms not already cached. * - * The $object_ids expects that the ids be separated by commas, if it is - * a string. + * The $object_ids expects that the ids be separated by commas, if it is a + * string. * - * It should be noted that update_object_term_cache() is very time extensive. - * It is advised that the function is not called very often or at least not - * for a lot of terms that exist in a lot of taxonomies. The amount of time - * increases for each term and it also increases for each taxonomy the term - * belongs to. + * It should be noted that update_object_term_cache() is very time extensive. It + * is advised that the function is not called very often or at least not for a + * lot of terms that exist in a lot of taxonomies. The amount of time increases + * for each term and it also increases for each taxonomy the term belongs to. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses wp_get_object_terms() Used to get terms from the database to update * * @param string|array $object_ids Single or list of term object ID(s) @@ -1735,18 +1977,19 @@ function update_object_term_cache($object_ids, $object_type) { } } + /** - * update_term_cache() - Updates Terms to Taxonomy in cache. + * Updates Terms to Taxonomy in cache. * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @param array $terms List of Term objects to change * @param string $taxonomy Optional. Update Term to this taxonomy in cache */ function update_term_cache($terms, $taxonomy = '') { - foreach ( $terms as $term ) { + foreach ( (array) $terms as $term ) { $term_taxonomy = $taxonomy; if ( empty($term_taxonomy) ) $term_taxonomy = $term->taxonomy; @@ -1759,19 +2002,20 @@ function update_term_cache($terms, $taxonomy = '') { // Private // + /** - * _get_term_hierarchy() - Retrieves children of taxonomy + * Retrieves children of taxonomy as Term IDs. * * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * - * @uses update_option() Stores all of the children in "$taxonomy_children" option. - * That is the name of the taxonomy, immediately followed by '_children'. + * @uses update_option() Stores all of the children in "$taxonomy_children" + * 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. + * @return array Empty if $taxonomy isn't hierarachical or returns children as Term IDs. */ function _get_term_hierarchy($taxonomy) { if ( !is_taxonomy_hierarchical($taxonomy) ) @@ -1791,21 +2035,22 @@ function _get_term_hierarchy($taxonomy) { return $children; } + /** - * _get_term_children() - Get array of child terms + * Get the subset of $terms that are descendants of $term_id. * - * If $terms is an array of objects, then objects will returned from the function. - * If $terms is an array of IDs, then an array of ids of children will be returned. + * If $terms is an array of objects, then _get_term_children returns an array of objects. + * If $terms is an array of IDs, then _get_term_children returns an array of IDs. * * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * - * @param int $term_id Look for this Term ID in $terms - * @param array $terms List of Term IDs - * @param string $taxonomy Term Context - * @return array Empty if $terms is empty else returns full list of child terms. + * @param int $term_id The ancestor term: all returned terms should be descendants of $term_id. + * @param array $terms The set of terms---either an array of term objects or term IDs---from which those that are descendants of $term_id will be chosen. + * @param string $taxonomy The taxonomy which determines the hierarchy of the terms. + * @return array The subset of $terms that are descendants of $term_id. */ function &_get_term_children($term_id, $terms, $taxonomy) { $empty_array = array(); @@ -1818,7 +2063,7 @@ function &_get_term_children($term_id, $terms, $taxonomy) { if ( ( 0 != $term_id ) && ! isset($has_children[$term_id]) ) return $empty_array; - foreach ( $terms as $term ) { + foreach ( (array) $terms as $term ) { $use_id = false; if ( !is_object($term) ) { $term = get_term($term, $taxonomy); @@ -1847,16 +2092,17 @@ function &_get_term_children($term_id, $terms, $taxonomy) { return $term_list; } + /** - * _pad_term_counts() - Add count of children to parent count + * Add count of children to parent count. * - * Recalculates term counts by including items from child terms. - * Assumes all relevant children are already in the $terms argument + * Recalculates term counts by including items from child terms. Assumes all + * relevant children are already in the $terms argument. * * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param array $terms List of Term IDs @@ -1866,8 +2112,8 @@ function &_get_term_children($term_id, $terms, $taxonomy) { function _pad_term_counts(&$terms, $taxonomy) { global $wpdb; - // This function only works for post categories. - if ( 'category' != $taxonomy ) + // This function only works for hierarchical taxonomies like post categories. + if ( !is_taxonomy_hierarchical( $taxonomy ) ) return; $term_hier = _get_term_hierarchy($taxonomy); @@ -1877,7 +2123,7 @@ function _pad_term_counts(&$terms, $taxonomy) { $term_items = array(); - foreach ( $terms as $key => $term ) { + foreach ( (array) $terms as $key => $term ) { $terms_by_id[$term->term_id] = & $terms[$key]; $term_ids[$term->term_taxonomy_id] = $term->term_id; } @@ -1886,7 +2132,7 @@ function _pad_term_counts(&$terms, $taxonomy) { $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'"); foreach ( $results as $row ) { $id = $term_ids[$row->term_taxonomy_id]; - ++$term_items[$id][$row->object_id]; + $term_items[$id][$row->object_id] = isset($term_items[$id][$row->object_id]) ? ++$term_items[$id][$row->object_id] : 1; } // Touch every ancestor's lookup row for each post in each term @@ -1894,8 +2140,9 @@ function _pad_term_counts(&$terms, $taxonomy) { $child = $term_id; while ( $parent = $terms_by_id[$child]->parent ) { if ( !empty($term_items[$term_id]) ) - foreach ( $term_items[$term_id] as $item_id => $touches ) - ++$term_items[$parent][$item_id]; + foreach ( $term_items[$term_id] as $item_id => $touches ) { + $term_items[$parent][$item_id] = isset($term_items[$parent][$item_id]) ? ++$term_items[$parent][$item_id]: 1; + } $child = $parent; } } @@ -1911,29 +2158,35 @@ function _pad_term_counts(&$terms, $taxonomy) { // /** - * _update_post_term_count() - Will update term count based on posts + * Will update term count based on posts. * - * Private function for the default callback for post_tag and category taxonomies. + * Private function for the default callback for post_tag and category + * taxonomies. * * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * - * @param array $terms List of Term IDs + * @param array $terms List of Term taxonomy IDs */ function _update_post_term_count( $terms ) { global $wpdb; - foreach ( $terms as $term ) { + 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 ) ); + do_action( 'edit_term_taxonomy', $term ); $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) ); + do_action( 'edited_term_taxonomy', $term ); } } + /** - * get_term_link() - Generates a permalink for a taxonomy term archive + * Generates a permalink for a taxonomy term archive. + * + * @since 2.5.0 * * @param object|int|string $term * @param string $taxonomy @@ -1942,14 +2195,6 @@ function _update_post_term_count( $terms ) { function get_term_link( $term, $taxonomy ) { global $wp_rewrite; - // use legacy functions for core taxonomies until they are fully plugged in - if ( $taxonomy == 'category' ) - return get_category_link($term); - if ( $taxonomy == 'post_tag' ) - return get_tag_link($term); - - $termlink = $wp_rewrite->get_extra_permastruct($taxonomy); - if ( !is_object($term) ) { if ( is_int($term) ) { $term = &get_term($term, $taxonomy); @@ -1960,10 +2205,18 @@ function get_term_link( $term, $taxonomy ) { 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); + + $termlink = $wp_rewrite->get_extra_permastruct($taxonomy); + $slug = $term->slug; if ( empty($termlink) ) { - $file = get_option('home') . '/'; + $file = trailingslashit( get_option('home') ); $t = get_taxonomy($taxonomy); if ( $t->query_var ) $termlink = "$file?$t->query_var=$slug"; @@ -1976,6 +2229,24 @@ function get_term_link( $term, $taxonomy ) { return apply_filters('term_link', $termlink, $term, $taxonomy); } +/** + * Display the taxonomies of a post with available options. + * + * This function can be used within the loop to display the taxonomies for a + * post without specifying the Post ID. You can also use it outside the Loop to + * display the taxonomies for a specific post. + * + * The available defaults are: + * 'post' : default is 0. The post ID to get taxonomies of. + * '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. + * + * @since 2.5.0 + * @uses get_the_taxonomies() + * + * @param array $args Override the defaults. + */ function the_taxonomies($args = array()) { $defaults = array( 'post' => 0, @@ -1990,6 +2261,17 @@ function the_taxonomies($args = array()) { echo $before . join($sep, get_the_taxonomies($post)) . $after; } +/** + * Retrieve all taxonomies associated with a post. + * + * This function can be used within the loop. It will also return an array of + * the taxonomies with links to the taxonomy and name. + * + * @since 2.5.0 + * + * @param int $post Optional. Post ID or will use Global Post ID (in loop). + * @return array + */ function get_the_taxonomies($post = 0) { if ( is_int($post) ) $post =& get_post($post); @@ -2019,7 +2301,7 @@ function get_the_taxonomies($post = 0) { $links = array(); foreach ( $terms as $term ) - $links[] = "$term->name"; + $links[] = "$term->name"; if ( $links ) $taxonomies[$taxonomy] = wp_sprintf($t['template'], $t['label'], $links, $terms); @@ -2027,10 +2309,69 @@ function get_the_taxonomies($post = 0) { 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 + * @return array + */ function get_post_taxonomies($post = 0) { $post =& get_post($post); return get_object_taxonomies($post); } +/** + * Determine if the given object is associated with any of the given terms. + * + * The given terms are checked against the object's terms' term_ids, names and slugs. + * Terms given as integers will only be checked against the object's terms' term_ids. + * If no terms are given, determines if object is associated with any terms in the given taxonomy. + * + * @since 2.7.0 + * @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 + * @return bool|WP_Error. WP_Error on input error. + */ +function is_object_in_term( $object_id, $taxonomy, $terms = null ) { + if ( !$object_id = (int) $object_id ) + return new WP_Error( 'invalid_object', __( 'Invalid object ID' ) ); + + $object_terms = get_object_term_cache( $object_id, $taxonomy ); + if ( empty( $object_terms ) ) + $object_terms = wp_get_object_terms( $object_id, $taxonomy ); + + if ( is_wp_error( $object_terms ) ) + return $object_terms; + if ( empty( $object_terms ) ) + return false; + if ( empty( $terms ) ) + return ( !empty( $object_terms ) ); + + $terms = (array) $terms; + + if ( $ints = array_filter( $terms, 'is_int' ) ) + $strs = array_diff( $terms, $ints ); + else + $strs =& $terms; + + foreach ( $object_terms as $object_term ) { + if ( $ints && in_array( $object_term->term_id, $ints ) ) return true; // If int, check against term_id + if ( $strs ) { + if ( in_array( $object_term->term_id, $strs ) ) return true; + if ( in_array( $object_term->name, $strs ) ) return true; + if ( in_array( $object_term->slug, $strs ) ) return true; + } + } + + return false; +} + ?>