WP REST API从帖子类型中获取帖子

时间:2015-09-04 08:53:50

标签: php wordpress custom-post-type json-api wordpress-rest-api

如何使用WP REST API(v1或v2)获取特定自定义帖子类型的所有帖子?我对此非常陌生,并试图了解如何做到这一点。

我目前正在使用WP REST API v2并设法使用此

获取所有帖子类型的列表
http://domain.com/wp-json/wp/v2/types

然后设法获得我对

感兴趣的帖子类型
http://domain.com/wp-json/wp/v2/types/the-icons-update

如何从特定内容类型中获取所有帖子?

我试过

http://domain.com/wp-json/wp/v2/posts?filter[post_type]=the-icons-update

但它返回一个空数组(我想它会返回默认帖子,在我的网站上只有我试图检索的自定义帖子类型中的帖子。)

我是如何注册帖子类型的?

function custom_post_type() {
$labels = array(
    'name'               => _x( 'The Icons Update', 'post type general name' ),
    'singular_name'      => _x( 'The Icons Update', 'post type singular name' ),
    'add_new'            => _x( 'Add Page', 'magazine' ),
    'add_new_item'       => __( 'Add New Page' ),
    'edit_item'          => __( 'Edit Page' ),
    'new_item'           => __( 'New Page' ),
    'all_items'          => __( 'All Pages' ),
    'view_item'          => __( 'View Page' ),
    'search_items'       => __( 'Search Pages' ),
    'not_found'          => __( 'No Page found' ),
    'not_found_in_trash' => __( 'No Page found in the Trash' ), 
    'parent_item_colon'  => '',
    'menu_icon'          => '',
    'menu_name'          => 'The Icons Update'
);
$args = array(
    'labels'        => $labels,
    'description'   => 'Holds our projects and project specific data',
    'public'        => true,
    'menu_position' => 5,
    'supports'      => array( 'title', 'editor', 'thumbnail', 'excerpt', 'custom-fields' ),
    'has_archive'   => true,
    'taxonomies'    => array('post_tag', 'category'),
    'hierarchical'  => false,
    'query_var'     => true,
    'queryable' => true,
        'searchable'    => true,
    'rewrite'       => array( 'slug' => 'the-icons-update' )
);
register_post_type( 'magazine', $args );
flush_rewrite_rules();
}
add_action( 'init', 'custom_post_type' );

非常感谢任何帮助。

4 个答案:

答案 0 :(得分:5)

对于v.2,有一个非常轻松的方法。您所要做的就是在args数组中包含以下属性:'show_in_rest' => true

示例:

register_post_type( 'recipe',
     array(
          'labels' => $labels,
          'public' => true,
          'menu_position' => 5,
          'hierarchical' => false,
          'supports' => $supports,
          'show_in_rest' => true,
          'taxonomies' => array('recipe-type', 'post_tag'),
          'rewrite' => array( 'slug' => __('recipe', 'recipe') )
     )
);

答案 1 :(得分:3)

使用REST API插件的v2:

在主题的 functions.php 文件中,添加以下内容以创建休息端点:

add_action( 'init', 'add_myCustomPostType_endpoint');
function add_myCustomPostType_endpoint(){

    global $wp_post_types;
    $wp_post_types['myCustomPostType']->show_in_rest = true;
    $wp_post_types['myCustomPostType']->rest_base = 'myCustomPostType';
    $wp_post_types['myCustomPostType']->rest_controller_class = 'WP_REST_Posts_Controller';
}

现在您应该从以下位置查询以下端点:

/wp-json/wp/v2/myCustomPostType

myCustomPostType 是您注册的自定义帖子类型。 " rest_base"不必匹配自定义帖子类型的名称。

您很可能希望添加特定于自定义帖子类型的其他字段,例如帖子元数据或可能来自Advanced Custom Fields插件。对于这些情况,您可以通过在 functions.php 文件中添加这样的代码段来包含这些属性:

function add_myCustomPostType_fields_url_to_myCustomPostType_request( $data, $post, $request ) {
    $_data = $data->data;

    $customImageProperty = get_field('customImageProperty'); 

    $_data['customImageProperty'] = $customImageProperty['url'];

    $data->data = $_data;
    return $data;
}
add_filter( 'rest_prepare_myCustomPostType', 'add_myCustomPostType_fields_url_to_myCustomPostType_request', 10, 3 );

答案 2 :(得分:2)

register_post_type('帖子类型的名称'...)而不是'add_new'名称。 将您的帖子类型的名称更改为杂志并签出结果。希望它有所帮助。

答案 3 :(得分:2)

通过恢复到REST API插件的v1并使用/wp-json/posts?type=name-of-post-type,我设法从该特定帖子类型中检索帖子。