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.

git-svn-id: https://develop.svn.wordpress.org/trunk@48600 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov 2020-07-24 12:17:54 +00:00
parent fc1e77f42b
commit 9bd4234bf6

View File

@ -2158,7 +2158,7 @@ function wp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
* *
* @since 2.3.0 * @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 string $taxonomy The taxonomy to which to add the term.
* @param array|string $args { * @param array|string $args {
* Optional. Array or string of arguments for inserting a term. * Optional. Array or string of arguments for inserting a term.
@ -2184,19 +2184,23 @@ function wp_insert_term( $term, $taxonomy, $args = array() ) {
* *
* @since 3.0.0 * @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. * @param string $taxonomy Taxonomy slug.
*/ */
$term = apply_filters( 'pre_insert_term', $term, $taxonomy ); $term = apply_filters( 'pre_insert_term', $term, $taxonomy );
if ( is_wp_error( $term ) ) { if ( is_wp_error( $term ) ) {
return $term; return $term;
} }
if ( is_int( $term ) && 0 === $term ) { if ( is_int( $term ) && 0 === $term ) {
return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) ); return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) );
} }
if ( '' === trim( $term ) ) { if ( '' === trim( $term ) ) {
return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) ); return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
} }
$defaults = array( $defaults = array(
'alias_of' => '', 'alias_of' => '',
'description' => '', 'description' => '',