wp_xmlrpc_server::wp_editTerm( array $args ): true|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.

• $3int

  Term ID.

• $4array

  Content struct for editing a term. The struct must contain the term 'taxonomy'. Optional accepted values include 'name', 'parent', 'description', and 'slug'.

Return value

true|IXR_Error

True on success, IXR_Error instance on failure.

Performance profile

How much work a call to wp_xmlrpc_server::wp_editTerm() 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

Heavy

Reaches the database via get_term().

Scaling

Constant

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

Instructions

8–120

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

Plugin surface

1 hook

Third-party callbacks on 'xmlrpc_call' 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
• querycontent queryget_term()called directly

Further down the call graph this can also reach 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 · 16 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_xmlrpc_server::wp_editTerm() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 2197 (+18 into the body)

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

Uses · 13

• do_action()Calls the callback functions that have been added to an action hook.
• taxonomy_exists()Determines whether the taxonomy name exists.
• __()Retrieves the translation of $text.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• get_term()Gets all term data from database by term ID.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• current_user_can()Returns whether the current user has the specified capability.
• wp_update_term()Updates term based on arguments provided.
• wp_xmlrpc_server::minimum_args()Checks if the method received at least the minimum number of arguments.
• 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 ↗

2179	public function wp_editTerm( $args ) {2180		if ( ! $this->minimum_args( $args, 5 ) ) {2181			return $this->error;2182		}2183 2184		$this->escape( $args );2185 2186		$username       = $args[1];2187		$password       = $args[2];2188		$term_id        = (int) $args[3];2189		$content_struct = $args[4];2190 2191		$user = $this->login( $username, $password );2192		if ( ! $user ) {2193			return $this->error;2194		}2195 2196		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */2197		do_action( 'xmlrpc_call', 'wp.editTerm', $args, $this );2198 2199		if ( ! taxonomy_exists( $content_struct['taxonomy'] ) ) {2200			return new IXR_Error( 403, __( 'Invalid taxonomy.' ) );2201		}2202 2203		$taxonomy = get_taxonomy( $content_struct['taxonomy'] );2204 2205		$taxonomy = (array) $taxonomy;2206 2207		// Hold the data of the term.2208		$term_data = array();2209 2210		$term = get_term( $term_id, $content_struct['taxonomy'] );2211 2212		if ( is_wp_error( $term ) ) {2213			return new IXR_Error( 500, $term->get_error_message() );2214		}2215 2216		if ( ! $term ) {2217			return new IXR_Error( 404, __( 'Invalid term ID.' ) );2218		}2219 2220		if ( ! current_user_can( 'edit_term', $term_id ) ) {2221			return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit this term.' ) );2222		}2223 2224		if ( isset( $content_struct['name'] ) ) {2225			$term_data['name'] = trim( $content_struct['name'] );2226 2227			if ( empty( $term_data['name'] ) ) {2228				return new IXR_Error( 403, __( 'The term name cannot be empty.' ) );2229			}2230		}2231 2232		if ( ! empty( $content_struct['parent'] ) ) {2233			if ( ! $taxonomy['hierarchical'] ) {2234				return new IXR_Error( 403, __( 'Cannot set parent term, taxonomy is not hierarchical.' ) );2235			}2236 2237			$parent_term_id = (int) $content_struct['parent'];2238			$parent_term    = get_term( $parent_term_id, $taxonomy['name'] );2239 2240			if ( is_wp_error( $parent_term ) ) {2241				return new IXR_Error( 500, $parent_term->get_error_message() );2242			}2243 2244			if ( ! $parent_term ) {2245				return new IXR_Error( 403, __( 'Parent term does not exist.' ) );2246			}2247 2248			$term_data['parent'] = $content_struct['parent'];2249		}2250 2251		if ( isset( $content_struct['description'] ) ) {2252			$term_data['description'] = $content_struct['description'];2253		}2254 2255		if ( isset( $content_struct['slug'] ) ) {2256			$term_data['slug'] = $content_struct['slug'];2257		}2258

Changelog

Introduced in 3.4.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.7.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.