add_post_type_support() WordPress Function

The add_post_type_support() function enables support for a given feature on a specific post type. This function should be called after the post type has been registered. For example, to add support for the 'title' and 'editor' features to the 'post' post type, you would use the following: add_post_type_support( 'post', 'title' ); add_post_type_support( 'post', 'editor' );

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

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, 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',
) );

Top ↑

Parameters

$post_type

(string)(Required)The post type for which to add the feature.

$feature

(string|array)(Required)The feature being added, accepts an array of feature strings or a single string.

$args

(mixed)(Optional)extra arguments to pass along with certain features.


Top ↑

More Information

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

 

Top ↑

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.


Top ↑

Source

File: wp-includes/post.php

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;
		}
	}
}


Top ↑

Changelog

Changelog
VersionDescription
5.3.0Formalized the existing and already documented ...$args parameter by adding it to the function signature.
3.0.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