wp_get_post_terms() WordPress Function

The wp_get_post_terms() function allows you to get the terms for a given post. You can specify the taxonomy, number of terms, and orderby parameters to customize the output.

wp_get_post_terms( int $post_id, string|string[] $taxonomy = 'post_tag', array $args = array() ) #

Retrieves the terms for a post.


Parameters

$post_id

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

$taxonomy

(string|string[])(Optional) The taxonomy slug or array of slugs for which to retrieve terms.

Default value: 'post_tag'

$args

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

  • 'fields'
    (string) Term fields to retrieve. Default 'all'.

Default value: array()


Top ↑

Return

(array|WP_Error) Array of WP_Term objects on success or empty array if no terms were found. WP_Error object if $taxonomy doesn't exist.


Top ↑

Source

File: wp-includes/post.php

function wp_get_post_terms( $post_id = 0, $taxonomy = 'post_tag', $args = array() ) {
	$post_id = (int) $post_id;

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

	$tags = wp_get_object_terms( $post_id, $taxonomy, $args );

	return $tags;
}


Top ↑

Changelog

Changelog
VersionDescription
2.8.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