<?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
*/
/**
$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
* object type (comment, post, or user). Returning a non-null 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
* object type (comment, post, or user). Returning a non-null 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, $meta_key, $passed_value);
+ return add_metadata( $meta_type, $object_id, $raw_meta_key, $passed_value );
}
$_meta_value = $meta_value;
* @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 ) {
+ if ( 'post' == $meta_type ) {
/**
* Fires immediately before updating a post's metadata.
*
* @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 ) {
+ if ( 'post' == $meta_type ) {
/**
* Fires immediately after updating a post's metadata.
*
$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
* object type (comment, post, or user). Returning a non-null value
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.
}
/**
- * 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
* object type (comment, post, or user). Returning a non-null value
*
* @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 ) {
*
* @since 3.3.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @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;
- if ( ! $meta_type || ! is_numeric( $meta_id ) ) {
+ if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) {
return false;
}
- $meta_id = absint( $meta_id );
- if ( ! $meta_id ) {
+ $meta_id = intval( $meta_id );
+ if ( $meta_id <= 0 ) {
return false;
}
*
* @since 3.3.0
*
- * @global wpdb $wpdb
+ * @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
global $wpdb;
// Make sure everything is valid.
- if ( ! $meta_type || ! is_numeric( $meta_id ) ) {
+ if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) {
return false;
}
- $meta_id = absint( $meta_id );
- if ( ! $meta_id ) {
+ $meta_id = intval( $meta_id );
+ if ( $meta_id <= 0 ) {
return false;
}
*
* @since 3.3.0
*
- * @global wpdb $wpdb
+ * @global wpdb $wpdb WordPress database abstraction object.
*
- * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
+ * @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.
*/
global $wpdb;
// Make sure everything is valid.
- if ( ! $meta_type || ! is_numeric( $meta_id ) ) {
+ if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) {
return false;
}
- $meta_id = absint( $meta_id );
- if ( ! $meta_id ) {
+ $meta_id = intval( $meta_id );
+ if ( $meta_id <= 0 ) {
return false;
}
return $cache;
}
+/**
+ * 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.
*
}
/**
- * Class for generating SQL clauses that filter a primary query according to metadata keys and values.
+ * Retrieve the name of the metadata table for the specified object type.
*
- * `WP_Meta_Query` is a helper that allows primary query classes, such as {@see WP_Query} and {@see WP_User_Query},
- * to filter their results by object metadata, by generating `JOIN` and `WHERE` subclauses to be attached
- * to the primary SQL query string.
+ * @since 2.9.0
*
- * @since 3.2.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 {
- /**
- * Array of metadata queries.
- *
- * See {@see WP_Meta_Query::__construct()} for information on meta query arguments.
- *
- * @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;
-
- /**
- * Database table to query for the metadata.
- *
- * @since 4.1.0
- * @access public
- * @var string
- */
- public $meta_table;
-
- /**
- * Column in meta_table that represents the ID of the object the metadata belongs to.
- *
- * @since 4.1.0
- * @access public
- * @var string
- */
- public $meta_id_column;
-
- /**
- * Database table that where the metadata's objects are stored (eg $wpdb->users).
- *
- * @since 4.1.0
- * @access public
- * @var string
- */
- public $primary_table;
+function _get_meta_table($type) {
+ global $wpdb;
- /**
- * Column in primary_table that represents the ID of the object.
- *
- * @since 4.1.0
- * @access public
- * @var string
- */
- public $primary_id_column;
+ $table_name = $type . 'meta';
- /**
- * A flat list of table aliases used in JOIN clauses.
- *
- * @since 4.1.0
- * @access protected
- * @var array
- */
- protected $table_aliases = array();
+ if ( empty($wpdb->$table_name) )
+ return false;
- /**
- * A flat list of clauses, keyed by clause 'name'.
- *
- * @since 4.2.0
- * @access protected
- * @var array
- */
- protected $clauses = array();
+ return $wpdb->$table_name;
+}
- /**
- * Whether the query contains any OR relations.
- *
- * @since 4.3.0
- * @access protected
- * @var bool
- */
- protected $has_or_relation = false;
+/**
+ * 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] );
/**
- * Constructor.
+ * Filters whether a meta key is protected.
*
* @since 3.2.0
- * @since 4.2.0 Introduced support for naming query clauses by associative array keys.
*
- * @access public
- *
- * @param array $meta_query {
- * Array of meta query clauses. When first-order clauses use strings as their array keys, they may be
- * referenced in the 'orderby' parameter of the parent query.
- *
- * @type string $relation Optional. The MySQL keyword used to join
- * the clauses of the query. Accepts 'AND', or 'OR'. Default 'AND'.
- * @type array {
- * Optional. An array of first-order clause parameters, or another fully-formed meta query.
- *
- * @type string $key Meta key to filter by.
- * @type string $value Meta value to filter by.
- * @type string $compare MySQL operator used for comparing the $value. Accepts '=',
- * '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN',
- * 'BETWEEN', 'NOT BETWEEN', 'REGEXP', 'NOT REGEXP', or 'RLIKE'.
- * Default is 'IN' when `$value` is an array, '=' otherwise.
- * @type string $type MySQL data type that the meta_value column will be CAST to for
- * comparisons. Accepts 'NUMERIC', 'BINARY', 'CHAR', 'DATE',
- * 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', or 'UNSIGNED'.
- * Default is 'CHAR'.
- * }
- * }
+ * @param bool $protected Whether the key is protected. Default false.
+ * @param string $meta_key Meta key.
+ * @param string $meta_type Meta type.
*/
- public function __construct( $meta_query = false ) {
- if ( !$meta_query )
- return;
-
- if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
- $this->relation = 'OR';
- } else {
- $this->relation = 'AND';
- }
-
- $this->queries = $this->sanitize_query( $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 ) {
/**
- * Ensure the 'meta_query' argument passed to the class constructor is well-formed.
+ * Filters the sanitization of a specific meta key of a specific meta type.
*
- * Eliminates empty items and ensures that a 'relation' is set.
+ * 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 4.1.0
- * @access public
+ * @since 3.3.0
*
- * @param array $queries Array of query clauses.
- * @return array Sanitized array of query clauses.
+ * @param mixed $meta_value Meta value to sanitize.
+ * @param string $meta_key Meta key.
+ * @param string $object_type Object type.
*/
- public function sanitize_query( $queries ) {
- $clean_queries = array();
-
- if ( ! is_array( $queries ) ) {
- return $clean_queries;
- }
-
- foreach ( $queries as $key => $query ) {
- if ( 'relation' === $key ) {
- $relation = $query;
-
- } elseif ( ! is_array( $query ) ) {
- continue;
-
- // First-order clause.
- } elseif ( $this->is_first_order_clause( $query ) ) {
- if ( isset( $query['value'] ) && array() === $query['value'] ) {
- unset( $query['value'] );
- }
-
- $clean_queries[ $key ] = $query;
-
- // Otherwise, it's a nested query, so we recurse.
- } else {
- $cleaned_query = $this->sanitize_query( $query );
-
- if ( ! empty( $cleaned_query ) ) {
- $clean_queries[ $key ] = $cleaned_query;
- }
- }
- }
-
- if ( empty( $clean_queries ) ) {
- return $clean_queries;
- }
+ return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type );
+}
- // Sanitize the 'relation' key provided in the query.
- if ( isset( $relation ) && 'OR' === strtoupper( $relation ) ) {
- $clean_queries['relation'] = 'OR';
- $this->has_or_relation = true;
+/**
+ * Registers a meta key.
+ *
+ * @since 3.3.0
+ * @since 4.6.0 {@link https://core.trac.wordpress.org/ticket/35658 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;
- /*
- * If there is only a single clause, call the relation 'OR'.
- * This value will not actually be used to join clauses, but it
- * simplifies the logic around combining key-only queries.
- */
- } elseif ( 1 === count( $clean_queries ) ) {
- $clean_queries['relation'] = 'OR';
+ if ( ! is_array( $wp_meta_keys ) ) {
+ $wp_meta_keys = array();
+ }
- // Default to AND.
- } else {
- $clean_queries['relation'] = 'AND';
- }
+ $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,
+ );
- return $clean_queries;
+ $has_old_sanitize_cb = true;
+ } else {
+ $args = (array) $args;
}
- /**
- * Determine whether a query clause is first-order.
- *
- * A first-order meta query clause is one that has either a 'key' or
- * a 'value' array key.
- *
- * @since 4.1.0
- * @access protected
- *
- * @param array $query Meta query arguments.
- * @return bool Whether the query clause is a first-order clause.
- */
- protected function is_first_order_clause( $query ) {
- return isset( $query['key'] ) || isset( $query['value'] );
+ if ( is_callable( $deprecated ) ) {
+ $args['auth_callback'] = $deprecated;
+ $has_old_auth_cb = true;
}
/**
- * Constructs a meta query based on 'meta_*' query vars
+ * Filters the registration arguments when registering meta.
*
- * @since 3.2.0
- * @access public
+ * @since 4.6.0
*
- * @param array $qv The query variables
+ * @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 parse_query_vars( $qv ) {
- $meta_query = array();
-
- /*
- * For orderby=meta_value to work correctly, simple query needs to be
- * first (so that its table join is against an unaliased meta table) and
- * needs to be its own clause (so it doesn't interfere with the logic of
- * the rest of the meta_query).
- */
- $primary_meta_query = array();
- foreach ( array( 'key', 'compare', 'type' ) as $key ) {
- if ( ! empty( $qv[ "meta_$key" ] ) ) {
- $primary_meta_query[ $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'] ) ) {
- $primary_meta_query['value'] = $qv['meta_value'];
- }
+ $args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key );
+ $args = wp_parse_args( $args, $defaults );
- $existing_meta_query = isset( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ? $qv['meta_query'] : array();
-
- if ( ! empty( $primary_meta_query ) && ! empty( $existing_meta_query ) ) {
- $meta_query = array(
- 'relation' => 'AND',
- $primary_meta_query,
- $existing_meta_query,
- );
- } elseif ( ! empty( $primary_meta_query ) ) {
- $meta_query = array(
- $primary_meta_query,
- );
- } elseif ( ! empty( $existing_meta_query ) ) {
- $meta_query = $existing_meta_query;
+ // 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 {
+ $args['auth_callback'] = '__return_true';
}
-
- $this->__construct( $meta_query );
}
- /**
- * Return the appropriate alias for the given meta type if applicable.
- *
- * @since 3.7.0
- * @access public
- *
- * @param string $type MySQL type to cast meta_value.
- * @return string MySQL type.
- */
- public function get_cast_for_type( $type = '' ) {
- if ( empty( $type ) )
- return 'CHAR';
-
- $meta_type = strtoupper( $type );
-
- if ( ! preg_match( '/^(?:BINARY|CHAR|DATE|DATETIME|SIGNED|UNSIGNED|TIME|NUMERIC(?:\(\d+(?:,\s?\d+)?\))?|DECIMAL(?:\(\d+(?:,\s?\d+)?\))?)$/', $meta_type ) )
- return 'CHAR';
-
- if ( 'NUMERIC' == $meta_type )
- $meta_type = 'SIGNED';
-
- return $meta_type;
+ // 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 );
}
- /**
- * Generates SQL clauses to be appended to a main query.
- *
- * @since 3.2.0
- * @access public
- *
- * @param string $type Type of meta, eg 'user', 'post'.
- * @param string $primary_table Database table where the object being filtered is stored (eg wp_users).
- * @param string $primary_id_column ID column for the filtered object in $primary_table.
- * @param object $context Optional. The main query object.
- * @return false|array {
- * Array containing JOIN and WHERE SQL clauses to append to the main query.
- *
- * @type string $join SQL fragment to append to the main JOIN clause.
- * @type string $where SQL fragment to append to the main WHERE clause.
- * }
- */
- public function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
- if ( ! $meta_table = _get_meta_table( $type ) ) {
- return false;
- }
-
- $this->meta_table = $meta_table;
- $this->meta_id_column = sanitize_key( $type . '_id' );
-
- $this->primary_table = $primary_table;
- $this->primary_id_column = $primary_id_column;
-
- $sql = $this->get_sql_clauses();
-
- /*
- * If any JOINs are LEFT JOINs (as in the case of NOT EXISTS), then all JOINs should
- * be LEFT. Otherwise posts with no metadata will be excluded from results.
- */
- if ( false !== strpos( $sql['join'], 'LEFT JOIN' ) ) {
- $sql['join'] = str_replace( 'INNER JOIN', 'LEFT JOIN', $sql['join'] );
- }
-
- /**
- * Filter the meta query's generated SQL.
- *
- * @since 3.1.0
- *
- * @param array $args {
- * An array of meta query SQL 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( $sql, $this->queries, $type, $primary_table, $primary_id_column, $context ) );
+ if ( is_callable( $args['auth_callback'] ) ) {
+ add_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'], 10, 6 );
}
- /**
- * Generate SQL clauses to be appended to a main query.
- *
- * Called by the public {@see WP_Meta_Query::get_sql()}, this method
- * is abstracted out to maintain parity with the other Query classes.
- *
- * @since 4.1.0
- * @access protected
- *
- * @return array {
- * Array containing JOIN and WHERE SQL clauses to append to the main query.
- *
- * @type string $join SQL fragment to append to the main JOIN clause.
- * @type string $where SQL fragment to append to the main WHERE clause.
- * }
- */
- protected function get_sql_clauses() {
- /*
- * $queries are passed by reference to get_sql_for_query() for recursion.
- * To keep $this->queries unaltered, pass a copy.
- */
- $queries = $this->queries;
- $sql = $this->get_sql_for_query( $queries );
-
- if ( ! empty( $sql['where'] ) ) {
- $sql['where'] = ' AND ' . $sql['where'];
- }
+ // 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;
- return $sql;
+ return true;
}
- /**
- * Generate SQL clauses for a single query array.
- *
- * If nested subqueries are found, this method recurses the tree to
- * produce the properly nested SQL.
- *
- * @since 4.1.0
- * @access protected
- *
- * @param array $query Query to parse, passed by reference.
- * @param int $depth Optional. Number of tree levels deep we currently are.
- * Used to calculate indentation. Default 0.
- * @return array {
- * Array containing JOIN and WHERE SQL clauses to append to a single query array.
- *
- * @type string $join SQL fragment to append to the main JOIN clause.
- * @type string $where SQL fragment to append to the main WHERE clause.
- * }
- */
- protected function get_sql_for_query( &$query, $depth = 0 ) {
- $sql_chunks = array(
- 'join' => array(),
- 'where' => array(),
- );
-
- $sql = array(
- 'join' => '',
- 'where' => '',
- );
-
- $indent = '';
- for ( $i = 0; $i < $depth; $i++ ) {
- $indent .= " ";
- }
-
- foreach ( $query as $key => &$clause ) {
- if ( 'relation' === $key ) {
- $relation = $query['relation'];
- } elseif ( is_array( $clause ) ) {
-
- // This is a first-order clause.
- if ( $this->is_first_order_clause( $clause ) ) {
- $clause_sql = $this->get_sql_for_clause( $clause, $query, $key );
-
- $where_count = count( $clause_sql['where'] );
- if ( ! $where_count ) {
- $sql_chunks['where'][] = '';
- } elseif ( 1 === $where_count ) {
- $sql_chunks['where'][] = $clause_sql['where'][0];
- } else {
- $sql_chunks['where'][] = '( ' . implode( ' AND ', $clause_sql['where'] ) . ' )';
- }
-
- $sql_chunks['join'] = array_merge( $sql_chunks['join'], $clause_sql['join'] );
- // This is a subquery, so we recurse.
- } else {
- $clause_sql = $this->get_sql_for_query( $clause, $depth + 1 );
-
- $sql_chunks['where'][] = $clause_sql['where'];
- $sql_chunks['join'][] = $clause_sql['join'];
- }
- }
- }
-
- // Filter to remove empties.
- $sql_chunks['join'] = array_filter( $sql_chunks['join'] );
- $sql_chunks['where'] = array_filter( $sql_chunks['where'] );
-
- if ( empty( $relation ) ) {
- $relation = 'AND';
- }
-
- // Filter duplicate JOIN clauses and combine into a single string.
- if ( ! empty( $sql_chunks['join'] ) ) {
- $sql['join'] = implode( ' ', array_unique( $sql_chunks['join'] ) );
- }
+ return false;
+}
- // Generate a single WHERE clause with proper brackets and indentation.
- if ( ! empty( $sql_chunks['where'] ) ) {
- $sql['where'] = '( ' . "\n " . $indent . implode( ' ' . "\n " . $indent . $relation . ' ' . "\n " . $indent, $sql_chunks['where'] ) . "\n" . $indent . ')';
- }
+/**
+ * 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;
- return $sql;
+ if ( ! is_array( $wp_meta_keys ) ) {
+ return false;
}
- /**
- * Generate SQL JOIN and WHERE clauses for a first-order query clause.
- *
- * "First-order" means that it's an array with a 'key' or 'value'.
- *
- * @since 4.1.0
- * @access public
- *
- * @global wpdb $wpdb
- *
- * @param array $clause Query clause, passed by reference.
- * @param array $parent_query Parent query array.
- * @param string $clause_key Optional. The array key used to name the clause in the original `$meta_query`
- * parameters. If not provided, a key will be generated automatically.
- * @return array {
- * Array containing JOIN and WHERE SQL clauses to append to a first-order query.
- *
- * @type string $join SQL fragment to append to the main JOIN clause.
- * @type string $where SQL fragment to append to the main WHERE clause.
- * }
- */
- public function get_sql_for_clause( &$clause, $parent_query, $clause_key = '' ) {
- global $wpdb;
-
- $sql_chunks = array(
- 'where' => array(),
- 'join' => array(),
- );
-
- if ( isset( $clause['compare'] ) ) {
- $clause['compare'] = strtoupper( $clause['compare'] );
- } else {
- $clause['compare'] = isset( $clause['value'] ) && is_array( $clause['value'] ) ? 'IN' : '=';
- }
-
- if ( ! in_array( $clause['compare'], array(
- '=', '!=', '>', '>=', '<', '<=',
- 'LIKE', 'NOT LIKE',
- 'IN', 'NOT IN',
- 'BETWEEN', 'NOT BETWEEN',
- 'EXISTS', 'NOT EXISTS',
- 'REGEXP', 'NOT REGEXP', 'RLIKE'
- ) ) ) {
- $clause['compare'] = '=';
- }
-
- $meta_compare = $clause['compare'];
-
- // First build the JOIN clause, if one is required.
- $join = '';
-
- // We prefer to avoid joins if possible. Look for an existing join compatible with this clause.
- $alias = $this->find_compatible_table_alias( $clause, $parent_query );
- if ( false === $alias ) {
- $i = count( $this->table_aliases );
- $alias = $i ? 'mt' . $i : $this->meta_table;
-
- // JOIN clauses for NOT EXISTS have their own syntax.
- if ( 'NOT EXISTS' === $meta_compare ) {
- $join .= " LEFT JOIN $this->meta_table";
- $join .= $i ? " AS $alias" : '';
- $join .= $wpdb->prepare( " ON ($this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column AND $alias.meta_key = %s )", $clause['key'] );
-
- // All other JOIN clauses.
- } else {
- $join .= " INNER JOIN $this->meta_table";
- $join .= $i ? " AS $alias" : '';
- $join .= " ON ( $this->primary_table.$this->primary_id_column = $alias.$this->meta_id_column )";
- }
-
- $this->table_aliases[] = $alias;
- $sql_chunks['join'][] = $join;
- }
-
- // Save the alias to this clause, for future siblings to find.
- $clause['alias'] = $alias;
-
- // Determine the data type.
- $_meta_type = isset( $clause['type'] ) ? $clause['type'] : '';
- $meta_type = $this->get_cast_for_type( $_meta_type );
- $clause['cast'] = $meta_type;
-
- // Fallback for clause keys is the table alias.
- if ( ! $clause_key ) {
- $clause_key = $clause['alias'];
- }
+ if ( ! isset( $wp_meta_keys[ $object_type ] ) ) {
+ return false;
+ }
- // Ensure unique clause keys, so none are overwritten.
- $iterator = 1;
- $clause_key_base = $clause_key;
- while ( isset( $this->clauses[ $clause_key ] ) ) {
- $clause_key = $clause_key_base . '-' . $iterator;
- $iterator++;
- }
+ if ( isset( $wp_meta_keys[ $object_type ][ $meta_key ] ) ) {
+ return true;
+ }
- // Store the clause in our flat array.
- $this->clauses[ $clause_key ] =& $clause;
+ return false;
+}
- // Next, build the WHERE clause.
+/**
+ * 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.
+ * @return bool True if successful. False if the meta key was not registered.
+ */
+function unregister_meta_key( $object_type, $meta_key ) {
+ global $wp_meta_keys;
- // meta_key.
- if ( array_key_exists( 'key', $clause ) ) {
- if ( 'NOT EXISTS' === $meta_compare ) {
- $sql_chunks['where'][] = $alias . '.' . $this->meta_id_column . ' IS NULL';
- } else {
- $sql_chunks['where'][] = $wpdb->prepare( "$alias.meta_key = %s", trim( $clause['key'] ) );
- }
- }
+ if ( ! registered_meta_key_exists( $object_type, $meta_key ) ) {
+ return false;
+ }
- // meta_value.
- if ( array_key_exists( 'value', $clause ) ) {
- $meta_value = $clause['value'];
-
- if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
- if ( ! is_array( $meta_value ) ) {
- $meta_value = preg_split( '/[,\s]+/', $meta_value );
- }
- } else {
- $meta_value = trim( $meta_value );
- }
-
- switch ( $meta_compare ) {
- case 'IN' :
- case 'NOT IN' :
- $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
- $where = $wpdb->prepare( $meta_compare_string, $meta_value );
- break;
-
- case 'BETWEEN' :
- case 'NOT BETWEEN' :
- $meta_value = array_slice( $meta_value, 0, 2 );
- $where = $wpdb->prepare( '%s AND %s', $meta_value );
- break;
-
- case 'LIKE' :
- case 'NOT LIKE' :
- $meta_value = '%' . $wpdb->esc_like( $meta_value ) . '%';
- $where = $wpdb->prepare( '%s', $meta_value );
- break;
-
- // EXISTS with a value is interpreted as '='.
- case 'EXISTS' :
- $meta_compare = '=';
- $where = $wpdb->prepare( '%s', $meta_value );
- break;
-
- // 'value' is ignored for NOT EXISTS.
- case 'NOT EXISTS' :
- $where = '';
- break;
-
- default :
- $where = $wpdb->prepare( '%s', $meta_value );
- break;
-
- }
-
- if ( $where ) {
- $sql_chunks['where'][] = "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$where}";
- }
- }
+ $args = $wp_meta_keys[ $object_type ][ $meta_key ];
- /*
- * Multiple WHERE clauses (for meta_key and meta_value) should
- * be joined in parentheses.
- */
- if ( 1 < count( $sql_chunks['where'] ) ) {
- $sql_chunks['where'] = array( '( ' . implode( ' AND ', $sql_chunks['where'] ) . ' )' );
- }
-
- return $sql_chunks;
+ if ( isset( $args['sanitize_callback'] ) && is_callable( $args['sanitize_callback'] ) ) {
+ remove_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'] );
}
- /**
- * Get a flattened list of sanitized meta clauses.
- *
- * This array should be used for clause lookup, as when the table alias and CAST type must be determined for
- * a value of 'orderby' corresponding to a meta clause.
- *
- * @since 4.2.0
- * @access public
- *
- * @return array Meta clauses.
- */
- public function get_clauses() {
- return $this->clauses;
+ if ( isset( $args['auth_callback'] ) && is_callable( $args['auth_callback'] ) ) {
+ remove_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'] );
}
- /**
- * Identify an existing table alias that is compatible with the current
- * query clause.
- *
- * We avoid unnecessary table joins by allowing each clause to look for
- * an existing table alias that is compatible with the query that it
- * needs to perform.
- *
- * An existing alias is compatible if (a) it is a sibling of `$clause`
- * (ie, it's under the scope of the same relation), and (b) the combination
- * of operator and relation between the clauses allows for a shared table join.
- * In the case of {@see WP_Meta_Query}, this only applies to 'IN' clauses that
- * are connected by the relation 'OR'.
- *
- * @since 4.1.0
- * @access protected
- *
- * @param array $clause Query clause.
- * @param array $parent_query Parent query of $clause.
- * @return string|bool Table alias if found, otherwise false.
- */
- protected function find_compatible_table_alias( $clause, $parent_query ) {
- $alias = false;
-
- foreach ( $parent_query as $sibling ) {
- // If the sibling has no alias yet, there's nothing to check.
- if ( empty( $sibling['alias'] ) ) {
- continue;
- }
-
- // We're only interested in siblings that are first-order clauses.
- if ( ! is_array( $sibling ) || ! $this->is_first_order_clause( $sibling ) ) {
- continue;
- }
-
- $compatible_compares = array();
-
- // Clauses connected by OR can share joins as long as they have "positive" operators.
- if ( 'OR' === $parent_query['relation'] ) {
- $compatible_compares = array( '=', 'IN', 'BETWEEN', 'LIKE', 'REGEXP', 'RLIKE', '>', '>=', '<', '<=' );
-
- // Clauses joined by AND with "negative" operators share a join only if they also share a key.
- } elseif ( isset( $sibling['key'] ) && isset( $clause['key'] ) && $sibling['key'] === $clause['key'] ) {
- $compatible_compares = array( '!=', 'NOT IN', 'NOT LIKE' );
- }
-
- $clause_compare = strtoupper( $clause['compare'] );
- $sibling_compare = strtoupper( $sibling['compare'] );
- if ( in_array( $clause_compare, $compatible_compares ) && in_array( $sibling_compare, $compatible_compares ) ) {
- $alias = $sibling['alias'];
- break;
- }
- }
+ unset( $wp_meta_keys[ $object_type ][ $meta_key ] );
- /**
- * Filter the table alias identified as compatible with the current clause.
- *
- * @since 4.1.0
- *
- * @param string|bool $alias Table alias, or false if none was found.
- * @param array $clause First-order query clause.
- * @param array $parent_query Parent of $clause.
- * @param object $this WP_Meta_Query object.
- */
- return apply_filters( 'meta_query_find_compatible_table_alias', $alias, $clause, $parent_query, $this ) ;
+ // Do some clean up
+ if ( empty( $wp_meta_keys[ $object_type ] ) ) {
+ unset( $wp_meta_keys[ $object_type ] );
}
- /**
- * Checks whether the current query has any OR relations.
- *
- * In some cases, the presence of an OR relation somewhere in the query will require
- * the use of a `DISTINCT` or `GROUP BY` keyword in the `SELECT` clause. The current
- * method can be used in these cases to determine whether such a clause is necessary.
- *
- * @since 4.3.0
- *
- * @return bool True if the query contains any `OR` relations, otherwise false.
- */
- public function has_or_relation() {
- return $this->has_or_relation;
- }
+ return true;
}
/**
- * Retrieve the name of the metadata table for the specified object type.
+ * Retrieves a list of registered meta keys for an object type.
*
- * @since 2.9.0
+ * @since 4.6.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
+ * @param string $object_type The type of object. Post, comment, user, term.
+ * @return array List of registered meta keys.
*/
-function _get_meta_table($type) {
- global $wpdb;
+function get_registered_meta_keys( $object_type ) {
+ global $wp_meta_keys;
- $table_name = $type . 'meta';
-
- if ( empty($wpdb->$table_name) )
- return false;
+ if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $object_type ] ) ) {
+ return array();
+ }
- return $wpdb->$table_name;
+ return $wp_meta_keys[ $object_type ];
}
/**
- * Determine whether a meta key is protected.
+ * Retrieves registered metadata for a specified object.
*
- * @since 3.1.3
+ * @since 4.6.0
*
- * @param string $meta_key Meta key
- * @param string|null $meta_type
- * @return bool True if the key is protected, false otherwise.
+ * @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 is_protected_meta( $meta_key, $meta_type = null ) {
- $protected = ( '_' == $meta_key[0] );
+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 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 );
-}
+ $data = get_metadata( $object_type, $object_id, $meta_key, $meta_key_data['single'] );
-/**
- * Sanitize meta value.
- *
- * @since 3.1.3
- *
- * @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
- */
-function sanitize_meta( $meta_key, $meta_value, $meta_type ) {
+ return $data;
+ }
- /**
- * 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_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 array $args Arguments from `register_meta()`.
+ * @param array $default_args Default arguments for `register_meta()`.
*
- * @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.
+ * @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