W3cubDocs

/WordPress

wp_update_category( array $catarr )

Aliases wp_insert_category() with minimal args.

Description

If you want to update only some fields of an existing category, call this function with only the new values set inside $catarr.

Parameters

$catarr

(array) (Required) The 'cat_ID' value is required. All other keys are optional.

Return

(int|bool) The ID number of the new or updated Category on success. Zero or FALSE on failure.

Source

File: wp-admin/includes/taxonomy.php 

function wp_update_category( $catarr ) {
	$cat_ID = (int) $catarr['cat_ID'];

	if ( isset( $catarr['category_parent'] ) && ( $cat_ID == $catarr['category_parent'] ) ) {
		return false;
	}

	// First, get all of the original fields.
	$category = get_term( $cat_ID, 'category', ARRAY_A );
	_make_cat_compat( $category );

	// Escape data pulled from DB.
	$category = wp_slash( $category );

	// Merge old and new fields with new fields overwriting old ones.
	$catarr = array_merge( $category, $catarr );

	return wp_insert_category( $catarr );
}

Uses

Uses Description
wp-admin/includes/taxonomy.php: wp_insert_category()

Updates an existing Category or creates a new Category.
wp-includes/formatting.php: wp_slash()

Add slashes to a string or array of strings, in a recursive manner.
wp-includes/category.php: _make_cat_compat()

Updates category structure to old pre-2.3 from new taxonomy structure.
wp-includes/taxonomy.php: get_term()

Get all Term data from database by Term ID.

Changelog

Version Description
2.0.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_update_category