Changeset 43729 for branches/5.0/src/wp-includes/meta.php

Timestamp:

10/15/2018 11:45:16 AM (6 years ago)

Author:

flixos90

Message:

REST API: Move object type-specific metadata integrations from the wrapper functions to the low-level Meta API functions.

Object type-specific actions that should happen before or after modification of metadata have so far been part of the respective wrapper functions. By using action and filter hooks, this changeset ensures they are always executed, even when calling the lower-level Meta API functions directly, which the REST API does as a prime example.

Props flixos90, spacedmonkey.
Fixes #44467.

File:

• branches/5.0/src/wp-includes/meta.php (modified) (4 diffs)

branches/5.0/src/wp-includes/meta.php

@@ -587 +587 @@
     $id_column = ( 'user' == $meta_type ) ? 'umeta_id' : 'meta_id';
 
+    /**
+     * Filters whether to retrieve metadata of a specific type by meta ID.
+     *
+     * The dynamic portion of the hook, `$meta_type`, refers to the meta
+     * object type (comment, post, term, or user). Returning a non-null value
+     * will effectively short-circuit the function.
+     *
+     * @since 5.0.0
+     *
+     * @param mixed $value    The value get_metadata_by_mid() should return.
+     * @param int   $meta_id  Meta ID.
+     */
+    $check = apply_filters( "get_{$meta_type}_metadata_by_mid", null, $meta_id );
+    if ( null !== $check ) {
+        return $check;
+    }
+
     $meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) );
 
@@ -631 +648 @@
     $column = sanitize_key($meta_type . '_id');
     $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
+
+    /**
+     * Filters whether to update metadata of a specific type by meta ID.
+     *
+     * The dynamic portion of the hook, `$meta_type`, refers to the meta
+     * object type (comment, post, term, or user). Returning a non-null value
+     * will effectively short-circuit the function.
+     *
+     * @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|bool $meta_key   Meta key, if provided.
+     */
+    $check = apply_filters( "update_{$meta_type}_metadata_by_mid", null, $meta_id, $meta_value, $meta_key );
+    if ( null !== $check ) {
+        return (bool) $check;
+    }
 
     // Fetch the meta and go on if it's found.
@@ -725 +761 @@
     $column = sanitize_key($meta_type . '_id');
     $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
+
+    /**
+     * Filters whether to delete metadata of a specific type by meta ID.
+     *
+     * The dynamic portion of the hook, `$meta_type`, refers to the meta
+     * object type (comment, post, term, or user). Returning a non-null value
+     * will effectively short-circuit the function.
+     *
+     * @since 5.0.0
+     *
+     * @param null|bool $delete  Whether to allow metadata deletion of the given type.
+     * @param int       $meta_id Meta ID.
+     */
+    $check = apply_filters( "delete_{$meta_type}_metadata_by_mid", null, $meta_id );
+    if ( null !== $check ) {
+        return (bool) $check;
+    }
 
     // Fetch the meta and go on if it's found.
@@ -811 +864 @@
 
     $object_ids = array_map('intval', $object_ids);
+
+    /**
+     * Filters whether to update the metadata cache of a specific type.
+     *
+     * The dynamic portion of the hook, `$meta_type`, refers to the meta
+     * object type (comment, post, term, or user). Returning a non-null value
+     * will effectively short-circuit the function.
+     *
+     * @since 5.0.0
+     *
+     * @param mixed $check      Whether to allow updating the meta cache of the given type.
+     * @param array $object_ids Array of object IDs to update the meta cache for.
+     */
+    $check = apply_filters( "update_{$meta_type}_metadata_cache", null, $object_ids );
+    if ( null !== $check ) {
+        return (bool) $check;
+    }
 
     $cache_key = $meta_type . '_meta';