Changeset 37991

Timestamp:

07/06/2016 06:08:55 PM (8 years ago)

Author:

helen

Message:

Meta: Make registration error conditions return consistently.

In doing this, non-core object types are no longer forcibly blocked and are instead checked against wp_object_type_exists() which has a filterable return value. Still, filter that at your own risk.

props Faison for the initial patch.
see 35658.

Location:

trunk/src/wp-includes

Files:

• functions.php (modified) (1 diff)
• meta.php (modified) (7 diffs)

trunk/src/wp-includes/functions.php

@@ -5357 +5357 @@
     return preg_replace( '/(?:Z|[+-]\d{2}(?::\d{2})?)$/', '', $formatted );
 }
+
+/**
+ * Check if an object type exists. By default, these are `post`, `comment`, `user`, and `term`.
+ *
+ * @param  string $object_type Object type to check.
+ * @return bool                True if the object type exists, false if not.
+ */
+function wp_object_type_exists( $object_type ) {
+    /**
+     * Filters WordPress object types.
+     *
+     * @since 4.6.0
+     *
+     * @param array  $types Array of object types.
+     */
+    $types = apply_filters( 'wp_object_types', array( 'post', 'comment', 'user', 'term' ) );
+
+    if ( in_array( $object_type, $types ) ) {
+        return true;
+    }
+
+    return false;
+}

trunk/src/wp-includes/meta.php

@@ -1005 +1005 @@
  * @param string|array $deprecated Deprecated. Use `$args` instead.
  *
- * @return bool True if the meta key was successfully registered in the global array, false if not.
- *              Registering a meta key with distinct sanitize and auth callbacks will fire those
- *              callbacks, but will not add to the global registry as it requires a subtype.
+ * @return bool|WP_error True if the meta key was successfully registered in the global array, WP_Error if not.
+ *                       Registering a meta key with distinct sanitize and auth callbacks will fire those
+ *                       callbacks, but will not add to the global registry as it requires a subtype.
  */
 function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
@@ -1016 +1016 @@
     }
 
-    /* translators: object type name */
-    if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
-        _doing_it_wrong( __FUNCTION__, sprintf( __( 'Invalid object type: %s.' ), $object_type ), '4.6.0' );
+    if ( ! wp_object_type_exists( $object_type ) ) {
+        return new WP_Error( 'register_meta_failed', __( 'Meta can only be registered against a core object type.' ) );
     }
 
@@ -1064 +1063 @@
     // Object subtype is required if using the args style of registration
     if ( ! $has_old_sanitize_cb && empty( $args['object_subtype'] ) ) {
-        return false;
+        return new WP_Error( 'register_meta_failed', __( 'Meta must be registered against an object subtype.' ) );
     }
 
@@ -1103 +1102 @@
     }
 
-    return false;
+    return new WP_Error( 'register_meta_failed', __( 'Sanitize and auth callbacks registered; meta key not registered.' ) );
 }
 
@@ -1115 +1114 @@
  * @param string $meta_key       The meta key.
  *
- * @return bool True if the meta key is registered to the object type and subtype. False if not.
+ * @return bool|WP_error True if the meta key is registered to the object type and subtype. False if not.
+ *                       WP_Error if an invalid object type is passed.
  */
 function registered_meta_key_exists( $object_type, $object_subtype, $meta_key ) {
@@ -1125 +1125 @@
 
     // Only specific core object types are supported.
-    if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
-        return false;
+    if ( ! wp_object_type_exists( $object_type ) ) {
+        return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not a core object type.' ) );
     }
 
@@ -1224 +1224 @@
     }
 
-    if ( ! in_array( $object_type, array( 'post', 'comment', 'user', 'term' ) ) ) {
+    if ( ! wp_object_type_exists( $object_type ) ) {
         return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not a core object type.' ) );
     }