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

Retrieves a post types


Description

Top ↑

See also


Top ↑

Parameters

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

Top ↑

Return

array|IXR_Error


Top ↑

Source

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

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

	$this->escape( $args );

	$username = $args[1];
	$password = $args[2];
	$filter   = isset( $args[3] ) ? $args[3] : array( 'public' => true );

	if ( isset( $args[4] ) ) {
		$fields = $args[4];
	} else {
		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */
		$fields = apply_filters( 'xmlrpc_default_posttype_fields', array( 'labels', 'cap', 'taxonomies' ), 'wp.getPostTypes' );
	}

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

	$post_types = get_post_types( $filter, 'objects' );

	$struct = array();

	foreach ( $post_types as $post_type ) {
		if ( ! current_user_can( $post_type->cap->edit_posts ) ) {
			continue;
		}

		$struct[ $post_type->name ] = $this->_prepare_post_type( $post_type, $fields );
	}

	return $struct;
}

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.