Ticket #35658: 35658.6.diff

src/wp-includes/meta.php

@@ -936 +936 @@
  * Sanitize meta value.
  *
  * @since 3.1.3
+ * @since 4.6.0 Added the `$object_subtype` parameter.
  *
- * @param string $meta_key   Meta key
- * @param mixed  $meta_value Meta value to sanitize
- * @param string $meta_type  Type of meta
- * @return mixed Sanitized $meta_value
+ * @param string $meta_key       Meta key.
+ * @param mixed  $meta_value     Meta value to sanitize.
+ * @param string $object_type    Type of object the meta is registered to.
+ * @param string $object_subtype Optional. Subtype of object. Will inherit the object type by default.
+ *
+ * @return mixed Sanitized $meta_value.
  */
-function sanitize_meta( $meta_key, $meta_value, $meta_type ) {
+function sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype = '' ) {
+        if ( empty( $object_subtype ) ) {
+                $object_subtype = $object_type;
+        }
 
         /**
          * Filters the sanitization of a specific meta key of a specific meta type.
@@ -958 +964 @@
          * @param string $meta_key   Meta key.
          * @param string $meta_type  Meta type.
          */
-        return apply_filters( "sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type );
+        return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type );
 }
 
 /**
- * Register meta key
+ * Registers a meta key.
  *
  * @since 3.3.0
+ * @since 4.6.0 Modified to support an array of data to attach to registered meta keys. Previous arguments for
+ *              `$sanitize_callback` and `$auth_callback` have been folded into this array.
  *
- * @param string       $meta_type         Type of meta
- * @param string       $meta_key          Meta key
- * @param string|array $sanitize_callback A function or method to call when sanitizing the value of $meta_key.
- * @param string|array $auth_callback     Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.
+ * @param string $object_type    Type of object this meta is registered to.
+ * @param string $meta_key       Meta key to register.
+ * @param array  $args {
+ *     Data used to describe the meta key when registered.
+ *
+ *     @type string   $sanitize_callback A function or method to call when sanitizing `$meta_key` data.
+ *     @type string   $auth_callback     Optional. A function or method to call when performing edit_post_meta, add_post_meta, and delete_post_meta capability checks.
+ *     @type string   $object_subtype    If the object type is "post", the post type.
+ *     @type string   $type              The type of data associated with this meta key.
+ *     @type string   $description       A description of the data attached to this meta key.
+ *     @type bool     $show_in_rest      Whether data associated with this meta key can be considered public.
+ * }
  */
-function register_meta( $meta_type, $meta_key, $sanitize_callback, $auth_callback = null ) {
-        if ( is_callable( $sanitize_callback ) )
-                add_filter( "sanitize_{$meta_type}_meta_{$meta_key}", $sanitize_callback, 10, 3 );
+function register_meta( $object_type, $meta_key, $args ) {
+        global $wp_meta_keys;
 
-        if ( empty( $auth_callback ) ) {
-                if ( is_protected_meta( $meta_key, $meta_type ) )
-                        $auth_callback = '__return_false';
-                else
-                        $auth_callback = '__return_true';
+        if ( ! is_array( $wp_meta_keys ) ) {
+                $wp_meta_keys = array();
         }
 
-        if ( is_callable( $auth_callback ) )
-                add_filter( "auth_{$meta_type}_meta_{$meta_key}", $auth_callback, 10, 6 );
+        if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
+                _doing_it_wrong( __FUNCTION__, sprintf( __( 'Invalid object type: %s.' ), $object_type ), '4.6.0' );
+        }
+
+        $defaults = array(
+                'sanitize_callback' => null,
+                'auth_callback' => null,
+                'object_subtype' => '',
+                'type' => 'string',
+                'description' => '',
+                'show_in_rest' => false,
+        );
+
+        $passed_args = array_slice( func_get_args(), 2 );
+
+        // There used to be individual args for sanitize and auth callbacks
+        if ( is_callable( $passed_args[0] ) ) {
+                $args->sanitize_callback = $passed_args[0];
+        } else {
+                $args = $passed_args[0];
+        }
+
+        if ( isset( $passed_args[1] ) && is_callable( $passed_args[1] ) ) {
+                $args->auth_callback = $passed_args[1];
+        }
+
+        $args = wp_parse_args( $args, $defaults );
+
+        // PROOF OF CONCEPT ONLY
+        // This should be a function like like _wp_register_meta_whitelist() or some such
+        // And in default filters
+        // Also you could do the subtype enforcement in here too I guess
+        add_filter( 'register_meta_args', function( $args, $defaults ) {
+                $whitelist = array_keys( $defaults );
+
+                // In an anonymous function world, this would be way better as an array_filter
+                foreach ( $args as $key => $value ) {
+                        if ( ! in_array( $key, $whitelist ) ) {
+                                unset( $args[ $key ] );
+                        }
+                }
+
+                return $args;
+        }, 10, 2 )
+
+        /**
+         * Need a filter docblock here, also how late should this go?
+         */
+        apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
+
+        // Object subtypes are only supported for posts.
+        if ( 'post' === $object_type && isset( $args['object_subtype'] ) ) {
+                $object_subtype = $args['object_subtype'];
+        } else {
+                $object_subtype = $object_type;
+        }
+
+        $wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] = $args;
+
+        if ( is_callable( $meta_args->sanitize_callback ) ) {
+                add_filter( "sanitize_{$object_type}_meta_{$meta_key}", $meta_args->sanitize_callback, 10, 3 );
+        }
+
+        // If `auth_callback` is not provided, fall back to `is_protected_meta()`.
+        if ( empty( $meta_args->auth_callback ) ) {
+                if ( is_protected_meta( $meta_key, $object_type ) ) {
+                        $args->auth_callback = '__return_false';
+                } else {
+                        $args->auth_callback = '__return_true';
+                }
+        }
+
+        if ( 'post' === $object_type && is_callable( $meta_args->auth_callback ) ) {
+                add_filter( "auth_{$object_type}_meta_{$meta_key}", $meta_args->auth_callback, 10, 6 );
+        }
 }
+
+/**
+ * Checks if a meta key is registered.
+ *
+ * @since 4.6.0
+ *
+ * @param string $object_type
+ * @param string $meta_key
+ * @param string $object_subtype
+ *
+ * @return bool True if the meta key is registered to the object type and subtype. False if not.
+ */
+function registered_meta_key_exists( $object_type, $meta_key, $object_subtype = '' ) {
+        global $wp_meta_keys;
+
+        if ( ! is_array( $wp_meta_keys ) ) {
+                return false;
+        }
+
+        // Only specific core object types are supported.
+        if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
+                return false;
+        }
+
+        // Posts are the only object type with support for object sub types.
+        if ( empty( $object_subtype ) || 'post' !== $object_type ) {
+                $object_subtype = $object_type;
+        }
+
+        if ( ! isset( $wp_meta_keys[ $object_type] ) ) {
+                return false;
+        }
+
+        if ( ! isset( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) {
+                return false;
+        }
+
+        if ( isset( $wp_meta_keys[ $object_type][ $object_subtype][ $meta_key ] ) ) {
+                return true;
+        }
+
+        return false;
+}
+
+/**
+ * Unregisters a meta key from the list of registered keys.
+ *
+ * @since 4.6.0
+ *
+ * @param string $object_type    The type of object.
+ * @param string $meta_key       The meta key.
+ * @param string $object_subtype Optional. The subtype of the object type.
+ *
+ * @return bool|WP_Error True if successful. WP_Error if the meta key is invalid.
+ */
+function unregister_meta_key( $object_type, $meta_key, $object_subtype = '' ) {
+        global $wp_meta_keys;
+
+        if ( ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) {
+                return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key' ) );
+        }
+
+        unset( $wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] );
+
+        return true;
+}
+
+/**
+ * Retrieves a list of registered meta keys for an object type and subtype.
+ *
+ * @since 4.6.0
+ *
+ * @param string $object_type The type of object. Post, comment, user, term.
+ * @param string $object_subtype A subtype of the object.
+ *
+ * @return array List of registered meta keys.
+ */
+function get_registered_meta_keys( $object_type = 'post', $object_subtype = '' ) {
+        global $wp_meta_keys;
+
+        if ( ! isset( $wp_meta_keys[ $object_type ] ) ) {
+                return array();
+        }
+
+        if ( empty( $object_subtype ) || 'post' !== $object_type ) {
+                $object_subtype = $object_type;
+        }
+
+        if ( ! isset( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) {
+                return array();
+        }
+
+        return $wp_meta_keys[ $object_type ][ $object_subtype ];
+}
+
+/**
+ * Retrieves registered metadata for a specified object.
+ *
+ * @since 4.6.0
+ *
+ * @param string $object_type    Type of object to request metadata for. (e.g. comment, post, term, user)
+ * @param int    $object_id      ID of the object the metadata is for.
+ * @param string $meta_key       Optional. Registered metadata key. If not specified, retrieve all registered
+ *                               metadata for the specified object.
+ * @param string $object_subtype The subtype of the object's type to request metadata for. (e.g. custom post type)
+ *
+ * @return mixed|WP_Error
+ */
+function get_registered_metadata( $object_type = 'post', $object_id, $meta_key = '', $object_subtype = '' ) {
+        global $wp_meta_keys;
+
+        if ( ! is_array( $wp_meta_keys ) ) {
+                return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not registered.' ) );
+        }
+
+        if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
+                return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not a core object type.' ) );
+        }
+
+        if ( empty( $object_subtype ) || 'post' !== $object_type ) {
+                $object_subtype = $object_type;
+        } elseif ( 'post' === $object_type ) {
+                $object_subtype = get_post_type( $object_id );
+        }
+
+        if( ! empty( $meta_key ) ) {
+                if ( ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) {
+                        return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not registered.' ) );
+                }
+                $meta_keys = get_registered_meta_keys( $object_type, $object_subtype );
+                $meta_key_data = $meta_keys[ $object_type ][ $object_subtype ][ $meta_key ];
+
+                $data = get_metadata( $object_type, $object_id, $meta_key, $meta_key_data->single );
+
+                return $data;
+        }
+
+        $data = get_metadata( $object_type, $object_id, $meta_key );
+
+        $meta_keys = get_registered_meta_keys( $object_type, $object_subtype );
+    $registered_data = array();
+
+        foreach( $meta_keys as $k => $v ) {
+                if ( isset( $data[ $k ] ) ) {
+                        $registered_data[ $k ] = $data[ $k ];
+                }
+        }
+
+        return $registered_data;
+}