Changeset 48600

Timestamp:

07/24/2020 12:17:54 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct documentation for wp_insert_term().

The function is used for adding a new term, not updating an existing one.

Props audrasjb, bmartinent.
Fixes #50753.

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -2159 +2159 @@
  * @since 2.3.0
  *
- * @param string       $term     The term name to add or update.
+ * @param string       $term     The term name to add.
  * @param string       $taxonomy The taxonomy to which to add the term.
  * @param array|string $args {
@@ -2185 +2185 @@
          * @since 3.0.0
          *
-         * @param string|WP_Error $term     The term name to add or update, or a WP_Error object if there's an error.
+         * @param string|WP_Error $term     The term name to add, or a WP_Error object if there's an error.
          * @param string          $taxonomy Taxonomy slug.
          */
         $term = apply_filters( 'pre_insert_term', $term, $taxonomy );
+
         if ( is_wp_error( $term ) ) {
                 return $term;
         }
+
         if ( is_int( $term ) && 0 === $term ) {
                 return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) );
         }
+
         if ( '' === trim( $term ) ) {
                 return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
         }
+
         $defaults = array(
                 'alias_of'    => '',