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

Retrieves a list of post formats used by the site.


Parameters

$args array Required
Method arguments. Note: arguments must be ordered as documented.
  • blog_idint
    (unused)
  • usernamestring
  • passwordstring

Top ↑

Return

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


Top ↑

Source

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

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

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.1.0 Introduced.

Top ↑

User Contributed Notes

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