get_post_class( string|string[] $css_class = '', int|WP_Post|null $post = null ): string[]

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

$css_classstring|string[]optional

Space-separated string or array of class names to add to the class list. Default empty.Default: ''

$postint|WP_Post|nulloptional

Post ID or post object.Default: null

Return value

string[]

Array of class names.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

11–141

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

Plugin surface

2 hooks

Third-party callbacks on 'post_class_taxonomies', 'post_class' 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

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below get_post_class()
• cacheobject cachewp_cache_add()one call below get_post_class()

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

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_post_class() 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 · 2

2 hooks fire while get_post_class() runs, in this order:

1. 1
   apply_filters( post_class_taxonomies )filterline 572 (+78 into the body)

   Filters the taxonomies to generate classes for each individual term.

2. 2
   apply_filters( post_class )filterline 607 (+113 into the body)

   Filters the list of CSS class names for the current post.

Uses · 17

• get_post()Retrieves post data given a post ID or post object.
• is_admin()Determines whether the current request is for an administrative interface page.
• post_type_supports()Checks a post type's support for a given feature.
• get_post_format()Retrieve the format slug for a post
• is_wp_error()Checks whether the given variable is a WordPress Error.
• sanitize_html_class()Sanitizes an HTML classname to ensure it only contains valid characters.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• current_theme_supports()Checks a theme's support for a given feature.
• has_post_thumbnail()Determines whether a post has an image attached.
• is_attachment()Determines whether the query is for an existing attachment page.
• is_sticky()Determines whether a post is sticky.
• is_home()Determines whether the query is for the blog homepage.

Used by · 4

• WP_Posts_List_Table::single_row()
• WP_REST_Posts_Controller::prepare_item_for_response()Prepares a single post output for response.
• post_class()Displays the classes for the post container element.
• render_block_core_post_template()Renders the `core/post-template` block on the server.

Source code

View on Trac ↗View on GitHub ↗

494function get_post_class( $css_class = '', $post = null ) {495	$post = get_post( $post );496 497	$classes = array();498 499	if ( $css_class ) {500		if ( ! is_array( $css_class ) ) {501			$css_class = preg_split( '#\s+#', $css_class );502		}503		$classes = array_map( 'esc_attr', $css_class );504	} else {505		// Ensure that we always coerce class to being an array.506		$css_class = array();507	}508 509	if ( ! $post ) {510		return $classes;511	}512 513	$classes[] = 'post-' . $post->ID;514	if ( ! is_admin() ) {515		$classes[] = $post->post_type;516	}517	$classes[] = 'type-' . $post->post_type;518	$classes[] = 'status-' . $post->post_status;519 520	// Post Format.521	if ( post_type_supports( $post->post_type, 'post-formats' ) ) {522		$post_format = get_post_format( $post->ID );523 524		if ( $post_format && ! is_wp_error( $post_format ) ) {525			$classes[] = 'format-' . sanitize_html_class( $post_format );526		} else {527			$classes[] = 'format-standard';528		}529	}530 531	$post_password_required = post_password_required( $post->ID );532 533	// Post requires password.534	if ( $post_password_required ) {535		$classes[] = 'post-password-required';536	} elseif ( ! empty( $post->post_password ) ) {537		$classes[] = 'post-password-protected';538	}539 540	// Post thumbnails.541	if ( current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) && ! is_attachment( $post ) && ! $post_password_required ) {542		$classes[] = 'has-post-thumbnail';543	}544 545	// Sticky for Sticky Posts.546	if ( is_sticky( $post->ID ) ) {547		if ( is_home() && ! is_paged() ) {548			$classes[] = 'sticky';549		} elseif ( is_admin() ) {550			$classes[] = 'status-sticky';551		}552	}553 554	// hentry for hAtom compliance.555	$classes[] = 'hentry';556 557	// All public taxonomies.558	$taxonomies = get_taxonomies( array( 'public' => true ) );559 560	/**561	 * Filters the taxonomies to generate classes for each individual term.562	 *563	 * Default is all public taxonomies registered to the post type.564	 *565	 * @since 6.1.0566	 *567	 * @param string[] $taxonomies List of all taxonomy names to generate classes for.568	 * @param int      $post_id    The post ID.569	 * @param string[] $classes    An array of post class names.570	 * @param string[] $css_class  An array of additional class names added to the post.571	*/572	$taxonomies = apply_filters( 'post_class_taxonomies', $taxonomies, $post->ID, $classes, $css_class );573

Changelog

Introduced in 2.7.0. One change between 6.7.7 and 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 7.1.0 tag, from src/wp-includes/post-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.