wp_get_post_categories() WordPress Function

The wp_get_post_categories() function is used to get the list of categories for a given post.

wp_get_post_categories( int $post_id, array $args = array() ) #

Retrieve the list of categories for a post.


Description

Compatibility layer for themes and plugins. Also an easy layer of abstraction away from the complexity of the taxonomy layer.

Top ↑

See also


Top ↑

Parameters

$post_id

(int)(Optional) The Post ID. Does not default to the ID of the global $post. Default 0.

$args

(array)(Optional) Category query parameters. See WP_Term_Query::__construct() for supported arguments.

Default value: array()


Top ↑

Return

(array|WP_Error) List of categories. If the $fields argument passed via $args is 'all' or 'all_with_object_id', an array of WP_Term objects will be returned. If $fields is 'ids', an array of category IDs. If $fields is 'names', an array of category names. WP_Error object if 'category' taxonomy doesn't exist.


Top ↑

More Information

The results from wp_get_post_categories() aren’t cached which will result in a database call being made every time this function is called. Use this function with care. For performance, functions like get_the_category() should be used to return categories attached to a post.


Top ↑

Source

File: wp-includes/post.php

function wp_get_post_categories( $post_id = 0, $args = array() ) {
	$post_id = (int) $post_id;

	$defaults = array( 'fields' => 'ids' );
	$args     = wp_parse_args( $args, $defaults );

	$cats = wp_get_object_terms( $post_id, 'category', $args );
	return $cats;
}


Top ↑

Changelog

Changelog
VersionDescription
2.1.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.

Show More
Show More