wp_xmlrpc_server::wp_deleteCategory( array $args ): bool|IXR_Error

Deletes a category.

Parameters

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

Return

bool|IXR_Error See wp_delete_term() for return info.

Source

public function wp_deleteCategory( $args ) {
	$this->escape( $args );

	$username    = $args[1];
	$password    = $args[2];
	$category_id = (int) $args[3];

	$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.deleteCategory', $args, $this );

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

	$status = wp_delete_term( $category_id, 'category' );

	if ( true == $status ) {
		/**
		 * Fires after a category has been successfully deleted via XML-RPC.
		 *
		 * @since 3.4.0
		 *
		 * @param int   $category_id ID of the deleted category.
		 * @param array $args        An array of arguments to delete the category.
		 */
		do_action( 'xmlrpc_call_success_wp_deleteCategory', $category_id, $args ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.NotLowercase
	}

	return $status;
}

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.

do_action( ‘xmlrpc_call_success_wp_deleteCategory’, int $category_id, array $args )

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

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

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