Files
| Filename | Hook Type | Line Number | PHP Doc |
|---|---|---|---|
| wp-includes/meta.php | apply_filters | 233 | /** * Short-circuits updating metadata of a specific type. * * 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). * Returning a non-null value will effectively short-circuit the function. * * Possible hook names include: * * - `update_post_metadata` * - `update_comment_metadata` * - `update_term_metadata` * - `update_user_metadata` * * @since 3.1.0 * * @param null|bool $check Whether to allow updating metadata for the given type. * @param int $object_id ID of the object metadata is for. * @param string $meta_key Metadata key. * @param mixed $meta_value Metadata value. Must be serializable if non-scalar. * @param mixed $prev_value Optional. Previous value to check before updating. * If specified, only update existing metadata entries with * this value. Otherwise, update all entries. */ |
| wp-includes/meta.php | do_action | 288 | /** * Fires immediately before updating metadata of a specific type. * * 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 hook names include: * * - `update_post_meta` * - `update_comment_meta` * - `update_term_meta` * - `update_user_meta` * * @since 2.9.0 * * @param int $meta_id ID of the metadata entry to update. * @param int $object_id ID of the object metadata is for. * @param string $meta_key Metadata key. * @param mixed $_meta_value Metadata value. */ |
| wp-includes/meta.php | apply_filters | 899 | /** * Short-circuits updating metadata of a specific type by meta ID. * * 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). * Returning a non-null value will effectively short-circuit the function. * * Possible hook names include: * * - `update_post_metadata_by_mid` * - `update_comment_metadata_by_mid` * - `update_term_metadata_by_mid` * - `update_user_metadata_by_mid` * * @since 5.0.0 * * @param null|bool $check Whether to allow updating metadata for the given type. * @param int $meta_id Meta ID. * @param mixed $meta_value Meta value. Must be serializable if non-scalar. * @param string|false $meta_key Meta key, if provided. */ |
| wp-includes/meta.php | do_action | 936 | /** * Short-circuits updating metadata of a specific type by meta ID. * * 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). * Returning a non-null value will effectively short-circuit the function. * * Possible hook names include: * * - `update_post_metadata_by_mid` * - `update_comment_metadata_by_mid` * - `update_term_metadata_by_mid` * - `update_user_metadata_by_mid` * * @since 5.0.0 * * @param null|bool $check Whether to allow updating metadata for the given type. * @param int $meta_id Meta ID. * @param mixed $meta_value Meta value. Must be serializable if non-scalar. * @param string|false $meta_key Meta key, if provided. */ |
| wp-includes/meta.php | apply_filters | 1146 | /** * Short-circuits updating the metadata cache of a specific type. * * 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). * Returning a non-null value will effectively short-circuit the function. * * Possible hook names include: * * - `update_post_metadata_cache` * - `update_comment_metadata_cache` * - `update_term_metadata_cache` * - `update_user_metadata_cache` * * @since 5.0.0 * * @param mixed $check Whether to allow updating the meta cache of the given type. * @param int[] $object_ids Array of object IDs to update the meta cache for. */ |
Hook Parameters
| Parameter Type | Name | Description |
|---|---|---|
| null|bool | $check | Whether to allow updating metadata for the given type. |
| int | $object_id | ID of the object metadata is for. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before updating. |
| null|bool | $check | Whether to allow updating metadata for the given type. |
| int | $object_id | ID of the object metadata is for. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before updating. |
| null|bool | $check | Whether to allow updating metadata for the given type. |
| int | $object_id | ID of the object metadata is for. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before updating. |
| null|bool | $check | Whether to allow updating metadata for the given type. |
| int | $object_id | ID of the object metadata is for. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before updating. |
| null|bool | $check | Whether to allow updating metadata for the given type. |
| int | $object_id | ID of the object metadata is for. |
| string | $meta_key | Metadata key. |
| mixed | $meta_value | Metadata value. Must be serializable if non-scalar. |
| mixed | $prev_value | Optional. Previous value to check before updating. |