Changeset 46232 for trunk/src/wp-includes/taxonomy.php

Timestamp:

09/21/2019 05:40:58 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Docblock corrections and improvements, mostly related to various pre_* filters.

See #47110

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -1359 +1359 @@
  *
  * @param int|string $term     The term to check. Accepts term ID, slug, or name.
- * @param string     $taxonomy The taxonomy name to use
+ * @param string     $taxonomy Optional. The taxonomy name to use.
  * @param int        $parent   Optional. ID of parent term under which to confine the exists search.
  * @return mixed Returns null if the term does not exist. Returns the term ID
@@ -2098 +2098 @@
  * @since 2.3.0
  *
- * @param string       $term     The term to add or update.
+ * @param string       $term     The term name to add or update.
  * @param string       $taxonomy The taxonomy to which to add the term.
  * @param array|string $args {
@@ -2118 +2118 @@
         return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
     }
+
     /**
      * Filters a term before it is sanitized and inserted into the database.
@@ -2123 +2124 @@
      * @since 3.0.0
      *
-     * @param string $term     The term to add or update.
-     * @param string $taxonomy Taxonomy slug.
+     * @param string|WP_Error $term     The term name to add or update, or a WP_Error object if there's an error.
+     * @param string          $taxonomy Taxonomy slug.
      */
     $term = apply_filters( 'pre_insert_term', $term, $taxonomy );