Improve inline documentation for `add_post_type_support()`.

Props philiparthurmoore.
Fixes #26683.

Built from https://develop.svn.wordpress.org/trunk@26911


git-svn-id: http://core.svn.wordpress.org/trunk@26792 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-01-07 02:05:11 +00:00
parent f51b1f8def
commit edce7b88b5
1 changed files with 11 additions and 7 deletions

View File

@ -1555,16 +1555,20 @@ add_action( 'admin_menu', '_add_post_type_submenus' );
/** /**
* Register support of certain features for a post type. * Register support of certain features for a post type.
* *
* All features are directly associated with a functional area of the edit screen, such as the * All core features are directly associated with a functional area of the edit
* editor or a meta box: 'title', 'editor', 'comments', 'revisions', 'trackbacks', 'author', * screen, such as the editor or a meta box. Features include: 'title', 'editor',
* 'excerpt', 'page-attributes', 'thumbnail', and 'custom-fields'. * 'comments', 'revisions', 'trackbacks', 'author', 'excerpt', 'page-attributes',
* 'thumbnail', 'custom-fields', and 'post-formats'.
* *
* Additionally, the 'revisions' feature dictates whether the post type will store revisions, * Additionally, the 'revisions' feature dictates whether the post type will
* and the 'comments' feature dictates whether the comments count will show on the edit screen. * store revisions, and the 'comments' feature dictates whether the comments
* count will show on the edit screen.
* *
* @since 3.0.0 * @since 3.0.0
* @param string $post_type The post type for which to add the feature *
* @param string|array $feature the feature being added, can be an array of feature strings or a single string * @param string $post_type The post type for which to add the feature.
* @param string|array $feature The feature being added, accpets an array of
* feature strings or a single string.
*/ */
function add_post_type_support( $post_type, $feature ) { function add_post_type_support( $post_type, $feature ) {
global $_wp_post_type_features; global $_wp_post_type_features;