filter_default_metadata( mixed $value, int $object_id, string $meta_key, bool $single, string $meta_type ): mixed

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$valuemixed

Current value passed to filter.

$object_idint

ID of the object metadata is for.

$meta_keystring

Metadata key.

$singlebool

If true, return only the first value of the specified $meta_key.
This parameter has no effect if $meta_key is not specified.

$meta_typestring

Type of object metadata is for. Accepts 'blog', 'post', 'comment', 'term', 'user', or any other object type with an associated meta table.

Return value

mixed

An array of default values if $single is false.
The default value of the meta field if $single is true.

Performance profile

How much work a call to filter_default_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

Reaches the database via get_term().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

10–34

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 56.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_term()one call below filter_default_metadata()
• hookthird-party callbacksapply_filters()one call below filter_default_metadata()

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 · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost filter_default_metadata() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• wp_installing()Checks or sets whether WordPress is in "installation" mode.
• get_object_subtype()Returns the object subtype for a given object ID of a specific type.

Source code

View on Trac ↗View on GitHub ↗

1584function filter_default_metadata( $value, $object_id, $meta_key, $single, $meta_type ) {1585	global $wp_meta_keys;1586 1587	if ( wp_installing() ) {1588		return $value;1589	}1590 1591	if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $meta_type ] ) ) {1592		return $value;1593	}1594 1595	$defaults = array();1596	foreach ( $wp_meta_keys[ $meta_type ] as $sub_type => $meta_data ) {1597		foreach ( $meta_data as $_meta_key => $args ) {1598			if ( $_meta_key === $meta_key && array_key_exists( 'default', $args ) ) {1599				$defaults[ $sub_type ] = $args;1600			}1601		}1602	}1603 1604	if ( ! $defaults ) {1605		return $value;1606	}1607 1608	// If this meta type does not have subtypes, then the default is keyed as an empty string.1609	if ( isset( $defaults[''] ) ) {1610		$metadata = $defaults[''];1611	} else {1612		$sub_type = get_object_subtype( $meta_type, $object_id );1613		if ( ! isset( $defaults[ $sub_type ] ) ) {1614			return $value;1615		}1616		$metadata = $defaults[ $sub_type ];1617	}1618 1619	if ( $single ) {1620		$value = $metadata['default'];1621	} else {1622		$value = array( $metadata['default'] );1623	}1624 1625	return $value;1626}

Changelog

Introduced in 5.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 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.