<?php
/**
- * Metadata API
+ * Core Metadata API
*
* Functions for retrieving and manipulating metadata of various WordPress object types. Metadata
* for an object is a represented by a simple key-value pair. Objects may contain multiple
*
* @package WordPress
* @subpackage Meta
- * @since 2.9.0
*/
/**
* Add metadata for the specified object.
*
* @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @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 bool $unique Optional, default is false. Whether the specified metadata key should be
- * unique for the object. If true, and the object already has a value for the specified
- * metadata key, no change will be made
- * @return int|bool The meta ID on success, false on failure.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @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 bool $unique Optional, default is false.
+ * Whether the specified metadata key should be unique for the object.
+ * If true, and the object already has a value for the specified metadata key,
+ * no change will be made.
+ * @return int|false The meta ID on success, false on failure.
*/
function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
global $wpdb;
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
/**
- * Filter whether to add metadata of a specific type.
+ * Filters whether to add metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value
* will effectively short-circuit the function.
*
/**
* Fires immediately before meta of a specific type is added.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user).
*
* @since 3.1.0
/**
* Fires immediately after meta of a specific type is added.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user).
*
* @since 2.9.0
* ID and metadata key, the metadata will be added.
*
* @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @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. If specified, only update existing metadata entries with
- * the specified value. Otherwise, update all entries.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @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. If specified, only update existing metadata entries with
+ * the specified value. Otherwise, update all entries.
* @return int|bool Meta ID if the key didn't exist, true on successful update, false on failure.
*/
function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
$id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
// expected_slashed ($meta_key)
+ $raw_meta_key = $meta_key;
$meta_key = wp_unslash($meta_key);
$passed_value = $meta_value;
$meta_value = wp_unslash($meta_value);
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
/**
- * Filter whether to update metadata of a specific type.
+ * Filters whether to update metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value
* will effectively short-circuit the function.
*
}
}
- if ( ! $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) )
- return add_metadata($meta_type, $object_id, $meta_key, $passed_value);
+ $meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) );
+ if ( empty( $meta_ids ) ) {
+ return add_metadata( $meta_type, $object_id, $raw_meta_key, $passed_value );
+ }
$_meta_value = $meta_value;
$meta_value = maybe_serialize( $meta_value );
$where['meta_value'] = $prev_value;
}
- /**
- * Fires immediately before updating metadata of a specific type.
- *
- * The dynamic portion of the hook, $meta_type, refers to the meta
- * object type (comment, post, or user).
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of the metadata entry to update.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
-
- if ( 'post' == $meta_type )
+ foreach ( $meta_ids as $meta_id ) {
/**
- * Fires immediately before updating a post's metadata.
+ * Fires immediately before updating metadata of a specific type.
+ *
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
+ * object type (comment, post, or user).
*
* @since 2.9.0
*
- * @param int $meta_id ID of metadata entry to update.
+ * @param int $meta_id ID of the metadata entry to update.
* @param int $object_id Object ID.
* @param string $meta_key Meta key.
* @param mixed $meta_value Meta value.
*/
- do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
+ do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+ if ( 'post' == $meta_type ) {
+ /**
+ * Fires immediately before updating a post's metadata.
+ *
+ * @since 2.9.0
+ *
+ * @param int $meta_id ID of metadata entry to update.
+ * @param int $object_id Object ID.
+ * @param string $meta_key Meta key.
+ * @param mixed $meta_value Meta value.
+ */
+ do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
+ }
+ }
$result = $wpdb->update( $table, $data, $where );
if ( ! $result )
wp_cache_delete($object_id, $meta_type . '_meta');
- /**
- * Fires immediately after updating metadata of a specific type.
- *
- * The dynamic portion of the hook, $meta_type, refers to the meta
- * object type (comment, post, or user).
- *
- * @since 2.9.0
- *
- * @param int $meta_id ID of updated metadata entry.
- * @param int $object_id Object ID.
- * @param string $meta_key Meta key.
- * @param mixed $meta_value Meta value.
- */
- do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
-
- if ( 'post' == $meta_type ) {
+ foreach ( $meta_ids as $meta_id ) {
/**
- * Fires immediately after updating a post's metadata.
+ * Fires immediately after updating metadata of a specific type.
+ *
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
+ * object type (comment, post, or user).
*
* @since 2.9.0
*
* @param string $meta_key Meta key.
* @param mixed $meta_value Meta value.
*/
- do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
+ do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
+
+ if ( 'post' == $meta_type ) {
+ /**
+ * Fires immediately after updating a post's metadata.
+ *
+ * @since 2.9.0
+ *
+ * @param int $meta_id ID of updated metadata entry.
+ * @param int $object_id Object ID.
+ * @param string $meta_key Meta key.
+ * @param mixed $meta_value Meta value.
+ */
+ do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
+ }
}
return true;
* Delete metadata for the specified object.
*
* @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $object_id ID of the object metadata is for
- * @param string $meta_key Metadata key
- * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries
- * with this value. Otherwise, delete all entries with the specified meta_key.
- * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries
- * for all objects, ignoring the specified object_id. Otherwise, only delete matching
- * metadata entries for the specified object_id.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key
+ * @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete
+ * metadata entries with this value. Otherwise, delete all entries with the specified meta_key.
+ * Pass `null, `false`, or an empty string to skip this check. (For backward compatibility,
+ * it is not possible to pass an empty string to delete those entries with an empty string
+ * for a value.)
+ * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries for all objects,
+ * ignoring the specified object_id. Otherwise, only delete matching metadata entries for
+ * the specified object_id.
* @return bool True on successful delete, false on failure.
*/
function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
$meta_value = wp_unslash($meta_value);
/**
- * Filter whether to delete metadata of a specific type.
+ * Filters whether to delete metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value
* will effectively short-circuit the function.
*
if ( !$delete_all )
$query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
- if ( $meta_value )
+ if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value )
$query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
$meta_ids = $wpdb->get_col( $query );
if ( !count( $meta_ids ) )
return false;
- if ( $delete_all )
- $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s", $meta_key ) );
+ if ( $delete_all ) {
+ $value_clause = '';
+ if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) {
+ $value_clause = $wpdb->prepare( " AND meta_value = %s", $meta_value );
+ }
+
+ $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s $value_clause", $meta_key ) );
+ }
/**
* Fires immediately before deleting metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user).
*
* @since 3.1.0
/**
* Fires immediately after deleting metadata of a specific type.
*
- * The dynamic portion of the hook name, $meta_type, refers to the meta
+ * The dynamic portion of the hook name, `$meta_type`, refers to the meta
* object type (comment, post, or user).
*
* @since 2.9.0
* @since 2.9.0
*
* @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $object_id ID of the object metadata is for
- * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
- * the specified object.
- * @param bool $single Optional, default is false. If true, return only the first value of the
- * specified meta_key. This parameter has no effect if meta_key is not specified.
- * @return string|array Single metadata value, or array of values
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
+ * the specified object.
+ * @param bool $single Optional, default is false.
+ * If true, return only the first value of the specified meta_key.
+ * This parameter has no effect if meta_key is not specified.
+ * @return mixed Single metadata value, or array of values
*/
function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
if ( ! $meta_type || ! is_numeric( $object_id ) ) {
}
/**
- * Filter whether to retrieve metadata of a specific type.
+ * Filters whether to retrieve metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (comment, post, or user). Returning a non-null value
* will effectively short-circuit the function.
*
* @since 3.1.0
*
- * @param null|array|string $value The value get_metadata() should
- * return - a single metadata value,
+ * @param null|array|string $value The value get_metadata() should return - a single metadata value,
* or an array of values.
* @param int $object_id Object ID.
* @param string $meta_key Meta key.
- * @param string|array $single Meta value, or an array of values.
+ * @param bool $single Whether to return only the first value of the specified $meta_key.
*/
$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );
if ( null !== $check ) {
$meta_cache = $meta_cache[$object_id];
}
- if ( !$meta_key )
+ if ( ! $meta_key ) {
return $meta_cache;
+ }
if ( isset($meta_cache[$meta_key]) ) {
if ( $single )
* @since 3.3.0
*
* @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $object_id ID of the object metadata is for
- * @param string $meta_key Metadata key.
- * @return boolean true of the key is set, false if not.
+ * @param int $object_id ID of the object metadata is for
+ * @param string $meta_key Metadata key.
+ * @return bool True of the key is set, false if not.
*/
function metadata_exists( $meta_type, $object_id, $meta_key ) {
if ( ! $meta_type || ! is_numeric( $object_id ) ) {
*
* @since 3.3.0
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $meta_id ID for a specific meta row
- * @return object Meta object or false.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
+ * @param int $meta_id ID for a specific meta row
+ * @return object|false Meta object or false.
*/
function get_metadata_by_mid( $meta_type, $meta_id ) {
global $wpdb;
*
* @since 3.3.0
*
- * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
- * and object_id of the given meta_id.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $meta_id ID for a specific meta row
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @param int $meta_id ID for a specific meta row
* @param string $meta_value Metadata value
- * @param string $meta_key Optional, you can provide a meta key to update it
+ * @param string $meta_key Optional, you can provide a meta key to update it
* @return bool True on successful update, false on failure.
*/
function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key = false ) {
*
* @since 3.3.0
*
- * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
- * and object_id of the given meta_id.
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int $meta_id ID for a specific meta row
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
+ * @param int $meta_id ID for a specific meta row
* @return bool True on successful delete, false on failure.
*/
function delete_metadata_by_mid( $meta_type, $meta_id ) {
/**
* Fires immediately before deleting post or comment metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (post or comment).
*
* @since 3.4.0
/**
* Fires immediately after deleting post or comment metadata of a specific type.
*
- * The dynamic portion of the hook, $meta_type, refers to the meta
+ * The dynamic portion of the hook, `$meta_type`, refers to the meta
* object type (post or comment).
*
* @since 3.4.0
* Update the metadata cache for the specified objects.
*
* @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
- * @param int|array $object_ids array or comma delimited list of object IDs to update cache for
- * @return mixed Metadata cache for the specified objects, or false on failure.
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @param int|array $object_ids Array or comma delimited list of object IDs to update cache for
+ * @return array|false Metadata cache for the specified objects, or false on failure.
*/
function update_meta_cache($meta_type, $object_ids) {
global $wpdb;
}
/**
- * Given a meta query, generates SQL clauses to be appended to a main query
+ * Retrieves the queue for lazy-loading metadata.
+ *
+ * @since 4.5.0
+ *
+ * @return WP_Metadata_Lazyloader $lazyloader Metadata lazyloader queue.
+ */
+function wp_metadata_lazyloader() {
+ static $wp_metadata_lazyloader;
+
+ if ( null === $wp_metadata_lazyloader ) {
+ $wp_metadata_lazyloader = new WP_Metadata_Lazyloader();
+ }
+
+ return $wp_metadata_lazyloader;
+}
+
+/**
+ * Given a meta query, generates SQL clauses to be appended to a main query.
*
* @since 3.2.0
*
* @see WP_Meta_Query
*
- * @param array $meta_query A meta query
- * @param string $type Type of meta
- * @param string $primary_table
- * @param string $primary_id_column
- * @param object $context (optional) The main query object
- * @return array( 'join' => $join_sql, 'where' => $where_sql )
+ * @param array $meta_query A meta query.
+ * @param string $type Type of meta.
+ * @param string $primary_table Primary database table name.
+ * @param string $primary_id_column Primary ID column name.
+ * @param object $context Optional. The main query object
+ * @return array Associative array of `JOIN` and `WHERE` SQL.
*/
function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {
$meta_query_obj = new WP_Meta_Query( $meta_query );
}
/**
- * Container class for a multiple metadata query
+ * Retrieve the name of the metadata table for the specified object type.
*
- * @since 3.2.0
+ * @since 2.9.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
+ * @return string|false Metadata table name, or false if no metadata table exists
*/
-class WP_Meta_Query {
- /**
- * List of metadata queries. A single query is an associative array:
- * - 'key' string The meta key
- * - 'value' string|array The meta value
- * - 'compare' (optional) string How to compare the key to the value.
- * Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
- * 'BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', 'RLIKE'.
- * Default: '='
- * - 'type' string (optional) The type of the value.
- * Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
- * Default: 'CHAR'
- *
- * @since 3.2.0
- * @access public
- * @var array
- */
- public $queries = array();
-
- /**
- * The relation between the queries. Can be one of 'AND' or 'OR'.
- *
- * @since 3.2.0
- * @access public
- * @var string
- */
- public $relation;
-
- /**
- * Constructor
- *
- * @param array $meta_query (optional) A meta query
- */
- public function __construct( $meta_query = false ) {
- if ( !$meta_query )
- return;
+function _get_meta_table($type) {
+ global $wpdb;
- if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
- $this->relation = 'OR';
- } else {
- $this->relation = 'AND';
- }
+ $table_name = $type . 'meta';
- $this->queries = array();
+ if ( empty($wpdb->$table_name) )
+ return false;
- foreach ( $meta_query as $key => $query ) {
- if ( ! is_array( $query ) )
- continue;
+ return $wpdb->$table_name;
+}
- $this->queries[] = $query;
- }
- }
+/**
+ * Determine whether a meta key is protected.
+ *
+ * @since 3.1.3
+ *
+ * @param string $meta_key Meta key
+ * @param string|null $meta_type
+ * @return bool True if the key is protected, false otherwise.
+ */
+function is_protected_meta( $meta_key, $meta_type = null ) {
+ $protected = ( '_' == $meta_key[0] );
/**
- * Constructs a meta query based on 'meta_*' query vars
+ * Filters whether a meta key is protected.
*
* @since 3.2.0
- * @access public
*
- * @param array $qv The query variables
+ * @param bool $protected Whether the key is protected. Default false.
+ * @param string $meta_key Meta key.
+ * @param string $meta_type Meta type.
*/
- public function parse_query_vars( $qv ) {
- $meta_query = array();
-
- // Simple query needs to be first for orderby=meta_value to work correctly
- foreach ( array( 'key', 'compare', 'type' ) as $key ) {
- if ( !empty( $qv[ "meta_$key" ] ) )
- $meta_query[0][ $key ] = $qv[ "meta_$key" ];
- }
-
- // WP_Query sets 'meta_value' = '' by default
- if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] && ( ! is_array( $qv[ 'meta_value' ] ) || $qv[ 'meta_value' ] ) )
- $meta_query[0]['value'] = $qv[ 'meta_value' ];
-
- if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
- $meta_query = array_merge( $meta_query, $qv['meta_query'] );
- }
-
- $this->__construct( $meta_query );
- }
+ return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
+}
+/**
+ * Sanitize meta value.
+ *
+ * @since 3.1.3
+ *
+ * @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.
+ *
+ * @return mixed Sanitized $meta_value.
+ */
+function sanitize_meta( $meta_key, $meta_value, $object_type ) {
/**
- * Given a meta type, return the appropriate alias if applicable
+ * Filters the sanitization of a specific meta key of a specific meta type.
*
- * @since 3.7.0
+ * The dynamic portions of the hook name, `$meta_type`, and `$meta_key`,
+ * refer to the metadata object type (comment, post, or user) and the meta
+ * key value, respectively.
*
- * @param string $type MySQL type to cast meta_value
- * @return string MySQL type
+ * @since 3.3.0
+ *
+ * @param mixed $meta_value Meta value to sanitize.
+ * @param string $meta_key Meta key.
+ * @param string $object_type Object type.
*/
- public function get_cast_for_type( $type = '' ) {
- if ( empty( $type ) )
- return 'CHAR';
+ return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type );
+}
+
+/**
+ * Registers a meta key.
+ *
+ * @since 3.3.0
+ * @since 4.6.0 {@link https://make.wordpress.org/core/2016/07/08/enhancing-register_meta-in-4-6/ 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 $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 $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 $single Whether the meta key has one value per object, or an array of values per object.
+ * @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 bool $show_in_rest Whether data associated with this meta key can be considered public.
+ * }
+ * @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.
+ */
+function register_meta( $object_type, $meta_key, $args, $deprecated = null ) {
+ global $wp_meta_keys;
- $meta_type = strtoupper( $type );
+ if ( ! is_array( $wp_meta_keys ) ) {
+ $wp_meta_keys = array();
+ }
- if ( ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $meta_type ) )
- return 'CHAR';
+ $defaults = array(
+ 'type' => 'string',
+ 'description' => '',
+ 'single' => false,
+ 'sanitize_callback' => null,
+ 'auth_callback' => null,
+ 'show_in_rest' => false,
+ );
+
+ // There used to be individual args for sanitize and auth callbacks
+ $has_old_sanitize_cb = false;
+ $has_old_auth_cb = false;
+
+ if ( is_callable( $args ) ) {
+ $args = array(
+ 'sanitize_callback' => $args,
+ );
- if ( 'NUMERIC' == $meta_type )
- $meta_type = 'SIGNED';
+ $has_old_sanitize_cb = true;
+ } else {
+ $args = (array) $args;
+ }
- return $meta_type;
+ if ( is_callable( $deprecated ) ) {
+ $args['auth_callback'] = $deprecated;
+ $has_old_auth_cb = true;
}
/**
- * Generates SQL clauses to be appended to a main query.
+ * Filters the registration arguments when registering meta.
*
- * @since 3.2.0
- * @access public
+ * @since 4.6.0
*
- * @param string $type Type of meta
- * @param string $primary_table
- * @param string $primary_id_column
- * @param object $context (optional) The main query object
- * @return array( 'join' => $join_sql, 'where' => $where_sql )
+ * @param array $args Array of meta registration arguments.
+ * @param array $defaults Array of default arguments.
+ * @param string $object_type Object type.
+ * @param string $meta_key Meta key.
*/
- public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
- global $wpdb;
-
- if ( ! $meta_table = _get_meta_table( $type ) )
- return false;
-
- $meta_id_column = sanitize_key( $type . '_id' );
-
- $join = array();
- $where = array();
-
- $key_only_queries = array();
- $queries = array();
-
- // Split out the queries with empty arrays as value
- foreach ( $this->queries as $k => $q ) {
- if ( isset( $q['value'] ) && is_array( $q['value'] ) && empty( $q['value'] ) ) {
- $key_only_queries[$k] = $q;
- unset( $this->queries[$k] );
- }
- }
+ $args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
+ $args = wp_parse_args( $args, $defaults );
- // Split out the meta_key only queries (we can only do this for OR)
- if ( 'OR' == $this->relation ) {
- foreach ( $this->queries as $k => $q ) {
- if ( ( empty( $q['compare'] ) || 'NOT EXISTS' != $q['compare'] ) && ! array_key_exists( 'value', $q ) && ! empty( $q['key'] ) )
- $key_only_queries[$k] = $q;
- else
- $queries[$k] = $q;
- }
+ // If `auth_callback` is not provided, fall back to `is_protected_meta()`.
+ if ( empty( $args['auth_callback'] ) ) {
+ if ( is_protected_meta( $meta_key, $object_type ) ) {
+ $args['auth_callback'] = '__return_false';
} else {
- $queries = $this->queries;
+ $args['auth_callback'] = '__return_true';
}
+ }
- // Specify all the meta_key only queries in one go
- if ( $key_only_queries ) {
- $join[] = "INNER JOIN $meta_table ON $primary_table.$primary_id_column = $meta_table.$meta_id_column";
+ // Back-compat: old sanitize and auth callbacks are applied to all of an object type.
+ if ( is_callable( $args['sanitize_callback'] ) ) {
+ add_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'], 10, 3 );
+ }
- foreach ( $key_only_queries as $key => $q )
- $where["key-only-$key"] = $wpdb->prepare( "$meta_table.meta_key = %s", trim( $q['key'] ) );
- }
+ if ( is_callable( $args['auth_callback'] ) ) {
+ add_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'], 10, 6 );
+ }
- foreach ( $queries as $k => $q ) {
- $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
- $meta_type = $this->get_cast_for_type( isset( $q['type'] ) ? $q['type'] : '' );
-
- if ( array_key_exists( 'value', $q ) && is_null( $q['value'] ) )
- $q['value'] = '';
-
- $meta_value = isset( $q['value'] ) ? $q['value'] : null;
-
- if ( isset( $q['compare'] ) )
- $meta_compare = strtoupper( $q['compare'] );
- else
- $meta_compare = is_array( $meta_value ) ? 'IN' : '=';
-
- if ( ! in_array( $meta_compare, array(
- '=', '!=', '>', '>=', '<', '<=',
- 'LIKE', 'NOT LIKE',
- 'IN', 'NOT IN',
- 'BETWEEN', 'NOT BETWEEN',
- 'NOT EXISTS',
- 'REGEXP', 'NOT REGEXP', 'RLIKE'
- ) ) )
- $meta_compare = '=';
-
- $i = count( $join );
- $alias = $i ? 'mt' . $i : $meta_table;
-
- if ( 'NOT EXISTS' == $meta_compare ) {
- $join[$i] = "LEFT JOIN $meta_table";
- $join[$i] .= $i ? " AS $alias" : '';
- $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column AND $alias.meta_key = '$meta_key')";
-
- $where[$k] = ' ' . $alias . '.' . $meta_id_column . ' IS NULL';
-
- continue;
- }
-
- $join[$i] = "INNER JOIN $meta_table";
- $join[$i] .= $i ? " AS $alias" : '';
- $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
-
- $where[$k] = '';
- if ( !empty( $meta_key ) )
- $where[$k] = $wpdb->prepare( "$alias.meta_key = %s", $meta_key );
-
- if ( is_null( $meta_value ) ) {
- if ( empty( $where[$k] ) )
- unset( $join[$i] );
- continue;
- }
-
- if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
- if ( ! is_array( $meta_value ) )
- $meta_value = preg_split( '/[,\s]+/', $meta_value );
-
- if ( empty( $meta_value ) ) {
- unset( $join[$i] );
- continue;
- }
- } else {
- $meta_value = trim( $meta_value );
- }
-
- if ( 'IN' == substr( $meta_compare, -2) ) {
- $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
- } elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
- $meta_value = array_slice( $meta_value, 0, 2 );
- $meta_compare_string = '%s AND %s';
- } elseif ( 'LIKE' == $meta_compare || 'NOT LIKE' == $meta_compare ) {
- $meta_value = '%' . $wpdb->esc_like( $meta_value ) . '%';
- $meta_compare_string = '%s';
- } else {
- $meta_compare_string = '%s';
- }
-
- if ( ! empty( $where[$k] ) )
- $where[$k] .= ' AND ';
-
- $where[$k] = ' (' . $where[$k] . $wpdb->prepare( "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string})", $meta_value );
- }
+ // Global registry only contains meta keys registered with the array of arguments added in 4.6.0.
+ if ( ! $has_old_auth_cb && ! $has_old_sanitize_cb ) {
+ $wp_meta_keys[ $object_type ][ $meta_key ] = $args;
- $where = array_filter( $where );
+ return true;
+ }
- if ( empty( $where ) )
- $where = '';
- else
- $where = ' AND (' . implode( "\n{$this->relation} ", $where ) . ' )';
+ return false;
+}
+
+/**
+ * Checks if a meta key is registered.
+ *
+ * @since 4.6.0
+ *
+ * @param string $object_type The type of object.
+ * @param string $meta_key The meta key.
+ *
+ * @return bool True if the meta key is registered to the object type. False if not.
+ */
+function registered_meta_key_exists( $object_type, $meta_key ) {
+ global $wp_meta_keys;
- $join = implode( "\n", $join );
- if ( ! empty( $join ) )
- $join = ' ' . $join;
+ if ( ! is_array( $wp_meta_keys ) ) {
+ return false;
+ }
- /**
- * Filter the meta query's generated SQL.
- *
- * @since 3.1.0
- *
- * @param array $args {
- * An array of arguments.
- *
- * @type array $clauses Array containing the query's JOIN and WHERE clauses.
- * @type array $queries Array of meta queries.
- * @type string $type Type of meta.
- * @type string $primary_table Primary table.
- * @type string $primary_id_column Primary column ID.
- * @type object $context The main query object.
- * }
- */
- return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $this->queries, $type, $primary_table, $primary_id_column, $context ) );
+ if ( ! isset( $wp_meta_keys[ $object_type ] ) ) {
+ return false;
}
+
+ if ( isset( $wp_meta_keys[ $object_type ][ $meta_key ] ) ) {
+ return true;
+ }
+
+ return false;
}
/**
- * Retrieve the name of the metadata table for the specified object type.
+ * Unregisters a meta key from the list of registered keys.
*
- * @since 2.9.0
- * @uses $wpdb WordPress database object for queries.
+ * @since 4.6.0
*
- * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
- * @return mixed Metadata table name, or false if no metadata table exists
+ * @param string $object_type The type of object.
+ * @param string $meta_key The meta key.
+ * @return bool True if successful. False if the meta key was not registered.
*/
-function _get_meta_table($type) {
- global $wpdb;
-
- $table_name = $type . 'meta';
+function unregister_meta_key( $object_type, $meta_key ) {
+ global $wp_meta_keys;
- if ( empty($wpdb->$table_name) )
+ if ( ! registered_meta_key_exists( $object_type, $meta_key ) ) {
return false;
+ }
- return $wpdb->$table_name;
+ $args = $wp_meta_keys[ $object_type ][ $meta_key ];
+
+ if ( isset( $args['sanitize_callback'] ) && is_callable( $args['sanitize_callback'] ) ) {
+ remove_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'] );
+ }
+
+ if ( isset( $args['auth_callback'] ) && is_callable( $args['auth_callback'] ) ) {
+ remove_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'] );
+ }
+
+ unset( $wp_meta_keys[ $object_type ][ $meta_key ] );
+
+ // Do some clean up
+ if ( empty( $wp_meta_keys[ $object_type ] ) ) {
+ unset( $wp_meta_keys[ $object_type ] );
+ }
+
+ return true;
}
/**
- * Determine whether a meta key is protected.
+ * Retrieves a list of registered meta keys for an object type.
*
- * @since 3.1.3
+ * @since 4.6.0
*
- * @param string $meta_key Meta key
- * @return bool True if the key is protected, false otherwise.
+ * @param string $object_type The type of object. Post, comment, user, term.
+ * @return array List of registered meta keys.
*/
-function is_protected_meta( $meta_key, $meta_type = null ) {
- $protected = ( '_' == $meta_key[0] );
+function get_registered_meta_keys( $object_type ) {
+ global $wp_meta_keys;
- /**
- * Filter whether a meta key is protected.
- *
- * @since 3.2.0
- *
- * @param bool $protected Whether the key is protected. Default false.
- * @param string $meta_key Meta key.
- * @param string $meta_type Meta type.
- */
- return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
+ if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $object_type ] ) ) {
+ return array();
+ }
+
+ return $wp_meta_keys[ $object_type ];
}
/**
- * Sanitize meta value.
+ * Retrieves registered metadata for a specified object.
*
- * @since 3.1.3
+ * @since 4.6.0
*
- * @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 $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.
+ * @return mixed A single value or array of values for a key if specified. An array of all registered keys
+ * and values for an object ID if not.
*/
-function sanitize_meta( $meta_key, $meta_value, $meta_type ) {
+function get_registered_metadata( $object_type, $object_id, $meta_key = '' ) {
+ if ( ! empty( $meta_key ) ) {
+ if ( ! registered_meta_key_exists( $object_type, $meta_key ) ) {
+ return false;
+ }
+ $meta_keys = get_registered_meta_keys( $object_type );
+ $meta_key_data = $meta_keys[ $meta_key ];
- /**
- * Filter the sanitization of a specific meta key of a specific meta type.
- *
- * The dynamic portions of the hook name, $meta_type and $meta_key, refer to the
- * metadata object type (comment, post, or user) and the meta key value,
- * respectively.
- *
- * @since 3.3.0
- *
- * @param mixed $meta_value Meta value to sanitize.
- * @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 );
+ $data = get_metadata( $object_type, $object_id, $meta_key, $meta_key_data['single'] );
+
+ return $data;
+ }
+
+ $data = get_metadata( $object_type, $object_id );
+
+ $meta_keys = get_registered_meta_keys( $object_type );
+ $registered_data = array();
+
+ // Someday, array_filter()
+ foreach ( $meta_keys as $k => $v ) {
+ if ( isset( $data[ $k ] ) ) {
+ $registered_data[ $k ] = $data[ $k ];
+ }
+ }
+
+ return $registered_data;
}
/**
- * Register meta key
+ * Filter out `register_meta()` args based on a whitelist.
+ * `register_meta()` args may change over time, so requiring the whitelist
+ * to be explicitly turned off is a warranty seal of sorts.
*
- * @since 3.3.0
+ * @access private
+ * @since 4.6.0
*
- * @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 array $args Arguments
+ * @param array $args Arguments from `register_meta()`.
+ * @param array $default_args Default arguments for `register_meta()`.
+ *
+ * @return array Filtered arguments.
*/
-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 _wp_register_meta_args_whitelist( $args, $default_args ) {
+ $whitelist = array_keys( $default_args );
- if ( empty( $auth_callback ) ) {
- if ( is_protected_meta( $meta_key, $meta_type ) )
- $auth_callback = '__return_false';
- else
- $auth_callback = '__return_true';
+ // In an anonymous function world, this would be better as an array_filter()
+ foreach ( $args as $key => $value ) {
+ if ( ! in_array( $key, $whitelist ) ) {
+ unset( $args[ $key ] );
+ }
}
- if ( is_callable( $auth_callback ) )
- add_filter( "auth_{$meta_type}_meta_{$meta_key}", $auth_callback, 10, 6 );
+ return $args;
}
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff