wp_xmlrpc_server::wp_deleteTerm( array $args ): true|IXR_Error

Deletes a term.

Description

See also

Parameters

$argsarrayrequired
Method arguments. Note: arguments must be ordered as documented.
  • int
    Blog ID (unused).
  • 1 string
    Username.
  • 2 string
    Password.
  • 3 string
    Taxonomy name.
  • 4 int
    Term ID.

Return

true|IXR_Error True on success, IXR_Error instance on failure.

Source

public function wp_deleteTerm( $args ) {
	if ( ! $this->minimum_args( $args, 5 ) ) {
		return $this->error;
	}

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$taxonomy = $args[3];
	$term_id  = (int) $args[4];

	$user = $this->login( $username, $password );
	if ( ! $user ) {
		return $this->error;
	}

	/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
	do_action( 'xmlrpc_call', 'wp.deleteTerm', $args, $this );

	if ( ! taxonomy_exists( $taxonomy ) ) {
		return new IXR_Error( 403, __( 'Invalid taxonomy.' ) );
	}

	$taxonomy = get_taxonomy( $taxonomy );
	$term     = get_term( $term_id, $taxonomy->name );

	if ( is_wp_error( $term ) ) {
		return new IXR_Error( 500, $term->get_error_message() );
	}

	if ( ! $term ) {
		return new IXR_Error( 404, __( 'Invalid term ID.' ) );
	}

	if ( ! current_user_can( 'delete_term', $term_id ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to delete this term.' ) );
	}

	$result = wp_delete_term( $term_id, $taxonomy->name );

	if ( is_wp_error( $result ) ) {
		return new IXR_Error( 500, $term->get_error_message() );
	}

	if ( ! $result ) {
		return new IXR_Error( 500, __( 'Sorry, deleting the term failed.' ) );
	}

	return $result;
}

Hooks

do_action( ‘xmlrpc_call’, string $name, array|string $args, wp_xmlrpc_server $server )

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

Changelog

VersionDescription
3.4.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.