add_post_type_support()

You are here:
  • Help
  • add_post_type_support()

add_post_type_support( string $post_typestring|array $featuremixed $args )

Registers support of certain features for a post type.

Description 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 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 More Information

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

 

Multisite 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 Source

File: wp-includes/post.php

1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
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

Changelog
Version Description
5.3.0 Formalized the existing and already documented ...$args parameter by adding it to the function signature.
3.0.0 Introduced.
Was this article helpful?
Dislike 0
Views: 10