WordPress.org

Make WordPress Core

Changeset 13482


Ignore:
Timestamp:
02/28/2010 03:18:40 AM (10 years ago)
Author:
dd32
Message:

PHPDocs update. Props miqrogroove. See #12422

File:
1 edited

Legend:

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

    r12818 r13482  
    8181
    8282/**
    83  * {@internal Missing Short Description}}
    84  *
    85  * @since unknown
    86  *
    87  * @param unknown_type $cat_ID
    88  * @return unknown
     83 * Deletes one existing category.
     84 *
     85 * @since 2.0.0
     86 *
     87 * @param int $cat_ID
     88 * @return mixed Returns true if completes delete action; false if term doesnt exist; Zero on attempted deletion of default Category; WP_Error object is also a possibility.
    8989 */
    9090function wp_delete_category($cat_ID) {
     
    100100
    101101/**
    102  * {@internal Missing Short Description}}
    103  *
    104  * @since unknown
    105  *
    106  * @param unknown_type $catarr
    107  * @param unknown_type $wp_error
    108  * @return unknown
     102 * Updates an existing Category or creates a new Category.
     103 *
     104 * @since 2.0.0
     105 *
     106 * @param mixed $catarr See defaults below. Set 'cat_ID' to a non-zero value to update an existing category. The 'taxonomy' key was added in 3.0.0.
     107 * @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
     108 * @return int|object The ID number of the new or updated Category on success.  Zero or a WP_Error on failure, depending on param $wp_error.
    109109 */
    110110function wp_insert_category($catarr, $wp_error = false) {
     
    158158
    159159/**
    160  * {@internal Missing Short Description}}
    161  *
    162  * @since unknown
    163  *
    164  * @param unknown_type $catarr
    165  * @return unknown
     160 * Aliases wp_insert_category() with minimal args.
     161 *
     162 * If you want to update only some fields of an existing category, call this
     163 * function with only the new values set inside $catarr.
     164 *
     165 * @since 2.0.0
     166 *
     167 * @param array $catarr The 'cat_ID' value is required.  All other keys are optional.
     168 * @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
    166169 */
    167170function wp_update_category($catarr) {
Note: See TracChangeset for help on using the changeset viewer.