get_registered_metadata( string $object_type, int $object_id, string $meta_key = '' ): mixed
- Since
- 4.6.0
- Source
wp-includes/meta.php:1738
Description
The results include both meta that is registered specifically for the object's subtype and meta that is registered for the entire object type.
Compatibility
- WordPress
- since 4.6.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
$object_typestring- Type of object metadata is for. Accepts 'blog', 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.
$object_idint- ID of the object the metadata is for.
$meta_keystringoptional- Registered metadata key. If not specified, retrieve all registered metadata for the specified object.Default:
''
Return value
mixed- A single value or array of values for a key if specified. An array of all registered keys and values for an object ID if not. False if a given $meta_key is not registered.
Performance profile
How much work a call to get_registered_metadata() 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
- Constant
- Instructions
- 17–41
- Plugin surface
- None
- Called by
- 0
Reaches the database via get_term().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 69.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- querycontent query
get_term()one call below get_registered_metadata() - hookthird-party callbacks
apply_filters()one call below get_registered_metadata()
Further down the call graph this can also reach cache, serialize, option 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_registered_metadata() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($meta_key) | 17 | get_object_subtype(), get_metadata() |
!empty($meta_key) && empty($object_subtype) && !registered_meta_key_exists() | 19 | get_object_subtype(), registered_meta_key_exists() |
!empty($meta_key) && !empty($object_subtype) && !registered_meta_key_exists() | 25–26 | get_object_subtype(), registered_meta_key_exists(), registered_meta_key_exists() |
empty($meta_key) && empty($object_subtype) | 27 | get_object_subtype(), get_metadata(), get_registered_meta_keys(), array_intersect_key() |
!empty($meta_key) && empty($object_subtype) && registered_meta_key_exists() | 34 | get_object_subtype(), registered_meta_key_exists(), get_registered_meta_keys(), get_metadata() |
empty($meta_key) && !empty($object_subtype) | 36 | get_object_subtype(), get_metadata(), get_registered_meta_keys(), get_registered_meta_keys(), array_merge(), array_intersect_key() |
!empty($meta_key) && !empty($object_subtype) && registered_meta_key_exists() | 40–41 | get_object_subtype(), registered_meta_key_exists(), registered_meta_key_exists(), get_registered_meta_keys(), get_metadata() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 69 instructions, 17–41 executed per call, 6 branches. The work does not change between versions.
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 · 4
- get_object_subtype()Returns the object subtype for a given object ID of a specific type.
- registered_meta_key_exists()Checks if a meta key is registered.
- get_registered_meta_keys()Retrieves a list of registered metadata args for an object type, keyed by their meta keys.
- get_metadata()Retrieves the value of a metadata field for the specified object type and ID.
Source code
function get_registered_metadata( $object_type, $object_id, $meta_key = '' ) { $object_subtype = get_object_subtype( $object_type, $object_id ); if ( ! empty( $meta_key ) ) { if ( ! empty( $object_subtype ) && ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) { $object_subtype = ''; } if ( ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) { return false; } $meta_keys = get_registered_meta_keys( $object_type, $object_subtype ); $meta_key_data = $meta_keys[ $meta_key ]; $data = get_metadata( $object_type, $object_id, $meta_key, $meta_key_data['single'] ); return $data; } $data = get_metadata( $object_type, $object_id ); if ( ! $data ) { return array(); } $meta_keys = get_registered_meta_keys( $object_type ); if ( ! empty( $object_subtype ) ) { $meta_keys = array_merge( $meta_keys, get_registered_meta_keys( $object_type, $object_subtype ) ); } return array_intersect_key( $data, $meta_keys );}Changelog
Introduced in 4.6.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/meta.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.