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

Retrieves a post type


Description

Top ↑

See also


Top ↑

Parameters

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

Top ↑

Return

array|IXR_Error Array contains:

  • 'labels'
  • 'description'
  • 'capability_type'
  • 'cap'
  • 'map_meta_cap'
  • 'hierarchical'
  • 'menu_position'
  • 'taxonomies'
  • 'supports'


Top ↑

Source

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

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

	$this->escape( $args );

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

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/**
		 * Filters the default query fields used by the given XML-RPC method.
		 *
		 * @since 3.4.0
		 *
		 * @param array  $fields An array of post type query fields for the given method.
		 * @param string $method The method name.
		 */
		$fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostType' );
	}

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

	if ( ! post_type_exists( $post_type_name ) ) {
		return new IXR_Error( 403, __( 'Invalid post type.' ) );
	}

	$post_type = get_post_type_object( $post_type_name );

	if ( ! current_user_can( $post_type->cap->edit_posts ) ) {
		return new IXR_Error( 401, __( 'Sorry, you are not allowed to edit posts in this post type.' ) );
	}

	return $this->_prepare_post_type( $post_type, $fields );
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
3.4.0 Introduced.

Top ↑

User Contributed Notes

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