Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

get_post_type_labels( object $post_type_object )

Build an object with all post type labels out of a post type object


Description Description

Accepted keys of the label array in the post type object:

  • name – general name for the post type, usually plural. The same and overridden
     by $post_type_object->label. Default is Posts/Pages
  • singular_name – name for one object of this post type. Default is Post/Page
  • add_new – Default is Add New for both hierarchical and non-hierarchical types.
        When internationalizing this string, please use a gettext context
        https://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context
        matching your post type. Example: `_x( 'Add New', 'product' );`.
  • add_new_item – Default is Add New Post/Add New Page.
  • edit_item – Default is Edit Post/Edit Page.
  • new_item – Default is New Post/New Page.
  • view_item – Default is View Post/View Page.
  • search_items – Default is Search Posts/Search Pages.
  • not_found – Default is No posts found/No pages found.
  • not_found_in_trash – Default is No posts found in Trash/No pages found in Trash.
  • parent_item_colon – This string isn’t used on non-hierarchical types. In hierarchical ones the default is ‘Parent Page:’.
  • all_items – String for the submenu. Default is All Posts/All Pages.
  • archives – String for use with archives in nav menus. Default is Post Archives/Page Archives.
  • insert_into_item – String for the media frame button. Default is Insert into post/Insert into page.
  • uploaded_to_this_item – String for the media frame filter. Default is Uploaded to this post/Uploaded to this page.
  • featured_image – Default is Featured Image.
  • set_featured_image – Default is Set featured image.
  • remove_featured_image – Default is Remove featured image.
  • use_featured_image – Default is Use as featured image.
  • menu_name – Default is the same as name.
  • filter_items_list – String for the table views hidden heading.
  • items_list_navigation – String for the table pagination hidden heading.
  • items_list – String for the table hidden heading.

Above, the first default value is for non-hierarchical post types (like posts) and the second one is for hierarchical post types (like pages).


Parameters Parameters

$post_type_object

(object) (Required) Post type object.


Top ↑

Return Return

(object) object with all the labels as member variables.


Top ↑

Source Source

File: wp-includes/post.php

function get_post_type_labels( $post_type_object ) {
	$nohier_vs_hier_defaults = array(
		'name' => array( _x('Posts', 'post type general name'), _x('Pages', 'post type general name') ),
		'singular_name' => array( _x('Post', 'post type singular name'), _x('Page', 'post type singular name') ),
		'add_new' => array( _x('Add New', 'post'), _x('Add New', 'page') ),
		'add_new_item' => array( __('Add New Post'), __('Add New Page') ),
		'edit_item' => array( __('Edit Post'), __('Edit Page') ),
		'new_item' => array( __('New Post'), __('New Page') ),
		'view_item' => array( __('View Post'), __('View Page') ),
		'search_items' => array( __('Search Posts'), __('Search Pages') ),
		'not_found' => array( __('No posts found.'), __('No pages found.') ),
		'not_found_in_trash' => array( __('No posts found in Trash.'), __('No pages found in Trash.') ),
		'parent_item_colon' => array( null, __('Parent Page:') ),
		'all_items' => array( __( 'All Posts' ), __( 'All Pages' ) ),
		'archives' => array( __( 'Post Archives' ), __( 'Page Archives' ) ),
		'insert_into_item' => array( __( 'Insert into post' ), __( 'Insert into page' ) ),
		'uploaded_to_this_item' => array( __( 'Uploaded to this post' ), __( 'Uploaded to this page' ) ),
		'featured_image' => array( __( 'Featured Image' ), __( 'Featured Image' ) ),
		'set_featured_image' => array( __( 'Set featured image' ), __( 'Set featured image' ) ),
		'remove_featured_image' => array( __( 'Remove featured image' ), __( 'Remove featured image' ) ),
		'use_featured_image' => array( __( 'Use as featured image' ), __( 'Use as featured image' ) ),
		'filter_items_list' => array( __( 'Filter posts list' ), __( 'Filter pages list' ) ),
		'items_list_navigation' => array( __( 'Posts list navigation' ), __( 'Pages list navigation' ) ),
		'items_list' => array( __( 'Posts list' ), __( 'Pages list' ) ),
	);
	$nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];

	$labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );

	$post_type = $post_type_object->name;

	$default_labels = clone $labels;

	/**
	 * Filter the labels of a specific post type.
	 *
	 * The dynamic portion of the hook name, `$post_type`, refers to
	 * the post type slug.
	 *
	 * @since 3.5.0
	 *
	 * @see get_post_type_labels() for the full list of labels.
	 *
	 * @param object $labels Object with labels for the post type as member variables.
	 */
	$labels = apply_filters( "post_type_labels_{$post_type}", $labels );

	// Ensure that the filtered labels contain all required default values.
	$labels = (object) array_merge( (array) $default_labels, (array) $labels );

	return $labels;
}


Top ↑

Changelog Changelog

Changelog
Version Description
4.4.0 Added the insert_into_item, uploaded_to_this_item, filter_items_list, items_list_navigation, and items_list labels.
4.3.0 Added the featured_image, set_featured_image, remove_featured_image, and use_featured_image labels.
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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