wp_xmlrpc_server::wp_getPostFormats() │ public │ WP 3.1.0

Retrieves a list of post formats used by the site.

Method of the class: wp_xmlrpc_server{}

Return

Array|IXR_Error. List of post formats, otherwise IXR_Error object.

Usage

$wp_xmlrpc_server = new wp_xmlrpc_server();
$wp_xmlrpc_server->wp_getPostFormats( $args );

$args(array) (required)

Method arguments. Note: arguments must be ordered as documented.

• 0(int)
  Blog ID (unused).

• 1(string)
  Username.

• 2(string)
  Password.

Changelog

wp_xmlrpc_server::wp_getPostFormats() wp xmlrpc server::wp getPostFormats code ^{WP 6.5.2}

public function wp_getPostFormats( $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( 403, __( 'Sorry, you are not allowed to access details about this site.' ) );
	}

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

	$formats = get_post_format_strings();

	// Find out if they want a list of currently supports formats.
	if ( isset( $args[3] ) && is_array( $args[3] ) ) {
		if ( $args[3]['show-supported'] ) {
			if ( current_theme_supports( 'post-formats' ) ) {
				$supported = get_theme_support( 'post-formats' );

				$data              = array();
				$data['all']       = $formats;
				$data['supported'] = $supported[0];

				$formats = $data;
			}
		}
	}

	return $formats;
}