get_post_type_labels( object|WP_Post_Type $post_type_object ): object

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_type_objectobject|WP_Post_Type

Post type object.

Return value

object

Object with all the labels as member variables.

Performance profile

How much work a call to get_post_type_labels() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

32–46

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 46.

Plugin surface

1 hook

Third-party callbacks on 'post_type_labels_{$post_type}' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_type_labels() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 1

One hook fires while get_post_type_labels() runs, in this order:

1. 1
   apply_filters( post_type_labels_{$post_type} )filterline 2173 (+34 into the body)

   Filters the labels of a specific post type.

Uses · 4

• _get_custom_object_labels()Builds an object with custom-something object (post type, taxonomy) labels out of a custom-something object
• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_Post_Type::get_default_labels()Returns the default labels for post types.

Used by · 1

• WP_Post_Type::set_props()Sets post type properties.

Source code

View on Trac ↗View on GitHub ↗

2139function get_post_type_labels( $post_type_object ) {2140	$nohier_vs_hier_defaults = WP_Post_Type::get_default_labels();2141 2142	$nohier_vs_hier_defaults['menu_name'] = $nohier_vs_hier_defaults['name'];2143 2144	$labels = _get_custom_object_labels( $post_type_object, $nohier_vs_hier_defaults );2145 2146	if ( ! isset( $post_type_object->labels->template_name ) && isset( $post_type_object->labels->singular_name ) ) {2147			/* translators: %s: Post type name. */2148			$labels->template_name = sprintf( __( 'Single item: %s' ), $post_type_object->labels->singular_name );2149	}2150 2151	$post_type = $post_type_object->name;2152 2153	$default_labels = clone $labels;2154 2155	/**2156	 * Filters the labels of a specific post type.2157	 *2158	 * The dynamic portion of the hook name, `$post_type`, refers to2159	 * the post type slug.2160	 *2161	 * Possible hook names include:2162	 *2163	 *  - `post_type_labels_post`2164	 *  - `post_type_labels_page`2165	 *  - `post_type_labels_attachment`2166	 *2167	 * @since 3.5.02168	 *2169	 * @see get_post_type_labels() for the full list of labels.2170	 *2171	 * @param object $labels Object with labels for the post type as member variables.2172	 */2173	$labels = apply_filters( "post_type_labels_{$post_type}", $labels );2174 2175	// Ensure that the filtered labels contain all required default values.2176	$labels = (object) array_merge( (array) $default_labels, (array) $labels );2177 2178	return $labels;2179}

Changelog

Introduced in 3.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.