wp_xmlrpc_server::wp_getTags( array $args ): array|IXR_Error

In this article

Gets the list of all tags.

Parameters

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

Return

array|IXR_Error

Source

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

	$username = $args[1];
	$password = $args[2];

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

	if ( ! current_user_can( 'edit_posts' ) ) {
		return new IXR_Error( 401, __( 'Sorry, you must be able to edit posts on this site in order to view tags.' ) );
	}

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

	$tags = array();

	$all_tags = get_tags();
	if ( $all_tags ) {
		foreach ( (array) $all_tags as $tag ) {
			$struct             = array();
			$struct['tag_id']   = $tag->term_id;
			$struct['name']     = $tag->name;
			$struct['count']    = $tag->count;
			$struct['slug']     = $tag->slug;
			$struct['html_url'] = esc_html( get_tag_link( $tag->term_id ) );
			$struct['rss_url']  = esc_html( get_tag_feed_link( $tag->term_id ) );

			$tags[] = $struct;
		}
	}

	return $tags;
}

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
2.7.0Introduced.

User Contributed Notes

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