<?php
+/**
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ */
//
// Taxonomy Registration
//
/**
- * @global array $wp_taxonomies Fill me out please
+ * Default Taxonomy Objects
+ * @since 2.3
+ * @global array $wp_taxonomies
*/
$wp_taxonomies = array();
$wp_taxonomies['category'] = (object) array('name' => 'category', 'object_type' => 'post', 'hierarchical' => true, 'update_count_callback' => '_update_post_term_count');
* It appears that this function can be used to find all of the names inside of
* $wp_taxonomies global variable.
*
- * @example
- * <?php $taxonomies = get_object_taxonomies('post'); ?>
- * Should result in <pre>Array(
- * 'category',
- * 'post_tag'
- * )</pre>
+ * <code><?php $taxonomies = get_object_taxonomies('post'); ?></code>
+ * Should result in <code>Array('category', 'post_tag')</code>
*
- * @package Taxonomy
- * @global array $wp_taxonomies
- * @param string $object_type Name of the type of taxonomy object
- * @return array The names of all within the object_type.
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wp_taxonomies
*
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @param array|string|object $object Name of the type of taxonomy object, or an object (row from posts)
+ * @return array The names of all taxonomy of $object_type.
*/
-function get_object_taxonomies($object_type) {
+function get_object_taxonomies($object) {
global $wp_taxonomies;
+ if ( is_object($object) ) {
+ if ( $object->post_type == 'attachment' )
+ return get_attachment_taxonomies($object);
+ $object = $object->post_type;
+ }
+
+ $object = (array) $object;
+
$taxonomies = array();
foreach ( $wp_taxonomies as $taxonomy ) {
- if ( $object_type == $taxonomy->object_type )
+ if ( array_intersect($object, (array) $taxonomy->object_type) )
$taxonomies[] = $taxonomy->name;
}
}
/**
- * get_taxonomy() - Returns the "taxonomy" object of $taxonomy.
+ * get_taxonomy() - Returns 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 Taxonomy
- * @global array $wp_taxonomies
- * @param string $taxonomy Name of taxonomy object to return
- * @return object|bool The Taxonomy Object or false if taxonomy doesn't exist
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
*
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @uses $wp_taxonomies
+ * @uses is_taxonomy() 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;
/**
* is_taxonomy() - Checks that the taxonomy name exists
*
- * @package Taxonomy
- * @global array $wp_taxonomies
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wp_taxonomies
+ *
* @param string $taxonomy Name of taxonomy object
* @return bool Whether the taxonomy exists or not.
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
*/
function is_taxonomy( $taxonomy ) {
global $wp_taxonomies;
* 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.
+ * A false return value might also mean that the taxonomy does not exist.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses is_taxonomy() Checks whether taxonomy exists
+ * @uses get_taxonomy() Used to get the taxonomy object
*
- * @package Taxonomy
- * @global array $wp_taxonomies
* @param string $taxonomy Name of taxonomy object
* @return bool Whether the taxonomy is hierarchical
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
*/
function is_taxonomy_hierarchical($taxonomy) {
if ( ! is_taxonomy($taxonomy) )
}
/**
- * register_taxonomy() - Create or modify a taxonomy object.
+ * register_taxonomy() - 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.
*
- * The function keeps a default set, allowing for the $args to be optional but allow the other
- * functions to still work. It is possible to overwrite the default set, which contains two
- * keys: hierarchical and update_count_callback.
+ * Nothing is returned, so expect error maybe or use is_taxonomy() to check whether taxonomy exists.
*
- * hierarachical has some defined purpose at other parts of the API and is a boolean value.
+ * 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
*
- * update_count_callback works much like a hook, in that it will be called (or something from
- * somewhere).
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wp_taxonomies Inserts new taxonomy object into the list
+ * @uses $wp_rewrite Adds rewrite tags and permastructs
+ * @uses $wp Adds query vars
*
- * @package Taxonomy
- * @global array $wp_taxonomies
* @param string $taxonomy Name of taxonomy object
- * @param string $object_type Name of the object type for the taxonomy object.
+ * @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.
- * @return null Nothing is returned, so expect error maybe or use is_taxonomy() to check.
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
*/
function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
- global $wp_taxonomies;
+ global $wp_taxonomies, $wp_rewrite, $wp;
- $defaults = array('hierarchical' => false, 'update_count_callback' => '');
+ $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']) )
+ $args['query_var'] = $taxonomy;
+ $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%");
+ }
+
$args['name'] = $taxonomy;
$args['object_type'] = $object_type;
$wp_taxonomies[$taxonomy] = (object) $args;
* functions or using the database by using $args with either ASC or DESC array. The value should
* be in the key named 'order'.
*
- * @package Taxonomy
- * @subpackage Term
- * @global object $wpdb Database Query
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @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 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 object WP_Error - A PHP 4 compatible Exception class prototype
- * @return array Empty array if there are no $object_ids
- * @return array Array of $object_ids
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @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() ) {
global $wpdb;
$args = wp_parse_args( $args, $defaults );
extract($args, EXTR_SKIP);
+ $order = ( 'desc' == strtolower($order) ) ? 'DESC' : 'ASC';
+
$terms = array_map('intval', $terms);
$taxonomies = "'" . implode("', '", $taxonomies) . "'";
}
/**
- * get_term() -
+ * get_term() - 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
+ * 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.
*
- * @package Taxonomy
- * @subpackage Term
- * @global object $wpdb Database Query
- * @param int|object $term
- * @param string $taxonomy
- * @param string $output Either OBJECT, ARRAY_A, or ARRAY_N
- * @return mixed Term Row from database
+ * 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.
*
- * @internal
- * This won't appear but just a note to say that this is all conjecture and parts or whole
- * might be inaccurate or wrong.
+ * '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
+ *
+ * @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 int|object $term If integer, will get from database. If object will apply filters and return $term.
+ * @param string $taxonomy Taxonomy name that $term is part of.
+ * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @param string $filter Optional, default is raw or no WordPress defined filter will applied.
+ * @return mixed|null|WP_Error Term Row from database. Will return null if $term is empty. If taxonomy does not
+ * exist then WP_Error will be returned.
*/
function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
global $wpdb;
} else {
$term = (int) $term;
if ( ! $_term = wp_cache_get($term, $taxonomy) ) {
- $_term = $wpdb->get_row("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 = '$taxonomy' AND t.term_id = '$term' LIMIT 1");
+ $_term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND t.term_id = %s LIMIT 1", $taxonomy, $term) );
wp_cache_add($term, $_term, $taxonomy);
}
}
-
- /**
- * @internal
- * Filter tag is basically: filter 'type' 'hook_name' 'description'
- *
- * Takes two parameters the term Object and the taxonomy name. Must return term object.
- * @filter object get_term Used in @see get_term() as a catch-all filter for every $term
- */
+
$_term = apply_filters('get_term', $_term, $taxonomy);
- /**
- * @internal
- * Filter tag is basically: filter 'type' 'hook_name' 'description'
- *
- * 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.
- * @filter object get_$taxonomy Used in @see get_term() as specific filter for each $taxonomy.
- */
$_term = apply_filters("get_$taxonomy", $_term, $taxonomy);
$_term = sanitize_term($_term, $taxonomy, $filter);
}
/**
- * get_term_by() -
+ * get_term_by() - 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.
*
+ * The default $field is 'id', therefore it is possible to also use null for field, but not
+ * recommended that you do so.
*
- * @package Taxonomy
- * @subpackage Term
- * @global object $wpdb Database Query
- * @param string $field
- * @param string $value
- * @param string $taxonomy
- * @param string $output Either OBJECT, ARRAY_A, or ARRAY_N
- * @return mixed Term Row from database
+ * 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
+ *
+ * @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.
*
- * @internal
- * This won't appear but just a note to say that this is all conjecture and parts or whole
- * might be inaccurate or wrong.
+ * @param string $field Either 'slug', 'name', or 'id'
+ * @param string|int $value Search for this term value
+ * @param string $taxonomy Taxonomy Name
+ * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @param string $filter Optional, default is raw or no WordPress defined filter will applied.
+ * @return mixed Term Row from database. Will return false if $taxonomy does not exist or $term was not found.
*/
function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw') {
global $wpdb;
$value = (int) $value;
}
- $term = $wpdb->get_row("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 = '$taxonomy' AND $field = '$value' LIMIT 1");
+ $term = $wpdb->get_row( $wpdb->prepare( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy = %s AND $field = %s LIMIT 1", $taxonomy, $value) );
if ( !$term )
return false;
* get_term_children() - Merge all term children into a single array.
*
* This recursive function will merge all of the children of $term into
- * the same array.
+ * the same array. Only useful for taxonomies which are hierarchical.
+ *
+ * Will return an empty array if $term does not exist in $taxonomy.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wpdb
+ * @uses _get_term_hierarchy()
+ * @uses get_term_children() Used to get the children of both $taxonomy and the parent $term
*
- * Only useful for taxonomies which are hierarchical.
- *
- * @package Taxonomy
- * @subpackage Term
- * @global object $wpdb Database Query
* @param string $term Name of Term to get children
* @param string $taxonomy Taxonomy Name
- * @return array List of Term Objects
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @return array|WP_Error List of Term Objects. WP_Error returned if $taxonomy does not exist
*/
function get_term_children( $term, $taxonomy ) {
if ( ! is_taxonomy($taxonomy) )
/**
* get_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
+ * contextual reasons and for simplicity of usage. See sanitize_term_field() for
* more information.
*
- * @package Taxonomy
- * @subpackage Term
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
+ *
* @param string $field Term field to fetch
* @param int $term Term ID
* @param string $taxonomy Taxonomy Name
- * @param string $context ??
- * @return mixed @see sanitize_term_field()
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @param string $context Optional, default is display. Look at sanitize_term_field() for available options.
+ * @return mixed Will return an empty string if $term is not an object or if $field is not set in $term.
*/
function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
$term = (int) $term;
/**
* get_term_to_edit() - Sanitizes Term for editing
*
- * Return value is @see sanitize_term() and usage is for sanitizing the term
+ * Return value is sanitize_term() and usage is for sanitizing the term
* for editing. Function is for contextual and simplicity.
- *
- * @package Taxonomy
- * @subpackage Term
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses sanitize_term() Passes the return value on success
+ *
* @param int|object $id Term ID or Object
* @param string $taxonomy Taxonomy Name
- * @return mixed @see sanitize_term()
- *
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * @return mixed|null|WP_Error Will return empty string if $term is not an object.
*/
function get_term_to_edit( $id, $taxonomy ) {
$term = get_term( $id, $taxonomy );
}
/**
- * get_terms() -
+ * get_terms() - Retrieve the terms in taxonomy or list of taxonomies.
*
- *
- *
- * @package Taxonomy
- * @subpackage Term
- * @param string|array Taxonomy name or list of Taxonomy names
- * @param string|array $args ??
- * @return array List of Term Objects and their children.
+ * 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.
*
- * @internal
- * This is all conjecture and might be partially or completely inaccurate.
+ * The 'list_terms_exclusions' filter passes the compiled exclusions along with the $args.
+ *
+ * The list that $args can contain, which will overwrite the defaults.
+ * orderby - Default is 'name'. Can be name, count, or nothing (will use term_id).
+ * order - Default is ASC. Can use DESC.
+ * hide_empty - Default is true. Will not return empty $terms.
+ * fields - Default is all.
+ * slug - Any terms that has this value. Default is empty string.
+ * hierarchical - Whether to return hierarchical taxonomy. Default is true.
+ * name__like - Default is empty string.
+ *
+ * The argument 'pad_counts' will count all of the children along with the $terms.
+ *
+ * The 'get' argument allows for overwriting 'hide_empty' and 'child_of', which can be done by
+ * setting the value to 'all', instead of its default empty string value.
+ *
+ * The 'child_of' argument will be used if you use multiple taxonomy or the first $taxonomy
+ * isn't hierarchical or 'parent' isn't used. The default is 0, which will be translated to
+ * a false value. If 'child_of' is set, then 'child_of' value will be tested against
+ * $taxonomy to see if 'child_of' is contained within. Will return an empty array if test
+ * fails.
+ *
+ * If 'parent' is set, then it will be used to test against the first taxonomy. Much like
+ * 'child_of'. Will return an empty array if the test fails.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wpdb
+ * @uses wp_parse_args() Merges the defaults with those defined by $args and allows for strings.
+ *
+ *
+ * @param string|array Taxonomy name or list of Taxonomy names
+ * @param string|array $args The values of what to search for when returning terms
+ * @return array|WP_Error List of Term Objects and their children. Will return WP_Error, if any of $taxonomies do not exist.
*/
function &get_terms($taxonomies, $args = '') {
global $wpdb;
+ $empty_array = array();
$single_taxonomy = false;
if ( !is_array($taxonomies) ) {
'hide_empty' => true, 'exclude' => '', 'include' => '',
'number' => '', 'fields' => 'all', 'slug' => '', 'parent' => '',
'hierarchical' => true, 'child_of' => 0, 'get' => '', 'name__like' => '',
- 'pad_counts' => false);
+ 'pad_counts' => false, 'offset' => '', 'search' => '');
$args = wp_parse_args( $args, $defaults );
- $args['number'] = (int) $args['number'];
+ $args['number'] = absint( $args['number'] );
+ $args['offset'] = absint( $args['offset'] );
if ( !$single_taxonomy || !is_taxonomy_hierarchical($taxonomies[0]) ||
'' != $args['parent'] ) {
$args['child_of'] = 0;
if ( $child_of ) {
$hierarchy = _get_term_hierarchy($taxonomies[0]);
if ( !isset($hierarchy[$child_of]) )
- return array();
+ return $empty_array;
}
if ( $parent ) {
$hierarchy = _get_term_hierarchy($taxonomies[0]);
if ( !isset($hierarchy[$parent]) )
- return array();
+ return $empty_array;
}
- $key = md5( serialize( $args ) . serialize( $taxonomies ) );
+ // $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);
$orderby = 'tt.count';
else if ( 'name' == $orderby )
$orderby = 't.name';
+ else if ( 'slug' == $orderby )
+ $orderby = 't.slug';
+ else if ( 'term_group' == $orderby )
+ $orderby = 't.term_group';
else
$orderby = 't.term_id';
if ( $hide_empty && !$hierarchical )
$where .= ' AND tt.count > 0';
- if ( !empty($number) )
- $number = 'LIMIT ' . $number;
- else
+ if ( !empty($number) ) {
+ if( $offset )
+ $number = 'LIMIT ' . $offset . ',' . $number;
+ else
+ $number = 'LIMIT ' . $number;
+
+ } else
$number = '';
+ if ( !empty($search) ) {
+ $search = like_escape($search);
+ $where .= " AND (t.name LIKE '%$search%')";
+ }
+
+ $select_this = '';
if ( 'all' == $fields )
$select_this = 't.*, tt.*';
else if ( 'ids' == $fields )
$select_this = 't.term_id';
else if ( 'names' == $fields )
- $select_this == 't.name';
+ $select_this = 't.name';
$query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE tt.taxonomy IN ($in_taxonomies) $where ORDER BY $orderby $order $number";
if ( 'all' == $fields ) {
$terms = $wpdb->get_results($query);
update_term_cache($terms);
- } else if ( 'ids' == $fields ) {
+ } else if ( ('ids' == $fields) || ('names' == $fields) ) {
$terms = $wpdb->get_col($query);
}
- if ( empty($terms) )
- return array();
+ if ( empty($terms) ) {
+ $cache[ $key ] = array();
+ wp_cache_set( 'get_terms', $cache, 'terms' );
+ return apply_filters('get_terms', array(), $taxonomies, $args);
+ }
if ( $child_of || $hierarchical ) {
$children = _get_term_hierarchy($taxonomies[0]);
*
* Returns the index of a defined term, or 0 (false) if the term doesn't exist.
*
- * @global $wpdb Database Object
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wpdb
+ *
* @param int|string $term The term to check
* @param string $taxonomy The taxonomy name to use
* @return mixed Get the term id or Term Object, if exists.
if ( is_int($term) ) {
if ( 0 == $term )
return 0;
- $where = "t.term_id = '$term'";
+ $where = $wpdb->prepare( "t.term_id = %d", $term );
} else {
- if ( ! $term = sanitize_title($term) )
+ if ( '' === $term = sanitize_title($term) )
return 0;
- $where = "t.slug = '$term'";
+ $where = $wpdb->prepare( "t.slug = %s", $term );
}
- $term_id = $wpdb->get_var("SELECT term_id FROM $wpdb->terms as t WHERE $where");
-
- if ( empty($taxonomy) || empty($term_id) )
- return $term_id;
+ 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);
- 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);
+ return $wpdb->get_var("SELECT term_id FROM $wpdb->terms as t WHERE $where");
}
/**
* sanitize_term() - Sanitize Term all fields
*
- * Relys on @see sanitize_term_field() to sanitize the term. The difference
+ * Relys on sanitize_term_field() to sanitize the term. The difference
* is that this function will sanitize <strong>all</strong> fields. The context
- * is based on @see sanitize_term_field().
+ * 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
+ *
+ * @uses sanitize_term_field Used to sanitize all fields in a term
+ *
* @param array|object $term The term to check
* @param string $taxonomy The taxonomy name to use
- * @param string $context Default is display
+ * @param string $context Default is 'display'.
* @return array|object Term with all fields sanitized
*/
function sanitize_term($term, $taxonomy, $context = 'display') {
}
/**
- * sanitize_term_field() -
+ * sanitize_term_field() - 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.
+ *
+ * If no context or an unsupported context is given, then default filters will be applied.
*
+ * There are enough filters for each context to support a custom filtering without creating
+ * your own filter function. Simply create a function that hooks into the filter you need.
*
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wpdb
*
- * @global object $wpdb Database Object
* @param string $field Term field to sanitize
* @param string $value Search for this term value
* @param int $term_id Term ID
* @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 )
+ if ( 'parent' == $field || 'term_id' == $field || 'count' == $field || 'term_group' == $field ) {
$value = (int) $value;
+ if ( $value < 0 )
+ $value = 0;
+ }
+
+ if ( 'raw' == $context )
+ return $value;
if ( 'edit' == $context ) {
$value = apply_filters("edit_term_$field", $value, $term_id, $taxonomy);
// Back compat filters
if ( 'slug' == $field )
$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);
+ $value = apply_filters("${taxonomy}_${field}_rss", $value);
} else {
// Use display filters by default.
$value = apply_filters("term_$field", $value, $term_id, $taxonomy, $context);
/**
* wp_count_terms() - Count how many terms are in Taxonomy
*
- * Default $args is 'ignore_empty' which can be @example 'ignore_empty=true' or
- * @example array('ignore_empty' => true); See @see wp_parse_args() for more
- * information on parsing $args.
+ * Default $args is 'ignore_empty' which can be <code>'ignore_empty=true'</code> or
+ * <code>array('ignore_empty' => true);</code>.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses $wpdb
+ * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array.
*
- * @global object $wpdb Database Object
* @param string $taxonomy Taxonomy name
* @param array|string $args Overwrite defaults
* @return int How many terms are in $taxonomy
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");
}
/**
- * wp_delete_object_term_relationships() -
+ * wp_delete_object_term_relationships() - 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.
*
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wpdb
*
- * @global object $wpdb Database Object
- * @param int $object_id ??
+ * @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.
*/
function wp_delete_object_term_relationships( $object_id, $taxonomies ) {
}
/**
- * Removes a term from the database.
+ * wp_delete_term() - 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.
+ *
+ * The $args 'default' will only override the terms found, if there is only one
+ * term found. Any other and the found terms are used.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @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
+ * @param array|string $args Optional. Change 'default' term id and override found term ids.
+ * @return bool|WP_Error Returns false if not term; true if completes delete action.
*/
function wp_delete_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
if ( ! $ids = is_term($term, $taxonomy) )
return false;
+ if ( is_wp_error( $ids ) )
+ return $ids;
+
$tt_id = $ids['term_taxonomy_id'];
$defaults = array();
return $term_obj;
$parent = $term_obj->parent;
- $wpdb->query("UPDATE $wpdb->term_taxonomy SET parent = '$parent' WHERE parent = '$term_obj->term_id' AND taxonomy = '$taxonomy'");
+ $wpdb->update( $wpdb->term_taxonomy, compact( 'parent' ), array( 'parent' => $term_obj->term_id) + compact( 'taxonomy' ) );
}
- $objects = $wpdb->get_col("SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = '$tt_id'");
+ $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');
wp_set_object_terms($object, $terms, $taxonomy);
}
- $wpdb->query("DELETE FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = '$tt_id'");
+ $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_taxonomy WHERE term_taxonomy_id = %d", $tt_id ) );
// Delete the term if no taxonomies use it.
- if ( !$wpdb->get_var("SELECT COUNT(*) FROM $wpdb->term_taxonomy WHERE term_id = '$term'") )
- $wpdb->query("DELETE FROM $wpdb->terms WHERE term_id = '$term'");
+ 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) );
clean_term_cache($term, $taxonomy);
+ do_action('delete_term', $term, $tt_id, $taxonomy);
do_action("delete_$taxonomy", $term, $tt_id);
return true;
}
/**
- * Returns the terms associated with the given object(s), in the supplied taxonomies.
- * @param int|array $object_id The id of the object(s)) to retrieve for.
+ * wp_get_object_terms() - 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 first argument is called, 'orderby' and has the default value of 'name'. The other value that is
+ * supported is 'count'.
+ *
+ * The second argument is called, 'order' and has the default value of 'ASC'. The only other value that
+ * will be acceptable is 'DESC'.
+ *
+ * The final argument supported is called, 'fields' and has the default value of 'all'. There are
+ * multiple other options that can be used instead. Supported values are as follows: 'all', 'ids',
+ * 'names', and finally 'all_with_object_id'.
+ *
+ * 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
+ * @uses $wpdb
+ *
+ * @param int|array $object_id The id of the object(s) to retrieve.
* @param string|array $taxonomies The taxonomies to retrieve terms from.
- * @return array The requested term data.
+ * @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.
*/
function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
global $wpdb;
$defaults = array('orderby' => 'name', 'order' => 'ASC', 'fields' => 'all');
$args = wp_parse_args( $args, $defaults );
+
+ $terms = array();
+ if ( count($taxonomies) > 1 ) {
+ foreach ( $taxonomies as $index => $taxonomy ) {
+ $t = get_taxonomy($taxonomy);
+ if ( is_array($t->args) && $args != array_merge($args, $t->args) ) {
+ 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) )
+ $args = array_merge($args, $t->args);
+ }
+
extract($args, EXTR_SKIP);
if ( 'count' == $orderby )
$orderby = 'tt.count';
else if ( 'name' == $orderby )
$orderby = 't.name';
+ else if ( 'slug' == $orderby )
+ $orderby = 't.slug';
+ else if ( 'term_group' == $orderby )
+ $orderby = 't.term_group';
+ else if ( 'term_order' == $orderby )
+ $orderby = 'tr.term_order';
+ else
+ $orderby = 't.term_id';
$taxonomies = "'" . implode("', '", $taxonomies) . "'";
$object_ids = implode(', ', $object_ids);
+ $select_this = '';
if ( 'all' == $fields )
$select_this = 't.*, tt.*';
else if ( 'ids' == $fields )
$select_this = 't.term_id';
- else if ( 'names' == $fields )
+ else if ( 'names' == $fields )
$select_this = 't.name';
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";
if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
- $terms = $wpdb->get_results($query);
+ $terms = array_merge($terms, $wpdb->get_results($query));
update_term_cache($terms);
} else if ( 'ids' == $fields || 'names' == $fields ) {
- $terms = $wpdb->get_col($query);
+ $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");
}
/**
* wp_insert_term() - Adds a new term to the database. Optionally marks it as an alias of an existing term.
*
- *
+ * Error handling is assigned for the nonexistance of the $taxonomy and $term parameters before inserting.
+ * If both the term id and taxonomy exist previously, then an array will be returned that contains the term
+ * id and the contents of what is returned. The keys of the array are 'term_id' and 'term_taxonomy_id' containing
+ * numeric values.
+ *
+ * It is assumed that the term does not yet exist or the above will apply. The term will be first added to the term
+ * table and then related to the taxonomy if everything is well. If everything is correct, then several actions
+ * will be run prior to a filter and then several actions will be run after the filter is run.
+ *
+ * The arguments decide how the term is handled based on the $args parameter. The following
+ * is a list of the available overrides and the defaults.
+ *
+ * 'alias_of'. There is no default, but if added, expected is the slug that the term will be an alias of.
+ * Expected to be a string.
+ *
+ * 'description'. There is no default. If exists, will be added to the database along with the term. Expected
+ * to be a string.
+ *
+ * 'parent'. Expected to be numeric and default is 0 (zero). Will assign value of 'parent' to the term.
+ *
+ * 'slug'. Expected to be a string. There is no default.
+ *
+ * If 'slug' argument exists then the slug will be checked to see if it is not a valid term. If that check
+ * succeeds (it is not a valid term), then it is added and the term id is given. If it fails, then a check
+ * is made to whether the taxonomy is hierarchical and the parent argument is not empty. If the second check
+ * succeeds, the term will be inserted and the term id will be given.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wpdb
+ *
+ * @uses do_action() Calls 'create_term' hook with the term id and taxonomy id as parameters.
+ * @uses do_action() Calls 'create_$taxonomy' hook with term id and taxonomy id as parameters.
+ * @uses apply_filters() Calls 'term_id_filter' hook with term id and taxonomy id as parameters.
+ * @uses do_action() Calls 'created_term' hook with the term id and taxonomy id as parameters.
+ * @uses do_action() Calls 'created_$taxonomy' hook with term id and taxonomy id as parameters.
*
- * @global $wpdb Database Object
* @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 The Term ID and Term Taxonomy ID
+ * @return array|WP_Error The Term ID and Term Taxonomy ID
*/
function wp_insert_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
$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);
$term_group = 0;
if ( $alias_of ) {
- $alias = $wpdb->fetch_row("SELECT term_id, term_group FROM $wpdb->terms WHERE slug = '$alias_of'");
+ $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $alias_of) );
if ( $alias->term_group ) {
// 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 GROUP BY term_group") + 1;
- $wpdb->query("UPDATE $wpdb->terms SET term_group = $term_group WHERE term_id = $alias->term_id");
+ $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 ) );
}
}
if ( ! $term_id = is_term($slug) ) {
- $wpdb->query("INSERT INTO $wpdb->terms (name, slug, term_group) VALUES ('$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;
} else if ( is_taxonomy_hierarchical($taxonomy) && !empty($parent) ) {
// If the taxonomy supports hierarchy and the term has a parent, make the slug unique
// by incorporating parent slugs.
$slug = wp_unique_term_slug($slug, (object) $args);
- $wpdb->query("INSERT INTO $wpdb->terms (name, slug, term_group) VALUES ('$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;
}
if ( empty($slug) ) {
$slug = sanitize_title($slug, $term_id);
- $wpdb->query("UPDATE $wpdb->terms SET slug = '$slug' WHERE term_id = '$term_id'");
+ $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
}
- $tt_id = $wpdb->get_var("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 = '$taxonomy' AND t.term_id = $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 ) );
if ( !empty($tt_id) )
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
- $wpdb->query("INSERT INTO $wpdb->term_taxonomy (term_id, taxonomy, description, parent, count) VALUES ('$term_id', '$taxonomy', '$description', '$parent', '0')");
+ $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);
}
/**
- * wp_set_object_terms() -
- *
- * 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).
+ * wp_set_object_terms() - 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).
+ *
+ * A relationship means that the term is grouped in or belongs to the taxonomy. A term has no
+ * meaning until it is given context by defining which taxonomy it exists under.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wpdb
*
- * @global $wpdb Database Object
* @param int $object_id The object to relate to.
* @param array|int|string $term The slug or id of the term.
* @param array|string $taxonomy The context in which to relate the term to the object.
* @param bool $append If false will delete difference of terms.
+ * @return array|WP_Error Affected Term IDs
*/
function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) {
global $wpdb;
$term_ids = array();
foreach ($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 ( $wpdb->get_var("SELECT term_taxonomy_id FROM $wpdb->term_relationships WHERE object_id = '$object_id' AND term_taxonomy_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, $id ) ) )
continue;
- $wpdb->query("INSERT INTO $wpdb->term_relationships (object_id, term_taxonomy_id) VALUES ('$object_id', '$id')");
+ $wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $id ) );
}
wp_update_term_count($tt_ids, $taxonomy);
}
}
+ $t = get_taxonomy($taxonomy);
+ 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);
+ 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)");
+ }
+
return $tt_ids;
}
+/**
+ * wp_unique_term_slug() - 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 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.
+ *
+ * The only purpose for $term is for appending a parent, if one exists.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wpdb
+ *
+ * @param string $slug The string that will be tried for a unique slug
+ * @param object $term The term object that the $slug will belong too
+ * @return string Will return a true unique slug.
+ */
function wp_unique_term_slug($slug, $term) {
global $wpdb;
}
// If we didn't get a unique slug, try appending a number to make it unique.
- if ( $wpdb->get_var("SELECT slug FROM $wpdb->terms WHERE slug = '$slug'") ) {
+ if ( !empty($args['term_id']) )
+ $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s AND term_id != %d", $slug, $args['term_id'] );
+ else
+ $query = $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $slug );
+
+ if ( $wpdb->get_var( $query ) ) {
$num = 2;
do {
$alt_slug = $slug . "-$num";
$num++;
- $slug_check = $wpdb->get_var("SELECT slug FROM $wpdb->terms WHERE slug = '$alt_slug'");
+ $slug_check = $wpdb->get_var( $wpdb->prepare( "SELECT slug FROM $wpdb->terms WHERE slug = %s", $alt_slug ) );
} while ( $slug_check );
$slug = $alt_slug;
}
return $slug;
}
+/**
+ * wp_update_term() - Update term based on arguments provided
+ *
+ * The $args will indiscriminately override all values with the same field name. Care
+ * must be taken to not override important information need to update or update will
+ * fail (or perhaps create a new term, neither would be acceptable).
+ *
+ * Defaults will set 'alias_of', 'description', 'parent', and 'slug' if not defined
+ * in $args already.
+ *
+ * 'alias_of' will create a term group, if it doesn't already exist, and update it for
+ * the $term.
+ *
+ * If the 'slug' argument in $args is missing, then the 'name' in $args will be used.
+ * It should also be noted that if you set 'slug' and it isn't unique then a WP_Error
+ * will be passed back. If you don't pass any slug, then a unique one will be created
+ * for you.
+ *
+ * For what can be overrode in $args, check the term scheme can contain and stay away
+ * from the term keys.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @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 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() ) {
global $wpdb;
$args = sanitize_term($args, $taxonomy, 'db');
extract($args, EXTR_SKIP);
+ // expected_slashed ($name)
+ $name = stripslashes($name);
+ $description = stripslashes($description);
+
$empty_slug = false;
if ( empty($slug) ) {
$empty_slug = true;
}
if ( $alias_of ) {
- $alias = $wpdb->fetch_row("SELECT term_id, term_group FROM $wpdb->terms WHERE slug = '$alias_of'");
+ $alias = $wpdb->get_row( $wpdb->prepare( "SELECT term_id, term_group FROM $wpdb->terms WHERE slug = %s", $alias_of) );
if ( $alias->term_group ) {
// 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 GROUP BY term_group") + 1;
- $wpdb->query("UPDATE $wpdb->terms SET term_group = $term_group WHERE term_id = $alias->term_id");
+ $term_group = $wpdb->get_var("SELECT MAX(term_group) FROM $wpdb->terms") + 1;
+ $wpdb->update( $wpdb->terms, compact('term_group'), array( 'term_id' => $alias->term_id ) );
}
}
// Check for duplicate slug
- $id = $wpdb->get_var("SELECT term_id FROM $wpdb->terms WHERE slug = '$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, reset the slug to something unique.
+ // If an empty slug was passed or the parent changed, reset the slug to something unique.
// Otherwise, bail.
- if ( $empty_slug )
+ 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));
}
- $wpdb->query("UPDATE $wpdb->terms SET name = '$name', slug = '$slug', term_group = '$term_group' WHERE term_id = '$term_id'");
+ $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
if ( empty($slug) ) {
$slug = sanitize_title($name, $term_id);
- $wpdb->query("UPDATE $wpdb->terms SET slug = '$slug' WHERE term_id = '$term_id'");
+ $wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
}
- $tt_id = $wpdb->get_var("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 = '$taxonomy' AND t.term_id = $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) );
- $wpdb->query("UPDATE $wpdb->term_taxonomy SET term_id = '$term_id', taxonomy = '$taxonomy', description = '$description', parent = '$parent' WHERE term_taxonomy_id = '$tt_id'");
+ $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);
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
}
-function wp_update_term_count( $terms, $taxonomy ) {
- global $wpdb;
+// 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) {
+ static $_defer = false;
+
+ if ( is_bool($defer) ) {
+ $_defer = $defer;
+ // flush any deferred counts
+ if ( !$defer )
+ wp_update_term_count( NULL, NULL, true );
+ }
+
+ return $_defer;
+}
+
+/**
+ * wp_update_term_count() - Updates the amount of terms in taxonomy
+ *
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @uses $wpdb
+ *
+ * @param int|array $terms The 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.
+ */
+function wp_update_term_count( $terms, $taxonomy, $do_deferred=false ) {
+ static $_deferred = array();
+
+ if ( $do_deferred ) {
+ foreach ( array_keys($_deferred) as $tax ) {
+ wp_update_term_count_now( $_deferred[$tax], $tax );
+ unset( $_deferred[$tax] );
+ }
+ }
if ( empty($terms) )
return false;
if ( !is_array($terms) )
$terms = array($terms);
+ if ( wp_defer_term_counting() ) {
+ if ( !isset($_deferred[$taxonomy]) )
+ $_deferred[$taxonomy] = array();
+ $_deferred[$taxonomy] = array_unique( array_merge($_deferred[$taxonomy], $terms) );
+ return true;
+ }
+
+ return wp_update_term_count_now( $terms, $taxonomy );
+}
+
+function wp_update_term_count_now( $terms, $taxonomy ) {
+ global $wpdb;
+
$terms = array_map('intval', $terms);
$taxonomy = get_taxonomy($taxonomy);
} else {
// Default count updater
foreach ($terms as $term) {
- $count = $wpdb->get_var("SELECT COUNT(*) FROM $wpdb->term_relationships WHERE term_taxonomy_id = '$term'");
- $wpdb->query("UPDATE $wpdb->term_taxonomy SET count = '$count' WHERE term_taxonomy_id = '$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 ) );
}
}
// Cache
//
+/**
+ * clean_object_term_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.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @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
+ */
function clean_object_term_cache($object_ids, $object_type) {
- global $object_term_cache, $blog_id;
-
if ( !is_array($object_ids) )
$object_ids = array($object_ids);
- $taxonomies = get_object_taxonomies($object_type);
+ foreach ( $object_ids as $id )
+ foreach ( get_object_taxonomies($object_type) as $taxonomy )
+ wp_cache_delete($id, "{$taxonomy}_relationships");
- foreach ( $object_ids as $id ) {
- foreach ( $taxonomies as $taxonomy ) {
- if ( isset($object_term_cache[$blog_id][$id][$taxonomy]) )
- unset($object_term_cache[$blog_id][$id][$taxonomy]);
- }
- }
+ do_action('clean_object_term_cache', $object_ids, $object_type);
}
+/**
+ * clean_term_cache() - Will remove all of the term ids from the cache
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ * @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.
+ */
function clean_term_cache($ids, $taxonomy = '') {
global $wpdb;
}
wp_cache_delete('get_terms', 'terms');
+
+ do_action('clean_term_cache', $ids, $taxonomy);
}
+/**
+ * get_object_term_cache() - Retrieves the taxonomy relationship to the term object id.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @uses wp_cache_get() Retrieves taxonomy relationship from cache
+ *
+ * @param int|array $id Term object ID
+ * @param string $taxonomy Taxonomy Name
+ * @return bool|array Empty array if $terms found, but not $taxonomy. False if nothing is in cache for $taxonomy and $id.
+ */
function &get_object_term_cache($id, $taxonomy) {
- global $object_term_cache, $blog_id;
-
- if ( isset($object_term_cache[$blog_id][$id][$taxonomy]) )
- return $object_term_cache[$blog_id][$id][$taxonomy];
-
- if ( isset($object_term_cache[$blog_id][$id]) )
- return array();
-
- return false;
+ $cache = wp_cache_get($id, "{$taxonomy}_relationships");
+ return $cache;
}
+/**
+ * update_object_term_cache() - 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.
+ *
+ * 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
+ * @uses wp_get_object_terms() Used to get terms from the database to update
+ *
+ * @param string|array $object_ids Single or list of term object ID(s)
+ * @param array|string $object_type The taxonomy object type
+ * @return null|bool Null value is given with empty $object_ids. False if
+ */
function update_object_term_cache($object_ids, $object_type) {
- global $wpdb, $object_term_cache, $blog_id;
-
if ( empty($object_ids) )
return;
if ( !is_array($object_ids) )
$object_ids = explode(',', $object_ids);
- $count = count( $object_ids);
- for ( $i = 0; $i < $count; $i++ ) {
- $object_id = (int) $object_ids[ $i ];
- if ( isset( $object_term_cache[$blog_id][$object_id] ) ) {
- unset( $object_ids[ $i ] );
- continue;
+ $object_ids = array_map('intval', $object_ids);
+
+ $taxonomies = get_object_taxonomies($object_type);
+
+ $ids = array();
+ foreach ( (array) $object_ids as $id ) {
+ foreach ( $taxonomies as $taxonomy ) {
+ if ( false === wp_cache_get($id, "{$taxonomy}_relationships") ) {
+ $ids[] = $id;
+ break;
+ }
}
}
- if ( count( $object_ids ) == 0 )
- return;
+ if ( empty( $ids ) )
+ return false;
- $terms = wp_get_object_terms($object_ids, get_object_taxonomies($object_type), 'fields=all_with_object_id');
+ $terms = wp_get_object_terms($ids, $taxonomies, 'fields=all_with_object_id');
- if ( empty($terms) )
- return;
+ $object_terms = array();
+ foreach ( (array) $terms as $term )
+ $object_terms[$term->object_id][$term->taxonomy][$term->term_id] = $term;
- foreach ( $terms as $term )
- $object_term_cache[$blog_id][$term->object_id][$term->taxonomy][$term->term_id] = $term;
+ foreach ( $ids as $id ) {
+ foreach ( $taxonomies as $taxonomy ) {
+ if ( ! isset($object_terms[$id][$taxonomy]) ) {
+ if ( !isset($object_terms[$id]) )
+ $object_terms[$id] = array();
+ $object_terms[$id][$taxonomy] = array();
+ }
+ }
+ }
- foreach ( $object_ids as $id ) {
- if ( ! isset($object_term_cache[$blog_id][$id]) )
- $object_term_cache[$blog_id][$id] = array();
+ foreach ( $object_terms as $id => $value ) {
+ foreach ( $value as $taxonomy => $terms ) {
+ wp_cache_set($id, $terms, "{$taxonomy}_relationships");
+ }
}
}
+/**
+ * update_term_cache() - Updates Terms to Taxonomy in cache.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @since 2.3
+ *
+ * @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 ) {
$term_taxonomy = $taxonomy;
// Private
//
+/**
+ * _get_term_hierarchy() - Retrieves children of taxonomy
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @access private
+ * @since 2.3
+ *
+ * @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.
+ */
function _get_term_hierarchy($taxonomy) {
if ( !is_taxonomy_hierarchical($taxonomy) )
return array();
return $children;
}
+/**
+ * _get_term_children() - Get array of child terms
+ *
+ * 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.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @access private
+ * @since 2.3
+ *
+ * @param int $term_id Look for this Term ID in $terms
+ * @param array $terms List of Term IDs
+ * @param string $taxonomy Term Context
+ * @return array Empty if $terms is empty else returns full list of child terms.
+ */
function &_get_term_children($term_id, $terms, $taxonomy) {
+ $empty_array = array();
if ( empty($terms) )
- return array();
+ return $empty_array;
$term_list = array();
$has_children = _get_term_hierarchy($taxonomy);
if ( ( 0 != $term_id ) && ! isset($has_children[$term_id]) )
- return array();
+ return $empty_array;
foreach ( $terms as $term ) {
$use_id = false;
return $term_list;
}
-// Recalculates term counts by including items from child terms
-// Assumes all relevant children are already in the $terms argument
+/**
+ * _pad_term_counts() - 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
+ * @uses $wpdb
+ *
+ * @param array $terms List of Term IDs
+ * @param string $taxonomy Term Context
+ * @return null Will break from function if conditions are not met.
+ */
function _pad_term_counts(&$terms, $taxonomy) {
global $wpdb;
}
}
- // Transfer the touched cells
+ // Transfer the touched cells
foreach ( (array) $term_items as $id => $items )
if ( isset($terms_by_id[$id]) )
$terms_by_id[$id]->count = count($items);
// Default callbacks
//
+/**
+ * _update_post_term_count() - Will update term count based on posts
+ *
+ * Private function for the default callback for post_tag and category taxonomies.
+ *
+ * @package WordPress
+ * @subpackage Taxonomy
+ * @access private
+ * @since 2.3
+ * @uses $wpdb
+ *
+ * @param array $terms List of Term IDs
+ */
function _update_post_term_count( $terms ) {
global $wpdb;
foreach ( $terms as $term ) {
- $count = $wpdb->get_var("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 = '$term'");
- $wpdb->query("UPDATE $wpdb->term_taxonomy SET count = '$count' WHERE term_taxonomy_id = '$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 ) );
+ $wpdb->update( $wpdb->term_taxonomy, compact( 'count' ), array( 'term_taxonomy_id' => $term ) );
+ }
+}
+
+/**
+ * get_term_link() - Generates a permalink for a taxonomy term archive
+ *
+ * @param object|int|string $term
+ * @param string $taxonomy
+ * @return string HTML link to taxonomy term archive
+ */
+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);
+ } else {
+ $term = &get_term_by('slug', $term, $taxonomy);
+ }
+ }
+ if ( is_wp_error( $term ) )
+ return $term;
+
+ $slug = $term->slug;
+
+ if ( empty($termlink) ) {
+ $file = get_option('home') . '/';
+ $t = get_taxonomy($taxonomy);
+ if ( $t->query_var )
+ $termlink = "$file?$t->query_var=$slug";
+ else
+ $termlink = "$file?taxonomy=$taxonomy&term=$slug";
+ } else {
+ $termlink = str_replace("%$taxonomy%", $slug, $termlink);
+ $termlink = get_option('home') . user_trailingslashit($termlink, 'category');
+ }
+ return apply_filters('term_link', $termlink, $term, $taxonomy);
+}
+
+function the_taxonomies($args = array()) {
+ $defaults = array(
+ 'post' => 0,
+ 'before' => '',
+ 'sep' => ' ',
+ 'after' => '',
+ );
+
+ $r = wp_parse_args( $args, $defaults );
+ extract( $r, EXTR_SKIP );
+
+ echo $before . join($sep, get_the_taxonomies($post)) . $after;
+}
+
+function get_the_taxonomies($post = 0) {
+ if ( is_int($post) )
+ $post =& get_post($post);
+ elseif ( !is_object($post) )
+ $post =& $GLOBALS['post'];
+
+ $taxonomies = array();
+
+ 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']) )
+ $t['label'] = $taxonomy;
+ 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']);
+
+ $links = array();
+
+ foreach ( $terms as $term )
+ $links[] = "<a href='" . attribute_escape(get_term_link($term, $taxonomy)) . "'>$term->name</a>";
+
+ if ( $links )
+ $taxonomies[$taxonomy] = wp_sprintf($t['template'], $t['label'], $links, $terms);
}
+ return $taxonomies;
+}
+
+function get_post_taxonomies($post = 0) {
+ $post =& get_post($post);
+
+ return get_object_taxonomies($post);
}
?>
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff