WordPress.org

Make WordPress Core

Changeset 32348


Ignore:
Timestamp:
05/05/2015 02:00:18 AM (5 years ago)
Author:
DrewAPicture
Message:

Improve inline documentation in wp-includes/taxonomy.php.

  • Adds missing @since versions
  • Adds @global tags and descriptions to DocBlocks where appropriate

Props ChaseWiseman.
See #31800.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/taxonomy.php

    r32327 r32348  
    22/**
    33 * Taxonomy API
     4 *
     5 * @since 2.3.0
    46 *
    57 * @package WordPress
    68 * @subpackage Taxonomy
    7  * @since 2.3.0
    89 */
    910
     
    1617 *
    1718 * This function fires twice: in wp-settings.php before plugins are loaded (for
    18  * backwards compatibility reasons), and again on the 'init' action. We must avoid
    19  * registering rewrite rules before the 'init' action.
     19 * backwards compatibility reasons), and again on the {@see 'init'} action. We must
     20 * avoid registering rewrite rules before the {@see 'init'} action.
     21 *
     22 * @since 2.8.0
     23 *
     24 * @global WP_Rewrite $wp_rewrite The WordPress rewrite class.
    2025 */
    2126function create_initial_taxonomies() {
     
    130135
    131136/**
    132  * Get a list of registered taxonomy objects.
     137 * Retrieves a list of registered taxonomy names or objects.
    133138 *
    134139 * @since 3.0.0
    135  * @uses $wp_taxonomies
     140 *
     141 * @global array $wp_taxonomies The registered taxonomies.
    136142 *
    137143 * @param array $args An array of key => value arguments to match against the taxonomy objects.
     
    160166 * @since 2.3.0
    161167 *
    162  * @uses $wp_taxonomies
     168 * @global array $wp_taxonomies The registered taxonomies.
    163169 *
    164170 * @param array|string|object $object Name of the type of taxonomy object, or an object (row from posts)
     
    198204 * @since 2.3.0
    199205 *
    200  * @uses $wp_taxonomies
     206 * @global array $wp_taxonomies The registered taxonomies.
    201207 *
    202208 * @param string $taxonomy Name of taxonomy object to return
     
    219225 * @since 3.0.0
    220226 *
    221  * @uses $wp_taxonomies
     227 * @global array $wp_taxonomies The registered taxonomies.
    222228 *
    223229 * @param string $taxonomy Name of taxonomy object
     
    465471 *
    466472 * @since 3.0.0
     473 *
    467474 * @param object $tax Taxonomy object
    468475 * @return object object with all the labels as member variables
     
    505512 *
    506513 * @since 3.0.0
    507  * @uses $wp_taxonomies Modifies taxonomy object
     514 *
     515 * @global array $wp_taxonomies The registered taxonomies.
    508516 *
    509517 * @param string $taxonomy Name of taxonomy object
     
    530538 *
    531539 * @since 3.7.0
     540 *
     541 * @global array $wp_taxonomies The registered taxonomies.
    532542 *
    533543 * @param string $taxonomy    Name of taxonomy object.
     
    10021012     * @access public
    10031013     *
     1014     * @global wpdb $wpdb The WordPress database abstraction object.
     1015     *
    10041016     * @param array $clause       Query clause, passed by reference
    10051017     * @param array $parent_query Parent query array.
     
    12091221     *
    12101222     * @since 3.2.0
     1223     *
     1224     * @global wpdb $wpdb The WordPress database abstraction object.
    12111225     *
    12121226     * @param array  &$query          The single query.
     
    14611475 *
    14621476 * @since 2.3.0
    1463  *
    1464  * @global wpdb $wpdb WordPress database abstraction object.
    14651477 *
    14661478 * @param string $term_id ID of Term to get children
     
    30533065 * @since 2.3.0
    30543066 *
     3067 * @global wpdb $wpdb The WordPress database abstraction object.
     3068 *
    30553069 * @param int              $object_id The object to relate to.
    30563070 * @param array|int|string $terms     A single term slug, single term id, or array of either term slugs or ids.
Note: See TracChangeset for help on using the changeset viewer.