get_terms_to_edit( int $post_id, string $taxonomy = 'post_tag' ): string|false|WP_Error
- Since
- 2.8.0
- Source
wp-admin/includes/taxonomy.php:260
Compatibility
- WordPress
- since 2.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
$post_idint$taxonomystringoptional- The taxonomy for which to retrieve terms. Default 'post_tag'.Default:
'post_tag'
Return value
string|false|WP_Error
Performance profile
How much work a call to get_terms_to_edit() 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
- 6–48
- Plugin surface
- 1 hook
- Called by
- 3
Reaches the database via wp_get_object_terms().
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 55.
Third-party callbacks on 'terms_to_edit' run inside this call, and their cost is not bounded by anything here.
3 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- querycontent query
wp_get_object_terms()called directly - cacheobject cache
wp_cache_add()called directly - hookthird-party callbacks
apply_filters()called directly
Further down the call graph this can also reach option, 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 · 7 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_terms_to_edit() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
| always | 6 | none |
$terms !== false | 14 | get_object_term_cache() |
$terms !== false && is_wp_error() | 18 | get_object_term_cache(), is_wp_error() |
$terms === false | 29 | get_object_term_cache(), wp_get_object_terms(), wp_list_pluck(), wp_cache_add() |
$terms !== false && !is_wp_error() | 32–33 | get_object_term_cache(), is_wp_error(), esc_attr(), apply_filters() |
$terms === false && is_wp_error() | 33 | get_object_term_cache(), wp_get_object_terms(), wp_list_pluck(), wp_cache_add(), is_wp_error() |
$terms === false && !is_wp_error() | 47–48 | get_object_term_cache(), wp_get_object_terms(), wp_list_pluck(), wp_cache_add(), is_wp_error(), esc_attr(), apply_filters() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 55 | 6–48 | 6 | |
| 8.5 | 55 | 6–48 | 6 | |
| 8.4 | 55 | 6–48 | 6 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 58 | 6–51 | 6 | |
| 8.2 | 58 | 6–51 | 6 | |
| 8.1 | 58 | 6–51 | 6 | |
| 7.4 | 58 | 6–51 | 6 |
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.
Hooks and filters fired · 1
One hook fires while get_terms_to_edit() runs, in this order:
- apply_filters( terms_to_edit )filterline 295 (+35 into the body)
Filters the comma-separated list of terms available to edit.
Uses · 7
- get_object_term_cache()Retrieves the cached term objects for the given object ID.
- wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.
- wp_cache_add()Adds data to the cache, if the cache key doesn't already exist.
- wp_list_pluck()Plucks a certain field out of each object or array in an array.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- esc_attr()Escaping for HTML attributes.
- apply_filters()Calls the callback functions that have been added to a filter hook.
Used by · 3
- get_inline_data()Adds hidden fields with the data for use in the inline editor for posts and pages.
- get_tags_to_edit()Gets comma-separated list of tags available to edit.
- post_tags_meta_box()Displays post tags form fields.
Source code
function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) { $post_id = (int) $post_id; if ( ! $post_id ) { return false; } $terms = get_object_term_cache( $post_id, $taxonomy ); if ( false === $terms ) { $terms = wp_get_object_terms( $post_id, $taxonomy ); wp_cache_add( $post_id, wp_list_pluck( $terms, 'term_id' ), $taxonomy . '_relationships' ); } if ( ! $terms ) { return false; } if ( is_wp_error( $terms ) ) { return $terms; } $term_names = array(); foreach ( $terms as $term ) { $term_names[] = $term->name; } $terms_to_edit = esc_attr( implode( ',', $term_names ) ); /** * Filters the comma-separated list of terms available to edit. * * @since 2.8.0 * * @see get_terms_to_edit() * * @param string $terms_to_edit A comma-separated list of term names. * @param string $taxonomy The taxonomy name for which to retrieve terms. */ $terms_to_edit = apply_filters( 'terms_to_edit', $terms_to_edit, $taxonomy ); return $terms_to_edit;}Changelog
Introduced in 2.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 6.7.7 tag, from
src/wp-admin/includes/taxonomy.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.