default_{$meta_type}_metadata WordPress Filter Hook

This hook is used to filter the default metadata for a given object type. The object type can be either 'post' or 'user'. The default metadata for a post includes the '_edit_last' and '_edit_lock' metadata, while the default metadata for a user includes the '_last_password_change' metadata.

apply_filters( "default_{$meta_type}_metadata", mixed $value, int $object_id, string $meta_key, bool $single, string $meta_type ) #

Filters the default metadata value for a specified meta key and object.


Description

The dynamic portion of the hook name, $meta_type, refers to the meta object type (post, comment, term, user, or any other type with an associated meta table).

Possible filter names include:

  • default_post_metadata
  • default_comment_metadata
  • default_term_metadata
  • default_user_metadata

Top ↑

Parameters

$value

(mixed)The value to return, either a single metadata value or an array of values depending on the value of $single.

$object_id

(int)ID of the object metadata is for.

$meta_key

(string)Metadata key.

$single

(bool)Whether to return only the first value of the specified $meta_key.

$meta_type

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


Top ↑

Source

File: wp-includes/meta.php

View on Trac



Top ↑

Changelog

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