Make WordPress Core


Ignore:
Timestamp:
08/30/2008 09:23:43 PM (15 years ago)
Author:
westi
Message:

phpDoc corrections for wp-includes. See #7550 props jacobsantos.

File:
1 edited

Legend:

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

    r8732 r8782  
    11<?php
    22/**
    3  * @package WordPress
    4  * @subpackage Taxonomy
    5  * @since 2.3
     3 * Taxonomy API
     4 *
     5 * @package WordPress
     6 * @subpackage Taxonomy
     7 * @since 2.3.0
    68 */
    79
     
    1214/**
    1315 * Default Taxonomy Objects
    14  * @since 2.3
     16 * @since 2.3.0
    1517 * @global array $wp_taxonomies
    1618 */
     
    3133 * @package WordPress
    3234 * @subpackage Taxonomy
    33  * @since 2.3
     35 * @since 2.3.0
    3436 *
    3537 * @uses $wp_taxonomies
     
    6668 * @package WordPress
    6769 * @subpackage Taxonomy
    68  * @since 2.3
     70 * @since 2.3.0
    6971 *
    7072 * @uses $wp_taxonomies
     
    8890 * @package WordPress
    8991 * @subpackage Taxonomy
    90  * @since 2.3
     92 * @since 2.3.0
    9193 *
    9294 * @uses $wp_taxonomies
     
    111113 * @package WordPress
    112114 * @subpackage Taxonomy
    113  * @since 2.3
     115 * @since 2.3.0
    114116 *
    115117 * @uses is_taxonomy() Checks whether taxonomy exists
     
    154156 * @package WordPress
    155157 * @subpackage Taxonomy
    156  * @since 2.3
     158 * @since 2.3.0
    157159 * @uses $wp_taxonomies Inserts new taxonomy object into the list
    158160 * @uses $wp_rewrite Adds rewrite tags and permastructs
     
    211213 * @package WordPress
    212214 * @subpackage Taxonomy
    213  * @since 2.3
     215 * @since 2.3.0
    214216 *
    215217 * @uses $wpdb
     
    282284 * @package WordPress
    283285 * @subpackage Taxonomy
    284  * @since 2.3
     286 * @since 2.3.0
    285287 *
    286288 * @uses $wpdb
     
    348350 * @package WordPress
    349351 * @subpackage Taxonomy
    350  * @since 2.3
     352 * @since 2.3.0
    351353 *
    352354 * @uses $wpdb
     
    409411 * @package WordPress
    410412 * @subpackage Taxonomy
    411  * @since 2.3
     413 * @since 2.3.0
    412414 *
    413415 * @uses $wpdb
     
    447449 * @package WordPress
    448450 * @subpackage Taxonomy
    449  * @since 2.3
     451 * @since 2.3.0
    450452 *
    451453 * @uses sanitize_term_field() Passes the return value in sanitize_term_field on success.
     
    480482 * @package WordPress
    481483 * @subpackage Taxonomy
    482  * @since 2.3
     484 * @since 2.3.0
    483485 *
    484486 * @uses sanitize_term() Passes the return value on success
     
    544546 * @package WordPress
    545547 * @subpackage Taxonomy
    546  * @since 2.3
     548 * @since 2.3.0
    547549 *
    548550 * @uses $wpdb
     
    758760 * @package WordPress
    759761 * @subpackage Taxonomy
    760  * @since 2.3
     762 * @since 2.3.0
    761763 *
    762764 * @uses $wpdb
     
    812814 * @package WordPress
    813815 * @subpackage Taxonomy
    814  * @since 2.3
     816 * @since 2.3.0
    815817 *
    816818 * @uses sanitize_term_field Used to sanitize all fields in a term
     
    857859 * @package WordPress
    858860 * @subpackage Taxonomy
    859  * @since 2.3
     861 * @since 2.3.0
    860862 *
    861863 * @uses $wpdb
     
    917919 * @package WordPress
    918920 * @subpackage Taxonomy
    919  * @since 2.3
     921 * @since 2.3.0
    920922 *
    921923 * @uses $wpdb
     
    949951 * @package WordPress
    950952 * @subpackage Taxonomy
    951  * @since 2.3
     953 * @since 2.3.0
    952954 * @uses $wpdb
    953955 *
     
    982984 * @package WordPress
    983985 * @subpackage Taxonomy
    984  * @since 2.3
     986 * @since 2.3.0
    985987 *
    986988 * @uses $wpdb
     
    10761078 * @package WordPress
    10771079 * @subpackage Taxonomy
    1078  * @since 2.3
     1080 * @since 2.3.0
    10791081 * @uses $wpdb
    10801082 *
     
    12001202 * @package WordPress
    12011203 * @subpackage Taxonomy
    1202  * @since 2.3
     1204 * @since 2.3.0
    12031205 * @uses $wpdb
    12041206 *
     
    13051307 * @package WordPress
    13061308 * @subpackage Taxonomy
    1307  * @since 2.3
     1309 * @since 2.3.0
    13081310 * @uses $wpdb
    13091311 *
     
    13911393 * @package WordPress
    13921394 * @subpackage Taxonomy
    1393  * @since 2.3
     1395 * @since 2.3.0
    13941396 * @uses $wpdb
    13951397 *
     
    14581460 * @package WordPress
    14591461 * @subpackage Taxonomy
    1460  * @since 2.3
     1462 * @since 2.3.0
    14611463 *
    14621464 * @uses $wpdb
     
    15551557 * Enable or disable term counting.
    15561558 *
    1557  * @since 2.6
    1558  *
    1559  * @param bool $defer Optional.
    1560  * @return bool
    1561  */
    1562 function wp_defer_term_counting($defer=NULL) {
     1559 * @since 2.5.0
     1560 *
     1561 * @param bool $defer Optional. Enable if true, disable if false.
     1562 * @return bool Whether term counting is enabled or disabled.
     1563 */
     1564function wp_defer_term_counting($defer=null) {
    15631565    static $_defer = false;
    15641566
     
    15671569        // flush any deferred counts
    15681570        if ( !$defer )
    1569             wp_update_term_count( NULL, NULL, true );
     1571            wp_update_term_count( null, null, true );
    15701572    }
    15711573
     
    15841586 * @package WordPress
    15851587 * @subpackage Taxonomy
    1586  * @since 2.3
     1588 * @since 2.3.0
    15871589 * @uses $wpdb
    15881590 *
     
    16201622 * Perform term count update immediately.
    16211623 *
    1622  * @since 2.6
     1624 * @since 2.5.0
    16231625 *
    16241626 * @param array $terms IDs of Terms to update.
     
    16621664 * @package WordPress
    16631665 * @subpackage Taxonomy
    1664  * @since 2.3
     1666 * @since 2.3.0
    16651667 *
    16661668 * @see get_object_taxonomies() for more on $object_type
     
    16881690 * @package WordPress
    16891691 * @subpackage Taxonomy
    1690  * @since 2.3
     1692 * @since 2.3.0
    16911693 * @uses $wpdb
    16921694 *
     
    17341736 * @package WordPress
    17351737 * @subpackage Taxonomy
    1736  * @since 2.3
     1738 * @since 2.3.0
    17371739 *
    17381740 * @uses wp_cache_get() Retrieves taxonomy relationship from cache
     
    17631765 * @package WordPress
    17641766 * @subpackage Taxonomy
    1765  * @since 2.3
     1767 * @since 2.3.0
    17661768 * @uses wp_get_object_terms() Used to get terms from the database to update
    17671769 *
     
    18231825 * @package WordPress
    18241826 * @subpackage Taxonomy
    1825  * @since 2.3
     1827 * @since 2.3.0
    18261828 *
    18271829 * @param array $terms List of Term objects to change
     
    18491851 * @subpackage Taxonomy
    18501852 * @access private
    1851  * @since 2.3
     1853 * @since 2.3.0
    18521854 *
    18531855 * @uses update_option() Stores all of the children in "$taxonomy_children"
     
    18861888 * @subpackage Taxonomy
    18871889 * @access private
    1888  * @since 2.3
     1890 * @since 2.3.0
    18891891 *
    18901892 * @param int $term_id Look for this Term ID in $terms
     
    19431945 * @subpackage Taxonomy
    19441946 * @access private
    1945  * @since 2.3
     1947 * @since 2.3.0
    19461948 * @uses $wpdb
    19471949 *
     
    20062008 * @subpackage Taxonomy
    20072009 * @access private
    2008  * @since 2.3
     2010 * @since 2.3.0
    20092011 * @uses $wpdb
    20102012 *
     
    20242026 * Generates a permalink for a taxonomy term archive.
    20252027 *
    2026  * @since 2.6
     2028 * @since 2.5.0
    20272029 *
    20282030 * @param object|int|string $term
     
    20802082 * 'after' : default is empty string. Display this after the taxonomies list.
    20812083 *
    2082  * @since 2.6
     2084 * @since 2.5.0
    20832085 * @uses get_the_taxonomies()
    20842086 *
     
    21052107 * the taxonomies with links to the taxonomy and name.
    21062108 *
    2107  * @since 2.6
     2109 * @since 2.5.0
    21082110 *
    21092111 * @param int $post Optional. Post ID or will use Global Post ID (in loop).
     
    21502152 * Retrieve all taxonomies of a post with just the names.
    21512153 *
    2152  * @since 2.6
     2154 * @since 2.5.0
    21532155 * @uses get_object_taxonomies()
    21542156 *
Note: See TracChangeset for help on using the changeset viewer.