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

Creates a new 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 array
    Content struct for adding a new term. The struct must contain the term 'name' and 'taxonomy'. Optional accepted values include 'parent', 'description', and 'slug'.

Return

int|IXR_Error The term ID on success, or an IXR_Error object on failure.

Source

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

	$this->escape( $args );

	$username       = $args[1];
	$password       = $args[2];
	$content_struct = $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.newTerm', $args, $this );

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

	$taxonomy = get_taxonomy( $content_struct['taxonomy'] );

	if ( ! current_user_can( $taxonomy->cap->edit_terms ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to create terms in this taxonomy.' ) );
	}

	$taxonomy = (array) $taxonomy;

	// Hold the data of the term.
	$term_data = array();

	$term_data['name'] = trim( $content_struct['name'] );
	if ( empty( $term_data['name'] ) ) {
		return new IXR_Error( 403, __( 'The term name cannot be empty.' ) );
	}

	if ( isset( $content_struct['parent'] ) ) {
		if ( ! $taxonomy['hierarchical'] ) {
			return new IXR_Error( 403, __( 'This taxonomy is not hierarchical.' ) );
		}

		$parent_term_id = (int) $content_struct['parent'];
		$parent_term    = get_term( $parent_term_id, $taxonomy['name'] );

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

		if ( ! $parent_term ) {
			return new IXR_Error( 403, __( 'Parent term does not exist.' ) );
		}

		$term_data['parent'] = $content_struct['parent'];
	}

	if ( isset( $content_struct['description'] ) ) {
		$term_data['description'] = $content_struct['description'];
	}

	if ( isset( $content_struct['slug'] ) ) {
		$term_data['slug'] = $content_struct['slug'];
	}

	$term = wp_insert_term( $term_data['name'], $taxonomy['name'], $term_data );

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

	if ( ! $term ) {
		return new IXR_Error( 500, __( 'Sorry, the term could not be created.' ) );
	}

	// Add term meta.
	if ( isset( $content_struct['custom_fields'] ) ) {
		$this->set_term_custom_fields( $term['term_id'], $content_struct['custom_fields'] );
	}

	return (string) $term['term_id'];
}

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.