get_term_parents_list( int $term_id, string $taxonomy, string|array $args = array() ): string|WP_Error
- Since
- 4.8.0
- Source
wp-includes/category-template.php:1398
Compatibility
- WordPress
- since 4.8.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$term_idint- Term ID.
$taxonomystring- Taxonomy name.
$argsstring|arrayoptional- Array of optional arguments.Default:
array()$formatstringdefault: 'name'Use term names or slugs for display. Accepts 'name' or 'slug'.$separatorstringdefault: '/'Separator for between the terms.$linkbooldefault: trueWhether to format as a link.$inclusivebooldefault: trueInclude the term to get the parents for.
Return value
string|WP_Error- A list of term parents on success, WP_Error or empty string on failure.
Performance profile
How much work a call to get_term_parents_list() 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
- Scaling
- Scales with input
- Instructions
- 14–44
- Plugin surface
- None
- Called by
- 1
Reaches the database via get_term().
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 89.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
get_term()called directly - hookthird-party callbacks
apply_filters()one call below get_term_parents_list()
Further down the call graph this can also reach option, cache, 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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_term_parents_list() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 14–15 | get_term(), is_wp_error() |
!is_wp_error() && !$args | 38–40 | get_term(), is_wp_error(), wp_parse_args(), get_ancestors(), array_reverse() |
!is_wp_error() && $args | 42–44 | get_term(), is_wp_error(), wp_parse_args(), get_ancestors(), array_unshift(), array_reverse() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 89 | 14–44 | 9 | |
| 8.5 | 89 | 14–44 | 9 | |
| 8.4 | 89 | 14–44 | 9 | |
| 8.3 | 89 | 14–44 | 9 | |
| 8.2 | 89 | 14–44 | 9 | |
| 8.1 | 89 | 14–44 | 9 | 2 fewer instructions than PHP 7.4 |
| 7.4 | 91 | 14–44 | 9 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 7
- get_term()Gets all term data from database by term ID.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- wp_parse_args()Merges user defined arguments into defaults array.
- wp_validate_boolean()Filters/validates a variable as a boolean.
- get_ancestors()Gets an array of ancestor IDs for a given object.
- esc_url()Checks and cleans a URL.
- get_term_link()Generates a permalink for a taxonomy term archive.
Used by · 1
- get_category_parents()Retrieves category parents with separator.
Source code
function get_term_parents_list( $term_id, $taxonomy, $args = array() ) { $list = ''; $term = get_term( $term_id, $taxonomy ); if ( is_wp_error( $term ) ) { return $term; } if ( ! $term ) { return $list; } $term_id = $term->term_id; $defaults = array( 'format' => 'name', 'separator' => '/', 'link' => true, 'inclusive' => true, ); $args = wp_parse_args( $args, $defaults ); foreach ( array( 'link', 'inclusive' ) as $bool ) { $args[ $bool ] = wp_validate_boolean( $args[ $bool ] ); } $parents = get_ancestors( $term_id, $taxonomy, 'taxonomy' ); if ( $args['inclusive'] ) { array_unshift( $parents, $term_id ); } foreach ( array_reverse( $parents ) as $term_id ) { $parent = get_term( $term_id, $taxonomy ); $name = ( 'slug' === $args['format'] ) ? $parent->slug : $parent->name; if ( $args['link'] ) { $list .= '<a href="' . esc_url( get_term_link( $parent->term_id, $taxonomy ) ) . '">' . $name . '</a>' . $args['separator']; } else { $list .= $name . $args['separator']; } } return $list;}Changelog
Introduced in 4.8.0. Unchanged from 6.7.7 through 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/category-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.