wp_xmlrpc_server::wp_newCategory( array $args ): int|IXR_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0int

  Blog ID (unused).

• $1string

  Username.

• $2string

  Password.

• $3array

  Category.

Return value

int|IXR_Error

Category ID.

Performance profile

How much work a call to wp_xmlrpc_server::wp_newCategory() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

15–66

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 95.

Plugin surface

2 hooks

Third-party callbacks on 'xmlrpc_call', 'xmlrpc_call_success_wp_newCategory' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 6 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::wp_newCategory() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while wp_xmlrpc_server::wp_newCategory() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 3423 (+13 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

2. 2
   do_action( xmlrpc_call_success_wp_newCategory )actionline 3477 (+67 into the body)

   Fires after a new category has been successfully created via XML-RPC.

Uses · 8

• do_action()Calls the callback functions that have been added to an action hook.
• current_user_can()Returns whether the current user has the specified capability.
• __()Retrieves the translation of $text.
• wp_insert_category()Updates an existing Category or creates a new Category.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_xmlrpc_server::escape()Escapes string or array of strings for database.
• wp_xmlrpc_server::login()Logs user in.
• IXR_Error::__construct()PHP5 constructor.

Source code

View on Trac ↗View on GitHub ↗

3410	public function wp_newCategory( $args ) {3411		$this->escape( $args );3412 3413		$username = $args[1];3414		$password = $args[2];3415		$category = $args[3];3416 3417		$user = $this->login( $username, $password );3418		if ( ! $user ) {3419			return $this->error;3420		}3421 3422		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */3423		do_action( 'xmlrpc_call', 'wp.newCategory', $args, $this );3424 3425		// Make sure the user is allowed to add a category.3426		if ( ! current_user_can( 'manage_categories' ) ) {3427			return new IXR_Error( 401, __( 'Sorry, you are not allowed to add a category.' ) );3428		}3429 3430		/*3431		 * If no slug was provided, make it empty3432		 * so that WordPress will generate one.3433		 */3434		if ( empty( $category['slug'] ) ) {3435			$category['slug'] = '';3436		}3437 3438		/*3439		 * If no parent_id was provided, make it empty3440		 * so that it will be a top-level page (no parent).3441		 */3442		if ( ! isset( $category['parent_id'] ) ) {3443			$category['parent_id'] = '';3444		}3445 3446		// If no description was provided, make it empty.3447		if ( empty( $category['description'] ) ) {3448			$category['description'] = '';3449		}3450 3451		$new_category = array(3452			'cat_name'             => $category['name'],3453			'category_nicename'    => $category['slug'],3454			'category_parent'      => $category['parent_id'],3455			'category_description' => $category['description'],3456		);3457 3458		$cat_id = wp_insert_category( $new_category, true );3459		if ( is_wp_error( $cat_id ) ) {3460			if ( 'term_exists' === $cat_id->get_error_code() ) {3461				return (int) $cat_id->get_error_data();3462			} else {3463				return new IXR_Error( 500, __( 'Sorry, the category could not be created.' ) );3464			}3465		} elseif ( ! $cat_id ) {3466			return new IXR_Error( 500, __( 'Sorry, the category could not be created.' ) );3467		}3468 3469		/**3470		 * Fires after a new category has been successfully created via XML-RPC.3471		 *3472		 * @since 3.4.03473		 *3474		 * @param int   $cat_id ID of the new category.3475		 * @param array $args   An array of new category arguments.3476		 */3477		do_action( 'xmlrpc_call_success_wp_newCategory', $cat_id, $args ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase3478 3479		return $cat_id;3480	}

Changelog

Introduced in 2.2.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.