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

Delete a term.


Description

Top ↑

See also


Top ↑

Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    Blog ID (unused).
  • usernamestring
    Username.
  • passwordstring
    Password.
  • taxonomy_namestring
    Taxonomy name.
  • term_idint
    Term ID.

Top ↑

Return

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


Top ↑

Source

File: wp-includes/class-wp-xmlrpc-server.php. View all references

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;
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.4.0 Introduced.

Top ↑

User Contributed Notes

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