sergiotarxz
/
Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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.


git-svn-id: https://develop.svn.wordpress.org/trunk@37991 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Helen Hou-Sandi 2016-07-06 18:08:55 +00:00
parent 68b18c62f2
commit 495ff0c633
2 changed files with 35 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
src/wp-includes/functions.php
View File

@ -5356,3 +5356,26 @@ function mysql_to_rfc3339( $date_string ) {
// Strip timezone information
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;
}

24
src/wp-includes/meta.php
View File

@ -1004,9 +1004,9 @@ function sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype =
* }
* @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 ) {
global $wp_meta_keys;
@ -1015,9 +1015,8 @@ function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
$wp_meta_keys = array();
}
/* 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.' ) );
}
$defaults = array(
@ -1063,7 +1062,7 @@ function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
// 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.' ) );
}
// If `auth_callback` is not provided, fall back to `is_protected_meta()`.
@ -1102,7 +1101,7 @@ function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
return true;
}
return false;
return new WP_Error( 'register_meta_failed', __( 'Sanitize and auth callbacks registered; meta key not registered.' ) );
}
/**
@ -1114,7 +1113,8 @@ function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
* @param string $object_subtype The subtype of the object type.
* @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 ) {
global $wp_meta_keys;
@ -1124,8 +1124,8 @@ function registered_meta_key_exists( $object_type, $object_subtype, $meta_key )
}
// 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.' ) );
}
if ( ! isset( $wp_meta_keys[ $object_type ] ) ) {
@ -1223,7 +1223,7 @@ function get_registered_metadata( $object_type, $object_subtype, $object_id, $me
return new WP_Error( 'invalid_meta_key', __( 'Invalid meta key. Not registered.' ) );
}
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.' ) );
}