diff --git a/wp-includes/l10n.php b/wp-includes/l10n.php index 2cfca0059..14f3d17cc 100644 --- a/wp-includes/l10n.php +++ b/wp-includes/l10n.php @@ -7,25 +7,23 @@ */ /** - * get_locale() - Gets the current locale + * Gets the current locale. * - * If the locale is set, then it will filter the locale - * in the 'locale' filter hook and return the value. + * If the locale is set, then it will filter the locale in the 'locale' filter + * hook and return the value. * - * If the locale is not set already, then the WPLANG - * constant is used if it is defined. Then it is filtered - * through the 'locale' filter hook and the value for the - * locale global set and the locale is returned. + * If the locale is not set already, then the WPLANG constant is used if it is + * defined. Then it is filtered through the 'locale' filter hook and the value + * for the locale global set and the locale is returned. * - * The process to get the locale should only be done once - * but the locale will always be filtered using the - * 'locale' hook. + * The process to get the locale should only be done once but the locale will + * always be filtered using the 'locale' hook. * * @since 1.5.0 - * @uses apply_filters() Calls 'locale' hook on locale value - * @uses $locale Gets the locale stored in the global + * @uses apply_filters() Calls 'locale' hook on locale value. + * @uses $locale Gets the locale stored in the global. * - * @return string The locale of the blog or from the 'locale' hook + * @return string The locale of the blog or from the 'locale' hook. */ function get_locale() { global $locale; @@ -46,22 +44,21 @@ function get_locale() { } /** - * translate() - Retrieve the translated text + * Retrieve the translated text. * - * If the domain is set in the $l10n global, then the text is run - * through the domain's translate method. After it is passed to - * the 'gettext' filter hook, along with the untranslated text as - * the second parameter. + * If the domain is set in the $l10n global, then the text is run through the + * domain's translate method. After it is passed to the 'gettext' filter hook, + * along with the untranslated text as the second parameter. * * If the domain is not set, the $text is just returned. * * @since 2.2.0 - * @uses $l10n Gets list of domain translated string (gettext_reader) objects + * @uses $l10n Gets list of domain translated string (gettext_reader) objects. * @uses apply_filters() Calls 'gettext' on domain translated text - * with the untranslated text as second parameter + * with the untranslated text as second parameter. * - * @param string $text Text to translate - * @param string $domain Domain to retrieve the translated text + * @param string $text Text to translate. + * @param string $domain Domain to retrieve the translated text. * @return string Translated text */ function translate($text, $domain = 'default') { @@ -74,12 +71,11 @@ function translate($text, $domain = 'default') { } /** - * translate_with_context() - Retrieve the translated text and strip context + * Retrieve the translated text and strip context. * - * If the domain is set in the $l10n global, then the text is run - * through the domain's translate method. After it is passed to - * the 'gettext' filter hook, along with the untranslated text as - * the second parameter. + * If the domain is set in the $l10n global, then the text is run through the + * domain's translate method. After it is passed to the 'gettext' filter hook, + * along with the untranslated text as the second parameter. * * If the domain is not set, the $text is just returned. * @@ -101,10 +97,7 @@ function translate_with_context($text, $domain = 'default') { } /** - * __() - Retrieve a translated string - * - * __() is a convenience function which retrieves the translated - * string from the translate(). + * Retrieves the translated string from the translate(). * * @see translate() An alias of translate() * @since 2.1.0 @@ -117,12 +110,8 @@ function __($text, $domain = 'default') { return translate($text, $domain); } -// . /** - * _e() - Display a translated string - * - * _e() is a convenience function which displays the returned - * translated text from translate(). + * Displays the returned translated text from translate(). * * @see translate() Echos returned translate() string * @since 1.2.0 @@ -135,20 +124,17 @@ function _e($text, $domain = 'default') { } /** - * _c() - Retrieve context translated string + * Retrieve context translated string. * - * Quite a few times, there will be collisions with similar - * translatable text found in more than two places but with - * different translated context. + * Quite a few times, there will be collisions with similar translatable text + * found in more than two places but with different translated context. * - * In order to use the separate contexts, the _c() function - * is used and the translatable string uses a pipe ('|') - * which has the context the string is in. + * In order to use the separate contexts, the _c() function is used and the + * translatable string uses a pipe ('|') which has the context the string is in. * - * When the translated string is returned, it is everything - * before the pipe, not including the pipe character. If - * there is no pipe in the translated text then everything - * is returned. + * When the translated string is returned, it is everything before the pipe, not + * including the pipe character. If there is no pipe in the translated text then + * everything is returned. * * @since 2.2.0 * @@ -161,15 +147,15 @@ function _c($text, $domain = 'default') { } /** - * __ngettext() - Retrieve the plural or single form based on the amount + * Retrieve the plural or single form based on the amount. * - * If the domain is not set in the $l10n list, then a comparsion - * will be made and either $plural or $single parameters returned. + * If the domain is not set in the $l10n list, then a comparsion will be made + * and either $plural or $single parameters returned. * - * If the domain does exist, then the parameters $single, $plural, - * and $number will first be passed to the domain's ngettext method. - * Then it will be passed to the 'ngettext' filter hook along with - * the same parameters. The expected type will be a string. + * If the domain does exist, then the parameters $single, $plural, and $number + * will first be passed to the domain's ngettext method. Then it will be passed + * to the 'ngettext' filter hook along with the same parameters. The expected + * type will be a string. * * @since 1.2.0 * @uses $l10n Gets list of domain translated string (gettext_reader) objects @@ -196,7 +182,7 @@ function __ngettext($single, $plural, $number, $domain = 'default') { } /** - * __ngettext_noop() - register plural strings in POT file, but don't translate them + * Register plural strings in POT file, but don't translate them. * * Used when you want do keep structures with translatable plural strings and * use them later. @@ -222,13 +208,13 @@ function __ngettext_noop($single, $plural, $number=1, $domain = 'default') { } /** - * load_textdomain() - Loads MO file into the list of domains + * Loads MO file into the list of domains. * - * If the domain already exists, the inclusion will fail. If the - * MO file is not readable, the inclusion will fail. + * If the domain already exists, the inclusion will fail. If the MO file is not + * readable, the inclusion will fail. * - * On success, the mofile will be placed in the $l10n global by - * $domain and will be an gettext_reader object. + * On success, the mofile will be placed in the $l10n global by $domain and will + * be an gettext_reader object. * * @since 1.5.0 * @uses $l10n Gets list of domain translated string (gettext_reader) objects @@ -260,10 +246,10 @@ function load_textdomain($domain, $mofile) { } /** - * load_default_textdomain() - Loads default translated strings based on locale + * Loads default translated strings based on locale. * - * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. - * The translated (.mo) file is named based off of the locale. + * Loads the .mo file in WP_LANG_DIR constant path from WordPress root. The + * translated (.mo) file is named based off of the locale. * * @since 1.5.0 */ @@ -276,11 +262,11 @@ function load_default_textdomain() { } /** - * load_plugin_textdomain() - Loads the plugin's translated strings + * Loads the plugin's translated strings. * - * If the path is not given then it will be the root of the plugin - * directory. The .mo file should be named based on the domain with a - * dash followed by a dash, and then the locale exactly. + * If the path is not given then it will be the root of the plugin directory. + * The .mo file should be named based on the domain with a dash followed by a + * dash, and then the locale exactly. * * @since 1.5.0 * @@ -304,7 +290,7 @@ function load_plugin_textdomain($domain, $abs_rel_path = false, $plugin_rel_path } /** - * load_theme_textdomain() - Includes theme's translated strings for the theme + * Loads the theme's translated strings. * * If the current locale exists as a .mo file in the theme's root directory, it * will be included in the translated strings by the $domain. diff --git a/wp-includes/locale.php b/wp-includes/locale.php index 27a35d134..135c6bf72 100644 --- a/wp-includes/locale.php +++ b/wp-includes/locale.php @@ -7,9 +7,7 @@ */ /** - * {@internal Missing Short Description}} - * - * {@internal Missing Long Description}} + * Class that loads the calendar locale. * * @since 2.1.0 */ diff --git a/wp-includes/plugin.php b/wp-includes/plugin.php index 98a54a6e2..0522d5433 100644 --- a/wp-includes/plugin.php +++ b/wp-includes/plugin.php @@ -11,8 +11,8 @@ * {@link http://us2.php.net/manual/en/language.pseudo-types.php#language.types.callback 'callback'} * type are valid. * - * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for more information - * and examples on how to use a lot of these functions. + * Also see the {@link http://codex.wordpress.org/Plugin_API Plugin API} for + * more information and examples on how to use a lot of these functions. * * @package WordPress * @subpackage Plugin @@ -27,24 +27,27 @@ * can specify that one or more of its PHP functions is executed to * modify specific types of text at these times, using the Filter API. * - * To use the API, the following code should be used to bind a callback to the filter + * To use the API, the following code should be used to bind a callback to the + * filter. + * * * function example_hook($example) { echo $example; } - * * add_filter('example_filter', 'example_hook'); * * - * In WordPress 1.5.1+, hooked functions can take extra arguments that are set when - * the matching do_action() or apply_filters() call is run. The $accepted_args - * allow for calling functions only when the number of args match. Hooked functions - * can take extra arguments that are set when the matching do_action() or - * apply_filters() call is run. For example, the action comment_id_not_found - * will pass any functions that hook onto it the ID of the requested comment. + * In WordPress 1.5.1+, hooked functions can take extra arguments that are set + * when the matching do_action() or apply_filters() call is run. The + * $accepted_args allow for calling functions only when the number of args + * match. Hooked functions can take extra arguments that are set when the + * matching do_action() or apply_filters() call is run. For example, the action + * comment_id_not_found will pass any functions that hook onto it the ID of the + * requested comment. * - * Note: the function will return true no matter if the function was hooked - * fails or not. There are no checks for whether the function exists beforehand and no checks - * to whether the $function_to_add is even a string. It is up to you to take care and - * this is done for optimization purposes, so everything is as quick as possible. + * Note: the function will return true no matter if the + * function was hooked fails or not. There are no checks for whether the + * function exists beforehand and no checks to whether the $function_to_add + * is even a string. It is up to you to take care and this is done for + * optimization purposes, so everything is as quick as possible. * * @package WordPress * @subpackage Plugin @@ -53,7 +56,7 @@ * wp_filter['tag']['array of priorities']['array of functions serialized']['array of ['array (functions, accepted_args)]'] * @global array $merged_filters Tracks the tags that need to be merged for later. If the hook is added, it doesn't need to run through that process. * - * @param string $tag The name of the filter to hook the $function_to_add to. + * @param string $tag The name of the filter to hook the $function_to_add to. * @param callback $function_to_add The name of the function to be called when the filter is applied. * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action. * @param int $accepted_args optional. The number of arguments the function accept (default 1). @@ -101,10 +104,10 @@ function has_filter($tag, $function_to_check = false) { /** * Call the functions added to a filter hook. * - * The callback functions attached to filter hook $tag are invoked by - * calling this function. This function can be used to create a new filter hook - * by simply calling this function with the name of the new hook specified using - * the $tag parameter. + * The callback functions attached to filter hook $tag are invoked by calling + * this function. This function can be used to create a new filter hook by + * simply calling this function with the name of the new hook specified using + * the $tag parameter. * * The function allows for additional arguments to be added and passed to hooks. * @@ -232,7 +235,7 @@ function remove_all_filters($tag, $priority = false) { } /** - * Return the name of the current filter or action. + * Retrieve the name of the current filter or action. * * @package WordPress * @subpackage Plugin @@ -260,7 +263,7 @@ function current_filter() { * @subpackage Plugin * @since 1.2 * - * @param string $tag The name of the action to which the $function_to-add is hooked. + * @param string $tag The name of the action to which the $function_to_add is hooked. * @param callback $function_to_add The name of the function you wish to be called. * @param int $priority optional. Used to specify the order in which the functions associated with a particular action are executed (default: 10). Lower numbers correspond with earlier execution, and functions with the same priority are executed in the order in which they were added to the action. * @param int $accepted_args optional. The number of arguments the function accept (default 1). @@ -273,14 +276,15 @@ function add_action($tag, $function_to_add, $priority = 10, $accepted_args = 1) /** * Execute functions hooked on a specific action hook. * - * This function invokes all functions attached to action hook $tag. - * It is possible to create new action hooks by simply calling this function, + * This function invokes all functions attached to action hook $tag. It is + * possible to create new action hooks by simply calling this function, * specifying the name of the new hook using the $tag parameter. * - * You can pass extra arguments to the hooks, much like you can with apply_filters(). + * You can pass extra arguments to the hooks, much like you can with + * apply_filters(). * - * @see apply_filters() This function works similar with the exception that nothing is - * returned and only the functions or methods are called. + * @see apply_filters() This function works similar with the exception that + * nothing is returned and only the functions or methods are called. * * @package WordPress * @subpackage Plugin @@ -340,7 +344,7 @@ function do_action($tag, $arg = '') { } /** - * Return the number times an action is fired. + * Retrieve the number times an action is fired. * * @package WordPress * @subpackage Plugin @@ -362,8 +366,8 @@ function did_action($tag) { /** * Execute functions hooked on a specific action hook, specifying arguments in an array. * - * @see do_action() This function is identical, but the arguments passed to - * the functions hooked to $tag are supplied using an array. + * @see do_action() This function is identical, but the arguments passed to the + * functions hooked to $tag are supplied using an array. * * @package WordPress * @subpackage Plugin @@ -498,10 +502,10 @@ function plugin_basename($file) { * When a plugin is activated, the action 'activate_PLUGINNAME' hook is * activated. In the name of this hook, PLUGINNAME is replaced with the name of * the plugin, including the optional subdirectory. For example, when the plugin - * is located in wp-content/plugin/sampleplugin/sample.php, then the - * name of this hook will become 'activate_sampleplugin/sample.php' - * When the plugin consists of only one file and is (as by default) located at - * wp-content/plugin/sample.php the name of this hook will be + * is located in wp-content/plugin/sampleplugin/sample.php, then the name of + * this hook will become 'activate_sampleplugin/sample.php'. When the plugin + * consists of only one file and is (as by default) located at + * wp-content/plugin/sample.php the name of this hook will be * 'activate_sample.php'. * * @package WordPress @@ -524,11 +528,11 @@ function register_activation_hook($file, $function) { * When a plugin is deactivated, the action 'deactivate_PLUGINNAME' hook is * deactivated. In the name of this hook, PLUGINNAME is replaced with the name * of the plugin, including the optional subdirectory. For example, when the - * plugin is located in wp-content/plugin/sampleplugin/sample.php, then + * plugin is located in wp-content/plugin/sampleplugin/sample.php, then * the name of this hook will become 'activate_sampleplugin/sample.php'. * * When the plugin consists of only one file and is (as by default) located at - * wp-content/plugin/sample.php the name of this hook will be + * wp-content/plugin/sample.php the name of this hook will be * 'activate_sample.php'. * * @package WordPress @@ -631,11 +635,9 @@ function _wp_call_all_hook($args) { * * @package WordPress * @subpackage Plugin - * @since 2.2.3 - * - * @link http://trac.wordpress.org/ticket/3875 - * * @access private + * @since 2.2.3 + * @link http://trac.wordpress.org/ticket/3875 * * @global array $wp_filter Storage for all of the filters and actions * @param string $tag Used in counting how many hooks were applied diff --git a/wp-includes/registration.php b/wp-includes/registration.php index efd34c3cf..e054c5e7f 100644 --- a/wp-includes/registration.php +++ b/wp-includes/registration.php @@ -6,7 +6,7 @@ */ /** - * username_exists() - Checks whether the given username exists. + * Checks whether the given username exists. * * @since 2.0.0 * @@ -22,7 +22,7 @@ function username_exists( $username ) { } /** - * email_exists() - Checks whether the given email exists. + * Checks whether the given email exists. * * @since 2.1.0 * @uses $wpdb @@ -38,7 +38,7 @@ function email_exists( $email ) { } /** - * validate_username() - Checks whether an username is valid. + * Checks whether an username is valid. * * @since 2.0.1 * @uses apply_filters() Calls 'validate_username' hook on $valid check and $username as parameters @@ -53,21 +53,19 @@ function validate_username( $username ) { } /** - * wp_insert_user() - Insert an user into the database. + * Insert an user into the database. * - * Can update a current user or insert a new user based on whether - * the user's ID is present. + * Can update a current user or insert a new user based on whether the user's ID + * is present. * - * Can be used to update the user's info (see below), set the user's - * role, and set the user's preference on whether they want the rich - * editor on. + * Can be used to update the user's info (see below), set the user's role, and + * set the user's preference on whether they want the rich editor on. * - * Most of the $userdata array fields have filters associated with - * the values. The exceptions are 'rich_editing', 'role', 'jabber', - * 'aim', 'yim', 'user_registered', and 'ID'. The filters have the - * prefix 'pre_user_' followed by the field name. An example using - * 'description' would have the filter called, 'pre_user_description' - * that can be hooked into. + * Most of the $userdata array fields have filters associated with the values. + * The exceptions are 'rich_editing', 'role', 'jabber', 'aim', 'yim', + * 'user_registered', and 'ID'. The filters have the prefix 'pre_user_' followed + * by the field name. An example using 'description' would have the filter + * called, 'pre_user_description' that can be hooked into. * * The $userdata array can contain the following fields: * 'ID' - An integer that will be used for updating an existing user. @@ -77,15 +75,16 @@ function validate_username( $username ) { * The default is the user's username. * 'user_url' - A string containing the user's URL for the user's web site. * 'user_email' - A string containing the user's email address. - * 'display_name' - A string that will be shown on the site. Defaults to user's username. - * It is likely that you will want to change this, for both appearance and security - * through obscurity (that is if you don't use and delete the default 'admin' user). + * 'display_name' - A string that will be shown on the site. Defaults to user's + * username. It is likely that you will want to change this, for both + * appearance and security through obscurity (that is if you don't use and + * delete the default 'admin' user). * 'nickname' - The user's nickname, defaults to the user's username. * 'first_name' - The user's first name. * 'last_name' - The user's last name. * 'description' - A string containing content about the user. - * 'rich_editing' - A string for whether to enable the rich editor or not. False if not - * empty. + * 'rich_editing' - A string for whether to enable the rich editor or not. False + * if not empty. * 'user_registered' - The date the user registered. Format is 'Y-m-d H:i:s'. * 'role' - A string used to set the user's role. * 'jabber' - User's Jabber account. @@ -208,16 +207,16 @@ function wp_insert_user($userdata) { } /** - * wp_update_user() - Update an user in the database + * Update an user in the database. * - * It is possible to update a user's password by specifying the - * 'user_pass' value in the $userdata parameter array. + * It is possible to update a user's password by specifying the 'user_pass' + * value in the $userdata parameter array. * - * If $userdata does not contain an 'ID' key, then a new user - * will be created and the new user's ID will be returned. + * If $userdata does not contain an 'ID' key, then a new user will be created + * and the new user's ID will be returned. * - * If current user's password is being updated, then the cookies - * will be cleared. + * If current user's password is being updated, then the cookies will be + * cleared. * * @since 2.0.0 * @see wp_insert_user() For what fields can be set in $userdata @@ -258,7 +257,7 @@ function wp_update_user($userdata) { } /** - * wp_create_user() - A simpler way of inserting an user into the database. + * A simpler way of inserting an user into the database. * * Creates a new user with just the username, password, and email. For a more * detail creation of a user, use wp_insert_user() to specify more infomation. diff --git a/wp-includes/rss.php b/wp-includes/rss.php index ef756bf79..ca2534ed5 100644 --- a/wp-includes/rss.php +++ b/wp-includes/rss.php @@ -387,6 +387,16 @@ class MagpieRSS { require_once( dirname(__FILE__) . '/class-snoopy.php'); if ( !function_exists('fetch_rss') ) : +/** + * Build Magpie object based on RSS from URL. + * + * @since unknown + * @package External + * @subpackage MagpieRSS + * + * @param string $url URL to retrieve feed + * @return bool|MagpieRSS false on failure or MagpieRSS object on success. + */ function fetch_rss ($url) { // initialize constants init(); @@ -515,6 +525,17 @@ function fetch_rss ($url) { } // end fetch_rss() endif; +/** + * Retrieve URL headers and content using Snoopy. + * + * @since unknown + * @package External + * @subpackage MagpieRSS + * + * @param string $url URL to retrieve + * @param array $headers Optional. Headers to send to the URL. + * @return Snoopy + */ function _fetch_remote_file ($url, $headers = "" ) { // Snoopy is an HTTP client in PHP $client = new Snoopy(); @@ -530,6 +551,16 @@ function _fetch_remote_file ($url, $headers = "" ) { } +/** + * Retrieve + * + * @since unknown + * @package External + * @subpackage MagpieRSS + * + * @param unknown_type $resp + * @return unknown + */ function _response_to_rss ($resp) { $rss = new MagpieRSS( $resp->results ); @@ -570,11 +601,13 @@ function _response_to_rss ($resp) { } // end if ($rss and !$rss->error) } -/*=======================================================================*\ - Function: init - Purpose: setup constants with default values - check for user overrides -\*=======================================================================*/ +/** + * Setup constants with default values, unless user overrides. + * + * @since unknown + * @package External + * @subpackage MagpieRSS + */ function init () { if ( defined('MAGPIE_INITALIZED') ) { return; @@ -835,6 +868,16 @@ function parse_w3cdtf ( $date_str ) { endif; if ( !function_exists('wp_rss') ) : +/** + * Display all RSS items in a HTML ordered list. + * + * @since unknown + * @package External + * @subpackage MagpieRSS + * + * @param string $url URL of feed to display. Will not auto sense feed URL. + * @param int $num_items Optional. Number of items to display, default is all. + */ function wp_rss( $url, $num_items = -1 ) { if ( $rss = fetch_rss( $url ) ) { echo '
    '; @@ -860,6 +903,22 @@ function wp_rss( $url, $num_items = -1 ) { endif; if ( !function_exists('get_rss') ) : +/** + * Display RSS items in HTML list items. + * + * You have to specify which HTML list you want, either ordered or unordered + * before using the function. You also have to specify how many items you wish + * to display. You can't display all of them like you can with wp_rss() + * function. + * + * @since unknown + * @package External + * @subpackage MagpieRSS + * + * @param string $url URL of feed to display. Will not auto sense feed URL. + * @param int $num_items Optional. Number of items to display, default is all. + * @return bool False on failure. + */ function get_rss ($url, $num_items = 5) { // Like get posts, but for RSS $rss = fetch_rss($url); if ( $rss ) { diff --git a/wp-includes/script-loader.php b/wp-includes/script-loader.php index 5fdadc465..cf7ad0100 100644 --- a/wp-includes/script-loader.php +++ b/wp-includes/script-loader.php @@ -30,7 +30,7 @@ require( ABSPATH . WPINC . '/functions.wp-styles.php' ); * * Localizes a few of the scripts. * - * @since unknown + * @since 2.6.0 * * @param object $scripts WP_Scripts object. */ diff --git a/wp-includes/taxonomy.php b/wp-includes/taxonomy.php index fc39a7c43..c0267fd4b 100644 --- a/wp-includes/taxonomy.php +++ b/wp-includes/taxonomy.php @@ -1,8 +1,10 @@ 'link_category', 'obj * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @@ -65,7 +67,7 @@ function get_object_taxonomies($object) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @uses is_taxonomy() Checks whether taxonomy exists @@ -87,7 +89,7 @@ function get_taxonomy( $taxonomy ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wp_taxonomies * @@ -110,7 +112,7 @@ function is_taxonomy( $taxonomy ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses is_taxonomy() Checks whether taxonomy exists * @uses get_taxonomy() Used to get the taxonomy object @@ -153,7 +155,7 @@ function is_taxonomy_hierarchical($taxonomy) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wp_taxonomies Inserts new taxonomy object into the list * @uses $wp_rewrite Adds rewrite tags and permastructs * @uses $wp Adds query vars @@ -210,7 +212,7 @@ function register_taxonomy( $taxonomy, $object_type, $args = array() ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses wp_parse_args() Creates an array from string $args. @@ -281,7 +283,7 @@ function get_objects_in_term( $terms, $taxonomies, $args = array() ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses sanitize_term() Cleanses the term based on $filter context before returning. @@ -347,7 +349,7 @@ function &get_term($term, $taxonomy, $output = OBJECT, $filter = 'raw') { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses sanitize_term() Cleanses the term based on $filter context before returning. @@ -408,7 +410,7 @@ function get_term_by($field, $value, $taxonomy, $output = OBJECT, $filter = 'raw * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses _get_term_hierarchy() @@ -446,7 +448,7 @@ function get_term_children( $term, $taxonomy ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success. * @@ -479,7 +481,7 @@ function get_term_field( $field, $term, $taxonomy, $context = 'display' ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses sanitize_term() Passes the return value on success * @@ -543,7 +545,7 @@ function get_term_to_edit( $id, $taxonomy ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses wp_parse_args() Merges the defaults with those defined by $args and allows for strings. @@ -757,7 +759,7 @@ function &get_terms($taxonomies, $args = '') { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @@ -811,7 +813,7 @@ function is_term($term, $taxonomy = '') { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses sanitize_term_field Used to sanitize all fields in a term * @@ -856,7 +858,7 @@ function sanitize_term($term, $taxonomy, $context = 'display') { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @@ -916,7 +918,7 @@ function sanitize_term_field($field, $value, $term_id, $taxonomy, $context) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses wp_parse_args() Turns strings into arrays and merges defaults into an array. @@ -948,7 +950,7 @@ function wp_count_terms( $taxonomy, $args = array() ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int $object_id The term Object Id that refers to the term @@ -981,7 +983,7 @@ function wp_delete_object_term_relationships( $object_id, $taxonomies ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses do_action() Calls both 'delete_term' and 'delete_$taxonomy' action @@ -1075,7 +1077,7 @@ function wp_delete_term( $term, $taxonomy, $args = array() ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int|array $object_id The id of the object(s) to retrieve. @@ -1199,7 +1201,7 @@ function wp_get_object_terms($object_ids, $taxonomies, $args = array()) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @uses do_action() Calls 'create_term' hook with the term id and taxonomy id as parameters. @@ -1304,7 +1306,7 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int $object_id The object to relate to. @@ -1390,7 +1392,7 @@ function wp_set_object_terms($object_id, $terms, $taxonomy, $append = false) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param string $slug The string that will be tried for a unique slug @@ -1457,7 +1459,7 @@ function wp_unique_term_slug($slug, $term) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses $wpdb * @uses do_action() Will call both 'edit_term' and 'edit_$taxonomy' twice. @@ -1554,19 +1556,19 @@ function wp_update_term( $term, $taxonomy, $args = array() ) { /** * Enable or disable term counting. * - * @since 2.6 + * @since 2.5.0 * - * @param bool $defer Optional. - * @return bool + * @param bool $defer Optional. Enable if true, disable if false. + * @return bool Whether term counting is enabled or disabled. */ -function wp_defer_term_counting($defer=NULL) { +function wp_defer_term_counting($defer=null) { static $_defer = false; if ( is_bool($defer) ) { $_defer = $defer; // flush any deferred counts if ( !$defer ) - wp_update_term_count( NULL, NULL, true ); + wp_update_term_count( null, null, true ); } return $_defer; @@ -1583,7 +1585,7 @@ function wp_defer_term_counting($defer=NULL) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int|array $terms The ID of the terms @@ -1619,7 +1621,7 @@ function wp_update_term_count( $terms, $taxonomy, $do_deferred=false ) { /** * Perform term count update immediately. * - * @since 2.6 + * @since 2.5.0 * * @param array $terms IDs of Terms to update. * @param string $taxonomy The context of the term. @@ -1661,7 +1663,7 @@ function wp_update_term_count_now( $terms, $taxonomy ) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @see get_object_taxonomies() for more on $object_type * @uses do_action() Will call action hook named, 'clean_object_term_cache' after completion. @@ -1687,7 +1689,7 @@ function clean_object_term_cache($object_ids, $object_type) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param int|array $ids Single or list of Term IDs @@ -1733,7 +1735,7 @@ function clean_term_cache($ids, $taxonomy = '') { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @uses wp_cache_get() Retrieves taxonomy relationship from cache * @@ -1762,7 +1764,7 @@ function &get_object_term_cache($id, $taxonomy) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * @uses wp_get_object_terms() Used to get terms from the database to update * * @param string|array $object_ids Single or list of term object ID(s) @@ -1822,7 +1824,7 @@ function update_object_term_cache($object_ids, $object_type) { * * @package WordPress * @subpackage Taxonomy - * @since 2.3 + * @since 2.3.0 * * @param array $terms List of Term objects to change * @param string $taxonomy Optional. Update Term to this taxonomy in cache @@ -1848,7 +1850,7 @@ function update_term_cache($terms, $taxonomy = '') { * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * * @uses update_option() Stores all of the children in "$taxonomy_children" * option. That is the name of the taxonomy, immediately followed by '_children'. @@ -1885,7 +1887,7 @@ function _get_term_hierarchy($taxonomy) { * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * * @param int $term_id Look for this Term ID in $terms * @param array $terms List of Term IDs @@ -1942,7 +1944,7 @@ function &_get_term_children($term_id, $terms, $taxonomy) { * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param array $terms List of Term IDs @@ -2005,7 +2007,7 @@ function _pad_term_counts(&$terms, $taxonomy) { * @package WordPress * @subpackage Taxonomy * @access private - * @since 2.3 + * @since 2.3.0 * @uses $wpdb * * @param array $terms List of Term IDs @@ -2023,7 +2025,7 @@ function _update_post_term_count( $terms ) { /** * Generates a permalink for a taxonomy term archive. * - * @since 2.6 + * @since 2.5.0 * * @param object|int|string $term * @param string $taxonomy @@ -2079,7 +2081,7 @@ function get_term_link( $term, $taxonomy ) { * 'sep' : default is empty string. Separate every taxonomy with value in this. * 'after' : default is empty string. Display this after the taxonomies list. * - * @since 2.6 + * @since 2.5.0 * @uses get_the_taxonomies() * * @param array $args Override the defaults. @@ -2104,7 +2106,7 @@ function the_taxonomies($args = array()) { * This function can be used within the loop. It will also return an array of * the taxonomies with links to the taxonomy and name. * - * @since 2.6 + * @since 2.5.0 * * @param int $post Optional. Post ID or will use Global Post ID (in loop). * @return array @@ -2149,7 +2151,7 @@ function get_the_taxonomies($post = 0) { /** * Retrieve all taxonomies of a post with just the names. * - * @since 2.6 + * @since 2.5.0 * @uses get_object_taxonomies() * * @param int $post Optional. Post ID