get_post_states( WP_Post $post ): string[]

Compatibility

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

Parameters

$postWP_Post

The post to retrieve states for.

Return value

string[]

Array of post state labels keyed by their state.

Performance profile

How much work a call to get_post_states() 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

Moderate

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Constant

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

Instructions

47–127

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

Plugin surface

1 hook

Third-party callbacks on 'display_post_states' run inside this call, and their cost is not bounded by anything here.

Called by

4

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

What it touches

• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_post_states()
• serializeserialisationmaybe_unserialize()one call below get_post_states()

Further down the call graph this can also reach query 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 · 510 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

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

1. 1
   apply_filters( display_post_states )filterline 2362 (+66 into the body)

   Filters the default post display states used in the posts list table.

Uses · 6

• _x()Retrieves translated string with gettext context.
• get_post_meta()Retrieves a post meta field for the given post ID.
• __()Retrieves the translation of $text.
• is_sticky()Determines whether a post is sticky.
• get_option()Retrieves an option value based on an option name.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 4

• WP_Customize_Nav_Menus::load_available_items_query()Performs the post_type and taxonomy queries for loading available menu items.
• WP_Customize_Nav_Menus::search_available_items_query()Performs post queries for available-item searching.
• _post_states()Echoes or returns the post states as HTML.
• wp_setup_nav_menu_item()Decorates a menu item object with the shared navigation menu item properties.

Source code

View on Trac ↗View on GitHub ↗

2296function get_post_states( $post ) {2297	$post_states = array();2298 2299	if ( isset( $_REQUEST['post_status'] ) ) {2300		$post_status = $_REQUEST['post_status'];2301	} else {2302		$post_status = '';2303	}2304 2305	if ( ! empty( $post->post_password ) ) {2306		$post_states['protected'] = _x( 'Password protected', 'post status' );2307	}2308 2309	if ( 'private' === $post->post_status && 'private' !== $post_status ) {2310		$post_states['private'] = _x( 'Private', 'post status' );2311	}2312 2313	if ( 'draft' === $post->post_status ) {2314		if ( get_post_meta( $post->ID, '_customize_changeset_uuid', true ) ) {2315			$post_states[] = __( 'Customization Draft' );2316		} elseif ( 'draft' !== $post_status ) {2317			$post_states['draft'] = _x( 'Draft', 'post status' );2318		}2319	} elseif ( 'trash' === $post->post_status && get_post_meta( $post->ID, '_customize_changeset_uuid', true ) ) {2320		$post_states[] = _x( 'Customization Draft', 'post status' );2321	}2322 2323	if ( 'pending' === $post->post_status && 'pending' !== $post_status ) {2324		$post_states['pending'] = _x( 'Pending', 'post status' );2325	}2326 2327	if ( is_sticky( $post->ID ) ) {2328		$post_states['sticky'] = _x( 'Sticky', 'post status' );2329	}2330 2331	if ( 'future' === $post->post_status ) {2332		$post_states['scheduled'] = _x( 'Scheduled', 'post status' );2333	}2334 2335	if ( 'page' === get_option( 'show_on_front' ) ) {2336		if ( (int) get_option( 'page_on_front' ) === $post->ID ) {2337			$post_states['page_on_front'] = _x( 'Front Page', 'page label' );2338		}2339 2340		if ( (int) get_option( 'page_for_posts' ) === $post->ID ) {2341			$post_states['page_for_posts'] = _x( 'Posts Page', 'page label' );2342		}2343	}2344 2345	if ( (int) get_option( 'wp_page_for_privacy_policy' ) === $post->ID ) {2346		$post_states['page_for_privacy_policy'] = _x( 'Privacy Policy Page', 'page label' );2347	}2348 2349	/**2350	 * Filters the default post display states used in the posts list table.2351	 *2352	 * @since 2.8.02353	 * @since 3.6.0 Added the `$post` parameter.2354	 * @since 5.5.0 Also applied in the Customizer context. If any admin functions2355	 *              are used within the filter, their existence should be checked2356	 *              with `function_exists()` before being used.2357	 *2358	 * @param array<string, string>  $post_states A mapping of post state slugs to translated post state labels.2359	 *                                            E.g. `array( 'draft' => __( 'Draft' ), 'sticky' => __( 'Sticky' ), ... )`.2360	 * @param WP_Post                $post        The current post object.2361	 */2362	return apply_filters( 'display_post_states', $post_states, $post );2363}

Changelog

Introduced in 5.3.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-admin/includes/template.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.