WordPress.org

Languages: English • 日本語 (Add your language)

WordPress Themes have a template tag for the post HTML tag which will help theme authors to style more effectively with CSS. The Template Tag is called get_post_class. This function returns different post container classes which can be added, typically, in the index.php, single.php, and other template files featuring post content, typically in the HTML <div id="post"> tag.

Description

Retrieve the classes for the post div as an array.

Many class names can be added to posts. For example, if the post is a sticky, then the 'sticky' class name is added. The class 'hentry' is always added to each post. For each category, the class that will be added is 'category-' with the category slug is added. The tags are the same way as the categories with 'tag-' before the tag slug. All classes are passed through the filter 'post_class' with the list of classes, followed by $class parameter value, with the post ID as the last parameter.

Note

get_post_class() is not simply a non-echoing alternative to post_class(). get_post_class() does not return a string, but an array that must be processed to produce text similar to what is echoed by post_class().

Usage

<?php get_post_class($class, $post_id); ?>

Parameters

$class

(string or array) (optional) A string or array of classes to add to the return value

Default: '' (empty string)

$post_id

(int) (optional) An optional post ID

Default: null

Return Value

$classes (array) 

An array of class names.
Get the object post from get_post($post_id); so, if empty return value of get_post (typically invalid $post_id), return an empty array of classes ($classes).

Examples

Default

Default example without params and global $post object available (or in the loop).

<?php 
 $postClass = get_post_class(); 
 var_dump($postClass);
 
/*Output:*/
 array() {
 0 => string 'post-[ID]' (length=7)
 1 => string '[post_type]' (length=4)
 2 => string 'type-[post_type]' (length=9)
 3 => string 'status-[post_status]' (length=14)
 4 => string 'format-[post_format]' (length=15)
 5 => string 'hentry' (length=6)
 6 => string 'category-[...]'
 X => string 'tag-[...]'
}
?>

With params

Passing an array of your own classes.

<?php
/* Optional:
global $post;
$postID = $post->ID;
 OR $postID = get_the_ID();
$postClass = get_post_class(array('my-class'));
 OR $postClass = get_post_class(array('my-class'), (int) $postID);
*/

$postClass = get_post_class(array('my-class'));
var_dump($postClass);

/* Output:
array
  0 => string 'post-[ID]' (length=7)
  1 => string '[post_type]' (length=4)
  2 => string 'type-[post_type]' (length=9)
  3 => string 'status-[post_status]' (length=14)
  4 => string 'format-[post_format]' (length=15)
  5 => string 'hentry' (length=6)
  6 => string 'category-[...]'
  ...
  X => string 'tag-[...]'
  ...
  X+1 => string 'my-class' (length=8)
...
*/
?>

Source Code

get_post_class() is located in wp-includes/post-template.php.

Changelog

• Since: 2.7

Related

• Function: body_class()
• Function: next_image_link()
• Function: next_post_link()
• Function: next_posts_link()
• Function: post_class()
• Function: post_password_required()
• Function: posts_nav_link()
• Function: previous_image_link()
• Function: previous_post_link()
• Function: previous_posts_link()
• Function: single_post_title()
• Function: sticky_class()
• Function: the_category()
• Function: the_category_rss()
• Function: the_content()
• Function: the_content_rss()
• Function: the_excerpt()
• Function: the_excerpt_rss()
• Function: the_ID()
• Function: the_meta()
• Function: the_shortlink()
• Function: the_tags()
• Function: the_title()
• Function: the_title_attribute()
• Function: the_title_rss()
• Function: wp_link_pages()

Template_Tags/comment_class