Changeset 54266

Timestamp:

09/20/2022 06:51:49 PM (4 years ago)

Author:

johnbillion

Message:

Taxonomy: Standardise the format used to describe arguments passed to actions and filters inside wp_insert_term() and wp_update_term().

Props SergeyBiryukov, mboynes

Fixes #55441

File:

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

trunk/src/wp-includes/taxonomy.php

@@ -2348 +2348 @@
          * @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.
-         * @param array|string    $args     Array or query string of arguments for inserting a term.
+         * @param array|string    $args     Array or query string of arguments passed to wp_insert_term().
          */
         $term = apply_filters( 'pre_insert_term', $term, $taxonomy, $args );
@@ -2548 +2548 @@
          * @param string $term           Term being inserted.
          * @param string $taxonomy       Taxonomy name.
-         * @param array  $args           Term arguments passed to the function.
+         * @param array  $args           Arguments passed to wp_insert_term().
          * @param int    $tt_id          term_taxonomy_id for the newly created term.
          */
@@ -2579 +2579 @@
          * @param int    $tt_id    Term taxonomy ID.
          * @param string $taxonomy Taxonomy slug.
-         * @param array  $args     Term arguments passed to the function.
+         * @param array  $args     Arguments passed to wp_insert_term().
          */
         do_action( 'create_term', $term_id, $tt_id, $taxonomy, $args );
@@ -2599 +2599 @@
          * @param int   $term_id Term ID.
          * @param int   $tt_id   Term taxonomy ID.
-         * @param array $args    Term arguments passed to the function.
+         * @param array $args    Arguments passed to wp_insert_term().
          */
         do_action( "create_{$taxonomy}", $term_id, $tt_id, $args );
@@ -2611 +2611 @@
          * @param int   $term_id Term ID.
          * @param int   $tt_id   Term taxonomy ID.
-         * @param array $args    Term arguments passed to the function.
+         * @param array $args    Arguments passed to wp_insert_term().
          */
         $term_id = apply_filters( 'term_id_filter', $term_id, $tt_id, $args );
@@ -2629 +2629 @@
          * @param int    $tt_id    Term taxonomy ID.
          * @param string $taxonomy Taxonomy slug.
-         * @param array  $args     Term arguments passed to the function.
+         * @param array  $args     Arguments passed to wp_insert_term().
          */
         do_action( 'created_term', $term_id, $tt_id, $taxonomy, $args );
@@ -2649 +2649 @@
          * @param int   $term_id Term ID.
          * @param int   $tt_id   Term taxonomy ID.
-         * @param array $args    Term arguments passed to the function.
+         * @param array $args    Arguments passed to wp_insert_term().
          */
         do_action( "created_{$taxonomy}", $term_id, $tt_id, $args );
@@ -2666 +2666 @@
          * @param string $taxonomy Taxonomy slug.
          * @param bool   $update   Whether this is an existing term being updated.
-         * @param array  $args     Term arguments passed to the function.
+         * @param array  $args     Arguments passed to wp_insert_term().
          */
         do_action( 'saved_term', $term_id, $tt_id, $taxonomy, false, $args );
@@ -2687 +2687 @@
          * @param int   $tt_id   Term taxonomy ID.
          * @param bool  $update  Whether this is an existing term being updated.
-         * @param array $args    Term arguments passed to the function.
+         * @param array $args    Arguments passed to wp_insert_term().
          */
         do_action( "saved_{$taxonomy}", $term_id, $tt_id, false, $args );
@@ -3219 +3219 @@
          * @param string $taxonomy    Taxonomy slug.
          * @param array  $parsed_args An array of potentially altered update arguments for the given term.
-         * @param array  $args        An array of update arguments for the given term.
+         * @param array  $args        Arguments passed to wp_update_term().
          */
         $parent = (int) apply_filters( 'wp_update_term_parent', $args['parent'], $term_id, $taxonomy, $parsed_args, $args );