WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

add_post_type_support()

add_post_type_support( string $post_type, string|array $feature, mixed $args )

In this article

Back to top

Registers support of certain features for a post type.

Description

All core features are directly associated with a functional area of the edit screen, such as the editor or a meta box. Features include: ‘title’, ‘editor’, ‘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, the ‘autosave’ feature dictates whether the post type will be autosaved, and the ‘comments’ feature dictates whether the comments count will show on the edit screen.

A third, optional parameter can also be passed along with a feature to provide additional information about supporting that feature.

Example usage:

add_post_type_support( 'my_post_type', 'comments' );
add_post_type_support( 'my_post_type', array(
    'author', 'excerpt',
) );
add_post_type_support( 'my_post_type', 'my_feature', array(
    'field' => 'value',
) );

Parameters

$post_typestringrequired
The post type for which to add the feature.
$featurestring|arrayrequired
The feature being added, accepts an array of feature strings or a single string.
$argsmixedoptional
Optional extra arguments to pass along with certain features.

More Information

The function should be called using the init action hook, like in the above example.

Multisite

To show the “Featured Image” meta box in mulsite installation, make sure you update the allowed upload file types, in Network Admin, Network Admin Settings SubPanel#Upload_Settings, Media upload buttons options. Default is off.

Source

function add_post_type_support( $post_type, $feature, ...$args ) {
	global $_wp_post_type_features;

	$features = (array) $feature;
	foreach ( $features as $feature ) {
		if ( $args ) {
			$_wp_post_type_features[ $post_type ][ $feature ] = $args;
		} else {
			$_wp_post_type_features[ $post_type ][ $feature ] = true;
		}
	}
}

View all references View on Trac View on GitHub

Used byDescription
_enable_content_editor_for_navigation_post_type()wp-admin/includes/post.php

This callback enables content editor for wp_navigation type posts.

WP_Post_Type::add_supports()wp-includes/class-wp-post-type.php

Sets the features support for the post type.

create_initial_post_types()wp-includes/post.php

Creates the initial post types when ‘init’ action is fired.

Changelog

VersionDescription
5.3.0Formalized the existing and already documented ...$args parameter by adding it to the function signature.
3.0.0Introduced.

User Contributed Notes

  2. Skip to note 7 content
    Marc Heatley
    You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

    Unfortunately,

    add_post_type_support('page', 'thumbnail');

    won’t add featured images to pages. For that you need to [add theme support for post-thumbnails

    add_theme_support( 'post-thumbnails', array( 'post', 'page' ) );

    https://developer.wordpress.org/reference/functions/add_theme_support/#post-thumbnails

  4. Skip to note 9 content
    Darshit Rajyaguru
    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    The example that allows you to add support for specific feature to a custom post type. It’s used to enable or disable certain features, Such as custom fields, excerpts, comments, thumbnails, revisions and more for particular post type.

    add_action( 'init', 'custom_post_type_support' );
function custom_post_type_support() {
    add_post_type_support( 'book', array( 'custom-fields', 'thumbnail' ) );
}
  5. Skip to note 10 content
    Irfan
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    To enable `add_post_type_support` for a specific page or post, we can narrow down with condition.

    Example: To add support for excerpt in page (id : 123), use this:

    global $pagenow;
if( ($pagenow == 'post.php') && (isset($_GET['post'])) ){
    $page_id = 123;   // set the "page id" to enable support
    if($_GET['post'] == $page_id){
        add_post_type_support('page','excerpt');
    }
}

    Note: `$_GET[‘post’]` gives the current page id when we open page edit screen.

You must log in before being able to contribute a note or feedback.