Function Reference/get post type object

来自WordPress中文文档
跳转至: 导航搜索

Description

Retrieves an object which describes any registered post type (i.e. built-in types like 'post' and 'page', or any user-created custom post type).

Usage

%%%<?php get_post_type_object( $post_type ); ?>%%%

Parameters

tt$post_type/tt
(string) (required) The name of the post type as used when registering the post type.
Default: Nonenoinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Notes

This template is for standardizing how parameters look in the Function Reference and in Template Tags. Here is an example of this template being called: prenowiki检查到模板循环:模板:Parameter/nowiki/pre 检查到模板循环:模板:Parameter

The usage of this template is below: prenowiki检查到模板循环:模板:Parameter/nowiki/pre Let's take a closer look at the parameters..

name
The name of the parameter.
datatype
The datatype that should be given for this parameter when called.
  • string
  • integer
  • boolean
  • mixed
description
A short description of the parameter.
importance
Set this parameter to optional if the parameter is optional. Otherwise, do not declare this parameter—it defaults to required.
  • required
  • optional
default
If this parameter is optional, ttdefault/tt is the value that will be used if the parameter is not declared.

wordpress.org.cn /div /noinclude

Return Values

(object) 
on success.

Nothing on failure (e.g. can check for null).

Examples

$obj = get_post_type_object( 'post' );
echo $obj->labels->singular_name;

Technically, this is the same as

global $wp_post_types;
$obj = $wp_post_types['post'];
echo $obj->labels->singular_name; 

print_r( $obj ) might return something like this:

stdClass Object
(
   [labels] => stdClass Object
       (
           [name] => Posts
           [singular_name] => Post
           [add_new] => Add New
           [add_new_item] => Add New Post
           [edit_item] => Edit Post
           [new_item] => New Post
           [view_item] => View Post
           [search_items] => Search Posts
           [not_found] => No posts found
           [not_found_in_trash] => No posts found in Trash
           [parent_item_colon] => 
       )

   [description] => 
   [publicly_queryable] => 1
   [exclude_from_search] => 
   [_builtin] => 1
   [_edit_link] => post.php?post=%d
   [capability_type] => post
   [hierarchical] => 
   [public] => 1
   [rewrite] => 
   [query_var] => 
   [register_meta_box_cb] => 
   [taxonomies] => Array
       (
       )

   [show_ui] => 1
   [menu_position] => 
   [menu_icon] => 
   [permalink_epmask] => 1
   [can_export] => 1
   [show_in_nav_menus] => 1
   [name] => post
   [cap] => stdClass Object
       (
           [edit_post] => edit_post
           [edit_posts] => edit_posts
           [edit_others_posts] => edit_others_posts
           [publish_posts] => publish_posts
           [read_post] => read_post
           [read_private_posts] => read_private_posts
           [delete_post] => delete_post
       )

   [label] => Posts
)

Note that the object's attribute names are slightly different than the arguments expected for the register_post_type() function.

Change Log

Source File

get_post_type_object() is located in onlyincludecodewp-includes/post.php/code/onlyinclude

div class=template-description style=padding: 0 1.5em; border: 1px solid #eeeeee; background-color: #f9f9f9

Template Description

Link to the source code on http://core.trac.wordpress.org/browser/.

Parameters

  1. filename
  2. (option) path to codetag/code (version) or codetrunk/code. This option is only used for a new function.br /Default: codetrunk/code -- trunk is the latest bleeding edge development version of WordPress.

Usage

Link to the stable version: pre检查到模板循环:模板:Trac/pre

Link to trunk: pre检查到模板循环:模板:Trac/pre

/div

wordpress.org.cn.

Related

Post Types: register_post_type, add_post_type_support, remove_post_type_support, post_type_supports, set_post_type, is_post_type_hierarchical, post_type_exists, get_post_type, get_post_type_object, get_post_types, get_post_type_capabilities, get_post_type_labels

includeonlydiv style=clear:both; background-color:#F7F7F7; border:1px solid #CCCCCC; color:#000000; padding:7px; margin:0.5em auto 0.5em auto; vertical-align:middle;See also index of Function Reference and index of Template Tags./div/includeonlynoinclude

Description

This Template is used by Codex:Template Messages.

Usage

pre 检查到模板循环:模板:Message /pre

Result

检查到模板循环:模板:Message

/noinclude