Changeset 35889

Timestamp:

12/12/2015 04:26:42 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Document the optional $args parameter in wp_delete_term() in the hash notation style.

Props slushman, swissspidy.
Fixes #34862.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -2057 +2057 @@
  * Metadata associated with the term will be deleted.
  *
- * The `$args` 'default' will only override the terms found, if there is only one
- * term found. Any other and the found terms are used.
- *
- * The $args 'force_default' will force the term supplied as default to be
- * assigned even if the object was not going to be termless
- *
- * @todo Document $args as a hash notation.
- *
  * @since 2.3.0
  *
@@ -2071 +2063 @@
  * @param int          $term     Term ID.
  * @param string       $taxonomy Taxonomy Name.
- * @param array|string $args     Optional. Change 'default' term id and override found term ids.
- * @return bool|int|WP_Error Returns false if not term; true if completes delete action.
+ * @param array|string $args {
+ *     Optional. Array of arguments to override the default term ID. Default empty array.
+ *
+ *     @type int  $default       The term ID to make the default term. This will only override
+ *                               the terms found if there is only one term found. Any other and
+ *                               the found terms are used.
+ *     @type bool $force_default Optional. Whether to force the supplied term as default to be
+ *                               assigned even if the object was not going to be term-less.
+ *                               Default false.
+ * }
+ * @return bool|int|WP_Error True on success, false if term does not exist. Zero on attempted
+ *                           deletion of default Category. WP_Error if the taxonomy does not exist.
  */
 function wp_delete_term( $term, $taxonomy, $args = array() ) {