钩子文档

update_{$meta_type}_metadata_by_mid

💡 云策文档标注

概述

update_{$meta_type}_metadata_by_mid 是一个 WordPress 过滤器钩子,用于通过 meta ID 短路更新特定类型的元数据。它允许开发者在更新元数据时进行自定义处理或阻止默认行为。

关键要点

  • 钩子名称是动态的,基于 $meta_type(如 blog、post、comment、term、user 等),对应不同的元对象类型。
  • 返回非空值将短路 update_metadata_by_mid() 函数,阻止默认更新操作。
  • 参数包括 $check(是否允许更新)、$meta_id(元 ID)、$meta_value(元值,非标量需可序列化)和 $meta_key(元键,可选)。
  • 在 WordPress 5.0.0 版本中引入。

代码示例

$check = apply_filters( "update_{$meta_type}_metadata_by_mid", null, $meta_id, $meta_value, $meta_key );

📄 原文内容

Short-circuits updating metadata of a specific type by meta ID.

Description

The dynamic portion of the hook name, $meta_type, refers to the meta object type (blog, post, comment, term, user, or any other type with an associated meta table).
Returning a non-null value will effectively short-circuit the function.

Possible hook names include:

  • update_blog_metadata_by_mid
  • update_post_metadata_by_mid
  • update_comment_metadata_by_mid
  • update_term_metadata_by_mid
  • update_user_metadata_by_mid

Parameters

$checknull|bool
Whether to allow updating metadata for the given type.
$meta_idint
Meta ID.
$meta_valuemixed
Meta value. Must be serializable if non-scalar.
$meta_keystring|false
Meta key, if provided.

Source

$check = apply_filters( "update_{$meta_type}_metadata_by_mid", null, $meta_id, $meta_value, $meta_key );

Changelog

Version Description
5.0.0 Introduced.