Changeset 13482 for trunk/wp-admin/includes/taxonomy.php

Timestamp:

02/28/2010 03:18:40 AM (15 years ago)

Author:

dd32

Message:

PHPDocs update. Props miqrogroove. See #12422

File:

• trunk/wp-admin/includes/taxonomy.php (modified) (3 diffs)

trunk/wp-admin/includes/taxonomy.php

@@ -81 +81 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $cat_ID
- * @return unknown
+ * Deletes one existing category.
+ *
+ * @since 2.0.0
+ *
+ * @param int $cat_ID
+ * @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.
  */
 function wp_delete_category($cat_ID) {
@@ -100 +100 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $catarr
- * @param unknown_type $wp_error
- * @return unknown
+ * Updates an existing Category or creates a new Category.
+ *
+ * @since 2.0.0
+ *
+ * @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.
+ * @param bool $wp_error Optional, since 2.5.0. Set this to true if the caller handles WP_Error return values.
+ * @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.
  */
 function wp_insert_category($catarr, $wp_error = false) {
@@ -158 +158 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $catarr
- * @return unknown
+ * Aliases wp_insert_category() with minimal args.
+ *
+ * If you want to update only some fields of an existing category, call this
+ * function with only the new values set inside $catarr.
+ *
+ * @since 2.0.0
+ *
+ * @param array $catarr The 'cat_ID' value is required.  All other keys are optional.
+ * @return int|bool The ID number of the new or updated Category on success. Zero or FALSE on failure.
  */
 function wp_update_category($catarr) {