wp_xmlrpc_server::wp_getPostType() WordPress Method

The wp_xmlrpc_server::wp_getPostType() method is used to get the post type for a given post. This is useful for retrieving the post type for a post that does not have a specific post type assigned to it.

wp_xmlrpc_server::wp_getPostType( array $args ) #

Retrieves a post type


Description

Top ↑

See also


Top ↑

Parameters

$args

(array)(Required)Method arguments. Note: arguments must be ordered as documented.

  • 'blog_id'
    (int) (unused)
  • 'username'
    (string)
  • 'password'
    (string)
  • 'post_type_name'
    (string)
  • 'fields'
    (array) (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

4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
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 ↑

Changelog

Changelog
VersionDescription
3.4.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More