sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

taxonomy phpdoc updates from darkdragon. see #4742

Browse Source 
git-svn-id: https://develop.svn.wordpress.org/trunk@6282 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Ryan Boren 2007-10-21 17:18:24 +00:00
parent 8878de4cf3
commit 5ac19bfa84
1 changed files with 242 additions and 190 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

414
wp-includes/taxonomy.php
View File

@ -10,7 +10,9 @@
//
/**
* @global array $wp_taxonomies Default Taxonomy Objects
* 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');
@ -23,22 +25,17 @@ $wp_taxonomies['link_category'] = (object) array('name' => 'link_category', 'obj
* 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 WordPress
* @subpackage Taxonomy
* @since 2.3
*
* @uses $wp_taxonomies
*
* @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.
*
* @internal
* This is all conjecture and might be partially or completely inaccurate.
* @return array The names of all taxonomy of $object_type.
*/
function get_object_taxonomies($object_type) {
global $wp_taxonomies;
@ -53,20 +50,20 @@ function get_object_taxonomies($object_type) {
}
/**
* 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 WordPress
* @subpackage Taxonomy
* @since 2.3
*
* @uses $wp_taxonomies
* @uses is_taxonomy() Checks whether taxonomy exists
*
* @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
*
* @internal
* This is all conjecture and might be partially or completely inaccurate.
* @return object|bool The Taxonomy Object or false if $taxonomy doesn't exist
*/
function get_taxonomy( $taxonomy ) {
global $wp_taxonomies;
@ -82,13 +79,12 @@ function get_taxonomy( $taxonomy ) {
*
* @package WordPress
* @subpackage Taxonomy
* @since 2.3
*
* @uses $wp_taxonomies
*
* @global array $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;
@ -106,13 +102,13 @@ function is_taxonomy( $taxonomy ) {
*
* @package WordPress
* @subpackage Taxonomy
* @since 2.3
*
* @uses is_taxonomy() Checks whether taxonomy exists
* @uses get_taxonomy() Used to get the taxonomy object
*
* @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) )
@ -133,22 +129,20 @@ function is_taxonomy_hierarchical($taxonomy) {
* functions to still work. It is possible to overwrite the default set, which contains two
* keys: hierarchical and update_count_callback.
*
* hierarachical has some defined purpose at other parts of the API and is a boolean value.
* Nothing is returned, so expect error maybe or use is_taxonomy() to check whether taxonomy exists.
*
* update_count_callback works much like a hook, in that it will be called (or something from
* somewhere).
* 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.
*
* @package WordPress
* @subpackage Taxonomy
* @since 2.3
* @uses $wp_taxonomies Inserts new taxonomy object into the list
*
* @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 $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;
@ -181,18 +175,16 @@ function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
*
* @uses $wpdb
* @uses wp_parse_args() Creates an array from string $args.
*
* @global object $wpdb Database Query
* @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;
@ -239,24 +231,28 @@ function get_objects_in_term( $terms, $taxonomies, $args = array() ) {
* get_row method.
*
* There are two hooks, one is specifically for each term, named 'get_term', and the second is
* for the taxonomy name. Both hooks gets the term object, and the taxonomy name as parameters.
* Both hooks are expected to return a Term object.
* 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 @see 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.
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
*
* @uses $wpdb
*
* @global object $wpdb Database Query
* @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
* @return mixed Term Row from database
*
* @internal
* This is all conjecture and might be partially or completely inaccurate.
* Uses custom hook phpdoc documentation that isn't compatible with phpDoc. Useful for a custom
* solution if used in an uniform fashion throughout the code base.
* @param string $filter {@internal Missing Description}}
* @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;
@ -278,33 +274,7 @@ function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
}
}
/**
* @internal
*
* Takes two parameters the term Object and the taxonomy name. Must return term object.
* Used in @see get_term() as a catch-all filter for every $term.
*
* @hook-name get_term
* @hook-return object
* @hook-param object $_term The current term object
* @hook-param string $taxonomy What taxonomy the term is in.
*/
$_term = apply_filters('get_term', $_term, $taxonomy);
/**
* @internal
*
* 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.
*
* @hook-name get_$taxonomy
* @hook-return object
* @hook-param object $_term The current term object
* @hook-param string $taxonomy What taxonomy the term is in.
*/
$_term = apply_filters("get_$taxonomy", $_term, $taxonomy);
$_term = sanitize_term($_term, $taxonomy, $filter);
@ -330,21 +300,18 @@ function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') {
* 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
* @category Term
* @since 2.3
*
* @uses $wpdb
*
* @global object $wpdb Database Query
* @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
* @return mixed Term Row from database
*
* @internal
* This is all conjecture and might be partially or completely inaccurate.
* @param string $filter {@internal Missing Description}}
* @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;
@ -388,21 +355,21 @@ function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw
* 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.
*
* Only useful for taxonomies which are hierarchical.
* Will return an empty array if $term does not exist in $taxonomy.
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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
*
* @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) )
@ -432,16 +399,15 @@ function get_term_children( $term, $taxonomy ) {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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 {@internal Missing Description}}
* @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;
@ -466,14 +432,13 @@ function get_term_field( $field, $term, $taxonomy, $context = 'display' ) {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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 );
@ -488,20 +453,51 @@ function get_term_to_edit( $id, $taxonomy ) {
}
/**
* get_terms() -
* get_terms() - Retrieve the terms in taxonomy or list of taxonomies.
*
* You can fully inject any customizations to the query before it is sent, as well as control
* the output with a filter.
*
* The 'get_terms' filter will be called when the cache has the term and will pass the found
* term along with the array of $taxonomies and array of $args. This filter is also called
* before the array of terms is passed and will pass the array of terms, along with the $taxonomies
* and $args.
*
* The 'list_terms_exclusions' filter passes the compiled exclusions along with the $args.
*
* The list that $args can contain, which will overwrite the defaults.
* orderby - Default is 'name'. Can be name, count, or nothing (will use term_id).
* order - Default is ASC. Can use DESC.
* hide_empty - Default is true. Will not return empty $terms.
* fields - Default is all.
* slug - Any terms that has this value. Default is empty string.
* hierarchical - Whether to return hierarchical taxonomy. Default is true.
* name__like - Default is empty string.
*
* The argument 'pad_counts' will count all of the children along with the $terms.
*
* The 'get' argument allows for overwriting 'hide_empty' and 'child_of', which can be done by
* setting the value to 'all', instead of its default empty string value.
*
* The 'child_of' argument will be used if you use multiple taxonomy or the first $taxonomy
* isn't hierarchical or 'parent' isn't used. The default is 0, which will be translated to
* a false value. If 'child_of' is set, then 'child_of' value will be tested against
* $taxonomy to see if 'child_of' is contained within. Will return an empty array if test
* fails.
*
* If 'parent' is set, then it will be used to test against the first taxonomy. Much like
* 'child_of'. Will return an empty array if the test fails.
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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 ??
* @return array List of Term Objects and their children.
*
* @internal
* This is all conjecture and might be partially or completely inaccurate.
* @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;
@ -683,9 +679,10 @@ function &get_terms($taxonomies, $args = '') {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
*
* @uses $wpdb
*
* @global $wpdb Database Object
* @param int|string $term The term to check
* @param string $taxonomy The taxonomy name to use
* @return mixed Get the term id or Term Object, if exists.
@ -720,11 +717,13 @@ function is_term($term, $taxonomy = '') {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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') {
@ -745,15 +744,16 @@ function sanitize_term($term, $taxonomy, $context = 'display') {
}
/**
* sanitize_term_field() -
*
* sanitize_term_field() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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
@ -800,15 +800,16 @@ function sanitize_term_field($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
* @category Term
* @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
@ -829,16 +830,16 @@ function wp_count_terms( $taxonomy, $args = array() ) {
}
/**
* wp_delete_object_term_relationships() -
*
* wp_delete_object_term_relationships() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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 ) {
@ -860,17 +861,17 @@ function wp_delete_object_term_relationships( $object_id, $taxonomies ) {
/**
* wp_delete_term() - Removes a term from the database.
*
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @global object $wpdb Database Object
* @param int $term Term ID
* @param string $taxonomy Taxonomy Name
* @param array|string $args Change Default
* @param bool Returns false if not term; true if completes delete action.
* @return bool Returns false if not term; true if completes delete action.
*/
function wp_delete_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
@ -930,17 +931,17 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) {
/**
* wp_get_object_terms() - Returns the terms associated with the given object(s), in the supplied taxonomies.
*
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @global $wpdb Database Object
* @param int|array $object_id The id of the object(s)) to retrieve for.
* @param int|array $object_id The id of the object(s)) to retrieve.
* @param string|array $taxonomies The taxonomies to retrieve terms from.
* @param array|string $args Change what is returned
* @return array The requested term data.
* @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;
@ -998,17 +999,17 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) {
/**
* wp_insert_term() - Adds a new term to the database. Optionally marks it as an alias of an existing term.
*
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @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;
@ -1083,21 +1084,21 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
}
/**
* wp_set_object_terms() -
* wp_set_object_terms() - {@internal Missing Short Description}}
*
* 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).
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @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 Affected Term IDs
* @return array|WP_Error Affected Term IDs
*/
function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) {
global $wpdb;
@ -1145,25 +1146,25 @@ function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) {
}
/**
* wp_unique_term_slug() - Will make @see $slug unique, if it isn't already
* wp_unique_term_slug() - Will make slug unique, if it isn't already
*
* The @see $slug has to be unique global to every taxonomy, meaning that one 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 @see $slug.
* 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 @see $term is for appending a parent, if one exists.
* The only purpose for $term is for appending a parent, if one exists.
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @global $wpdb Database Object
* @param string $slug The string that will be tried for a unique slug
* @param object $term The term object that the $slug will belong too
* @return string Will return a true unique slug.
@ -1201,15 +1202,15 @@ function wp_unique_term_slug($slug, $term) {
}
/**
* wp_update_term() -
*
* wp_update_term() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @global $wpdb Database Object
* @param int $term The ID of the term
* @param string $taxonomy The context in which to relate the term to the object.
* @param array|string $args Overwrite defaults
@ -1300,9 +1301,9 @@ function wp_update_term( $term, $taxonomy, $args = array() ) {
*
* @package WordPress
* @subpackage Taxonomy
* @category Term
* @since 2.3
* @uses $wpdb
*
* @global $wpdb Database Object
* @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.
@ -1340,19 +1341,18 @@ function wp_update_term_count( $terms, $taxonomy ) {
//
/**
* clean_object_term_cache() -
*
* clean_object_term_cache() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Cache
* @since 2.3
*
* @global $object_term_cache
* @global $blog_id The id of the blog, in case there is more than one blog using the library.
* @param int|array $object_ids
* @param string $object_type @see get_object_taxonomies
* @return null
* @see get_object_taxonomies() for more on $object_type
*
* @param int|array $object_ids {@internal Missing Description}}
* @param string $object_type {@internal Missing Description}}
*/
function clean_object_term_cache($object_ids, $object_type) {
if ( !is_array($object_ids) )
@ -1365,19 +1365,17 @@ function clean_object_term_cache($object_ids, $object_type) {
}
/**
* clean_term_cache() -
*
* clean_term_cache() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @category Cache
* @since 2.3
* @uses $wpdb
*
* @global $object_term_cache
* @global $blog_id The id of the blog, in case there is more than one blog using the library.
* @param int|array $ids
* @param int|array $ids {@internal Missing Description}}
* @param string $taxonomy Can be empty and will assume tt_ids, else will use for context.
* @return null
*/
function clean_term_cache($ids, $taxonomy = '') {
global $wpdb;
@ -1413,6 +1411,19 @@ function clean_term_cache($ids, $taxonomy = '') {
do_action('clean_term_cache', $ids, $taxonomy);
}
/**
* get_object_term_cache() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @since 2.3
*
* @param int|array $ids {@internal Missing Description}}
* @param string $taxonomy {@internal Missing Description}}
* @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) {
$terms = wp_cache_get($id, 'object_terms');
if ( false !== $terms ) {
@ -1425,6 +1436,20 @@ function &get_object_term_cache($id, $taxonomy) {
return false;
}
/**
* get_object_term_cache() - {@internal Missing Short Description}}
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @since 2.3
* @uses $wpdb
*
* @param string|array $object_ids {@internal Missing Description}}
* @param string $object_type {@internal Missing Description}}
* @return null|array Null value is given with empty $object_ids.
*/
function update_object_term_cache($object_ids, $object_type) {
global $wpdb;
@ -1460,6 +1485,16 @@ function update_object_term_cache($object_ids, $object_type) {
wp_cache_set($id, $value, 'object_terms');
}
/**
* 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;
@ -1474,6 +1509,19 @@ function update_term_cache($terms, $taxonomy = '') {
// Private
//
/**
* _get_term_hierarchy() - Retrieves children of taxonomy
*
* {@internal Missing Long Description}}
*
* @package WordPress
* @subpackage Taxonomy
* @access private
* @since 2.3
*
* @param string $taxonomy {@internal Missing Description}}
* @return array Empty if $taxonomy isn't hierarachical or returns children.
*/
function _get_term_hierarchy($taxonomy) {
if ( !is_taxonomy_hierarchical($taxonomy) )
return array();
@ -1493,7 +1541,6 @@ function _get_term_hierarchy($taxonomy) {
}
/**
* @access private
* _get_term_children() - Get array of child terms
*
* If $terms is an array of objects, then objects will returned from the function.
@ -1501,11 +1548,13 @@ function _get_term_hierarchy($taxonomy) {
*
* @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
* @return array Empty if $terms is empty else returns full list of child terms.
*/
function &_get_term_children($term_id, $terms, $taxonomy) {
if ( empty($terms) )
@ -1547,7 +1596,6 @@ function &_get_term_children($term_id, $terms, $taxonomy) {
}
/**
* @access private
* _pad_term_counts() - Add count of children to parent count
*
* Recalculates term counts by including items from child terms.
@ -1555,9 +1603,13 @@ function &_get_term_children($term_id, $terms, $taxonomy) {
*
* @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;
@ -1607,16 +1659,16 @@ function _pad_term_counts(&$terms, $taxonomy) {
//
/**
* @access private
* _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
* @category Callback
* @access private
* @since 2.3
* @uses $wpdb
*
* @global $wpdb Database Object
* @param array $terms List of Term IDs
*/
function _update_post_term_count( $terms ) {