X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/b609ea801799cbbd5f02d95e0dc547ab53a56f4c..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-includes/meta.php diff --git a/wp-includes/meta.php b/wp-includes/meta.php index 27a12881..bfdd5956 100644 --- a/wp-includes/meta.php +++ b/wp-includes/meta.php @@ -1,54 +1,75 @@ get_var( $wpdb->prepare( "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d", @@ -58,69 +79,115 @@ function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = $_meta_value = $meta_value; $meta_value = maybe_serialize( $meta_value ); + /** + * Fires immediately before meta of a specific type is added. + * + * The dynamic portion of the hook, `$meta_type`, refers to the meta + * object type (comment, post, or user). + * + * @since 3.1.0 + * + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta value. + */ do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value ); - $wpdb->insert( $table, array( + $result = $wpdb->insert( $table, array( $column => $object_id, 'meta_key' => $meta_key, 'meta_value' => $meta_value ) ); - wp_cache_delete($object_id, $meta_type . '_meta'); - // users cache stores usermeta that must be cleared. - if ( 'user' == $meta_type ) - clean_user_cache($object_id); + if ( ! $result ) + return false; - do_action( "added_{$meta_type}_meta", $wpdb->insert_id, $object_id, $meta_key, $_meta_value ); + $mid = (int) $wpdb->insert_id; - return true; + wp_cache_delete($object_id, $meta_type . '_meta'); + + /** + * Fires immediately after meta of a specific type is added. + * + * The dynamic portion of the hook, `$meta_type`, refers to the meta + * object type (comment, post, or user). + * + * @since 2.9.0 + * + * @param int $mid The meta ID after successful update. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta value. + */ + do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value ); + + return $mid; } /** - * Update metadata for the specified object. If no value already exists for the specified object + * Update metadata for the specified object. If no value already exists for the specified object * ID and metadata key, the metadata will be added. * * @since 2.9.0 - * @uses $wpdb WordPress database object for queries. - * @uses do_action() Calls 'update_{$meta_type}_meta' before updating metadata with meta_id of - * metadata entry to update, object ID, meta key, and meta value - * @uses do_action() Calls 'updated_{$meta_type}_meta' after updating metadata with meta_id of - * updated metadata entry, object ID, meta key, and meta value * - * @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 string $meta_value Metadata value - * @param string $prev_value Optional. If specified, only update existing metadata entries with - * the specified value. Otherwise, update all entries. - * @return bool True on successful update, 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 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 = '') { - if ( !$meta_type || !$meta_key ) - return false; + global $wpdb; - if ( !$object_id = absint($object_id) ) + if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) { return false; + } - if ( ! $table = _get_meta_table($meta_type) ) + $object_id = absint( $object_id ); + if ( ! $object_id ) { return false; + } - global $wpdb; + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } - $column = esc_sql($meta_type . '_id'); + $column = sanitize_key($meta_type . '_id'); $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id'; // expected_slashed ($meta_key) - $meta_key = stripslashes($meta_key); - $meta_value = stripslashes_deep($meta_value); - + $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. + * + * 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|bool $check Whether to allow updating metadata for the given type. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta 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. + */ $check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value ); if ( null !== $check ) return (bool) $check; - 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, $meta_value); - // Compare existing value to new value if no prev value given and the key exists only once. if ( empty($prev_value) ) { $old_value = get_metadata($meta_type, $object_id, $meta_key); @@ -130,6 +197,11 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v } } + $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 ); @@ -141,15 +213,73 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v $where['meta_value'] = $prev_value; } - do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); + foreach ( $meta_ids as $meta_id ) { + /** + * 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 ) { + /** + * 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 ) + return false; - $wpdb->update( $table, $data, $where ); wp_cache_delete($object_id, $meta_type . '_meta'); - // users cache stores usermeta that must be cleared. - if ( 'user' == $meta_type ) - clean_user_cache($object_id); - do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); + foreach ( $meta_ids as $meta_id ) { + /** + * 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 ) { + /** + * 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; } @@ -158,38 +288,62 @@ function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_v * Delete metadata for the specified object. * * @since 2.9.0 - * @uses $wpdb WordPress database object for queries. - * @uses do_action() Calls 'deleted_{$meta_type}_meta' after deleting with meta_id of - * deleted metadata entries, object ID, meta key, and meta value * - * @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 string $meta_value Optional. Metadata value. 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) { - if ( !$meta_type || !$meta_key ) - return false; + global $wpdb; - if ( (!$object_id = absint($object_id)) && !$delete_all ) + if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) && ! $delete_all ) { return false; + } - if ( ! $table = _get_meta_table($meta_type) ) + $object_id = absint( $object_id ); + if ( ! $object_id && ! $delete_all ) { return false; + } - global $wpdb; + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } - $type_column = esc_sql($meta_type . '_id'); + $type_column = sanitize_key($meta_type . '_id'); $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id'; // expected_slashed ($meta_key) - $meta_key = stripslashes($meta_key); - $meta_value = stripslashes_deep($meta_value); - + $meta_key = wp_unslash($meta_key); + $meta_value = wp_unslash($meta_value); + + /** + * Filter 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 + * will effectively short-circuit the function. + * + * @since 3.1.0 + * + * @param null|bool $delete Whether to allow metadata deletion of the given type. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta value. Must be serializable if non-scalar. + * @param bool $delete_all Whether to delete the matching metadata entries + * for all objects, ignoring the specified $object_id. + * Default false. + */ $check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all ); if ( null !== $check ) return (bool) $check; @@ -202,15 +356,49 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d 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 ) { + $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 + * object type (comment, post, or user). + * + * @since 3.1.0 + * + * @param array $meta_ids An array of metadata entry IDs to delete. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta value. + */ do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value ); + // Old-style action. + if ( 'post' == $meta_type ) { + /** + * Fires immediately before deleting metadata for a post. + * + * @since 2.9.0 + * + * @param array $meta_ids An array of post metadata entry IDs to delete. + */ + do_action( 'delete_postmeta', $meta_ids ); + } + $query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . " )"; $count = $wpdb->query($query); @@ -218,13 +406,41 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d if ( !$count ) return false; - wp_cache_delete($object_id, $meta_type . '_meta'); - // users cache stores usermeta that must be cleared. - if ( 'user' == $meta_type ) - clean_user_cache($object_id); + if ( $delete_all ) { + foreach ( (array) $object_ids as $o_id ) { + wp_cache_delete($o_id, $meta_type . '_meta'); + } + } else { + wp_cache_delete($object_id, $meta_type . '_meta'); + } + /** + * Fires immediately after deleting metadata of a specific type. + * + * The dynamic portion of the hook name, `$meta_type`, refers to the meta + * object type (comment, post, or user). + * + * @since 2.9.0 + * + * @param array $meta_ids An array of deleted metadata entry IDs. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @param mixed $meta_value Meta value. + */ do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value ); + // Old-style action. + if ( 'post' == $meta_type ) { + /** + * Fires immediately after deleting metadata for a post. + * + * @since 2.9.0 + * + * @param array $meta_ids An array of deleted post metadata entry IDs. + */ + do_action( 'deleted_postmeta', $meta_ids ); + } + return true; } @@ -234,20 +450,39 @@ function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $d * @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 ) + if ( ! $meta_type || ! is_numeric( $object_id ) ) { return false; + } - if ( !$object_id = absint($object_id) ) + $object_id = absint( $object_id ); + if ( ! $object_id ) { return false; + } + /** + * Filter 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 + * 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, + * or an array of values. + * @param int $object_id Object ID. + * @param string $meta_key Meta key. + * @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 ) { if ( $single && is_array( $check ) ) @@ -263,8 +498,9 @@ function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) { $meta_cache = $meta_cache[$object_id]; } - if ( !$meta_key ) + if ( ! $meta_key ) { return $meta_cache; + } if ( isset($meta_cache[$meta_key]) ) { if ( $single ) @@ -280,26 +516,289 @@ function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) { } /** - * Update the metadata cache for the specified objects. + * Determine if a meta key is set for a given object * - * @since 2.9.0 - * @uses $wpdb WordPress database object for queries. + * @since 3.3.0 * * @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. + * @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 update_meta_cache($meta_type, $object_ids) { - if ( empty( $meta_type ) || empty( $object_ids ) ) +function metadata_exists( $meta_type, $object_id, $meta_key ) { + if ( ! $meta_type || ! is_numeric( $object_id ) ) { + return false; + } + + $object_id = absint( $object_id ); + if ( ! $object_id ) { + return false; + } + + /** This filter is documented in wp-includes/meta.php */ + $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true ); + if ( null !== $check ) + return (bool) $check; + + $meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' ); + + if ( !$meta_cache ) { + $meta_cache = update_meta_cache( $meta_type, array( $object_id ) ); + $meta_cache = $meta_cache[$object_id]; + } + + if ( isset( $meta_cache[ $meta_key ] ) ) + return true; + + return false; +} + +/** + * Get meta data by meta ID + * + * @since 3.3.0 + * + * @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; + + if ( ! $meta_type || ! is_numeric( $meta_id ) ) { + return false; + } + + $meta_id = absint( $meta_id ); + if ( ! $meta_id ) { + return false; + } + + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } + + $id_column = ( 'user' == $meta_type ) ? 'umeta_id' : 'meta_id'; + + $meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) ); + + if ( empty( $meta ) ) + return false; + + if ( isset( $meta->meta_value ) ) + $meta->meta_value = maybe_unserialize( $meta->meta_value ); + + return $meta; +} + +/** + * Update meta data by meta ID + * + * @since 3.3.0 + * + * @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_value Metadata value + * @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 ) { + global $wpdb; + + // Make sure everything is valid. + if ( ! $meta_type || ! is_numeric( $meta_id ) ) { + return false; + } + + $meta_id = absint( $meta_id ); + if ( ! $meta_id ) { + return false; + } + + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } + + $column = sanitize_key($meta_type . '_id'); + $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id'; + + // Fetch the meta and go on if it's found. + if ( $meta = get_metadata_by_mid( $meta_type, $meta_id ) ) { + $original_key = $meta->meta_key; + $object_id = $meta->{$column}; + + // If a new meta_key (last parameter) was specified, change the meta key, + // otherwise use the original key in the update statement. + if ( false === $meta_key ) { + $meta_key = $original_key; + } elseif ( ! is_string( $meta_key ) ) { + return false; + } + + // Sanitize the meta + $_meta_value = $meta_value; + $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type ); + $meta_value = maybe_serialize( $meta_value ); + + // Format the data query arguments. + $data = array( + 'meta_key' => $meta_key, + 'meta_value' => $meta_value + ); + + // Format the where query arguments. + $where = array(); + $where[$id_column] = $meta_id; + + /** This action is documented in wp-includes/meta.php */ + do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); + + if ( 'post' == $meta_type ) { + /** This action is documented in wp-includes/meta.php */ + do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); + } + + // Run the update query, all fields in $data are %s, $where is a %d. + $result = $wpdb->update( $table, $data, $where, '%s', '%d' ); + if ( ! $result ) + return false; + + // Clear the caches. + wp_cache_delete($object_id, $meta_type . '_meta'); + + /** This action is documented in wp-includes/meta.php */ + do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); + + if ( 'post' == $meta_type ) { + /** This action is documented in wp-includes/meta.php */ + do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); + } + + return true; + } + + // And if the meta was not found. + return false; +} + +/** + * Delete meta data by meta ID + * + * @since 3.3.0 + * + * @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 bool True on successful delete, false on failure. + */ +function delete_metadata_by_mid( $meta_type, $meta_id ) { + global $wpdb; + + // Make sure everything is valid. + if ( ! $meta_type || ! is_numeric( $meta_id ) ) { return false; + } - if ( ! $table = _get_meta_table($meta_type) ) + $meta_id = absint( $meta_id ); + if ( ! $meta_id ) { return false; + } - $column = esc_sql($meta_type . '_id'); + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } + // object and id columns + $column = sanitize_key($meta_type . '_id'); + $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id'; + + // Fetch the meta and go on if it's found. + if ( $meta = get_metadata_by_mid( $meta_type, $meta_id ) ) { + $object_id = $meta->{$column}; + + /** This action is documented in wp-includes/meta.php */ + do_action( "delete_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value ); + + // Old-style action. + if ( 'post' == $meta_type || 'comment' == $meta_type ) { + /** + * Fires immediately before deleting post or comment metadata of a specific type. + * + * The dynamic portion of the hook, `$meta_type`, refers to the meta + * object type (post or comment). + * + * @since 3.4.0 + * + * @param int $meta_id ID of the metadata entry to delete. + */ + do_action( "delete_{$meta_type}meta", $meta_id ); + } + + // Run the query, will return true if deleted, false otherwise + $result = (bool) $wpdb->delete( $table, array( $id_column => $meta_id ) ); + + // Clear the caches. + wp_cache_delete($object_id, $meta_type . '_meta'); + + /** This action is documented in wp-includes/meta.php */ + do_action( "deleted_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value ); + + // Old-style action. + if ( 'post' == $meta_type || 'comment' == $meta_type ) { + /** + * Fires immediately after deleting post or comment metadata of a specific type. + * + * The dynamic portion of the hook, `$meta_type`, refers to the meta + * object type (post or comment). + * + * @since 3.4.0 + * + * @param int $meta_ids Deleted metadata entry ID. + */ + do_action( "deleted_{$meta_type}meta", $meta_id ); + } + + return $result; + + } + + // Meta id was not found. + return false; +} + +/** + * Update the metadata cache for the specified objects. + * + * @since 2.9.0 + * + * @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; + if ( ! $meta_type || ! $object_ids ) { + return false; + } + + $table = _get_meta_table( $meta_type ); + if ( ! $table ) { + return false; + } + + $column = sanitize_key($meta_type . '_id'); + if ( !is_array($object_ids) ) { $object_ids = preg_replace('|[^0-9,]|', '', $object_ids); $object_ids = explode(',', $object_ids); @@ -322,9 +821,9 @@ function update_meta_cache($meta_type, $object_ids) { return $cache; // Get meta info - $id_list = join(',', $ids); - $meta_list = $wpdb->get_results( $wpdb->prepare("SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list)", - $meta_type), ARRAY_A ); + $id_list = join( ',', $ids ); + $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id'; + $meta_list = $wpdb->get_results( "SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list) ORDER BY $id_column ASC", ARRAY_A ); if ( !empty($meta_list) ) { foreach ( $meta_list as $metarow) { @@ -353,130 +852,50 @@ function update_meta_cache($meta_type, $object_ids) { } /** - * Given a meta query, generates SQL clauses to be appended to a main query - * - * @since 3.1.0 - * @access private - * - * @param array $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'. - * Default: '=' - * - 'type' string (optional) The type of the value. - * Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'. - * Default: 'CHAR' - * - * @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 ) + * Retrieves the queue for lazy-loading metadata. + * + * @since 4.5.0 + * + * @return WP_Metadata_Lazyloader $lazyloader Metadata lazyloader queue. */ -function _get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) { - global $wpdb; - - if ( ! $meta_table = _get_meta_table( $type ) ) - return false; - - $meta_id_column = esc_sql( $type . '_id' ); - - $join = ''; - $where = ''; - $i = 0; - foreach ( $meta_query as $q ) { - $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : ''; - $meta_value = isset( $q['value'] ) ? $q['value'] : ''; - $meta_compare = isset( $q['compare'] ) ? strtoupper( $q['compare'] ) : '='; - $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR'; - - if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) - $meta_compare = '='; - - if ( 'NUMERIC' == $meta_type ) - $meta_type = 'SIGNED'; - elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) ) - $meta_type = 'CHAR'; - - if ( empty( $meta_key ) && empty( $meta_value ) ) - continue; - - $alias = $i ? 'mt' . $i : $meta_table; - - $join .= "\nINNER JOIN $meta_table"; - $join .= $i ? " AS $alias" : ''; - $join .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)"; - - $i++; - - if ( !empty( $meta_key ) ) - $where .= $wpdb->prepare( " AND $alias.meta_key = %s", $meta_key ); - - 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 ); - } - - if ( empty( $meta_value ) ) - continue; - - 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' == substr( $meta_compare, -4 ) ) { - $meta_value = '%' . like_escape( $meta_value ) . '%'; - $meta_compare_string = '%s'; - } else { - $meta_compare_string = '%s'; - } - - // @todo Temporary hack to support empty values. Do not use outside of core. - if ( '_wp_zero_value' == $meta_value ) - $meta_value = 0; +function wp_metadata_lazyloader() { + static $wp_metadata_lazyloader; - $where .= $wpdb->prepare( " AND CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string}", $meta_value ); + if ( null === $wp_metadata_lazyloader ) { + $wp_metadata_lazyloader = new WP_Metadata_Lazyloader(); } - return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $meta_query, $type, $primary_table, $primary_id_column, &$context ) ); + return $wp_metadata_lazyloader; } /** - * Populates the $meta_query property + * Given a meta query, generates SQL clauses to be appended to a main query. * - * @access private - * @since 3.1.0 + * @since 3.2.0 * - * @param array $qv The query variables + * @see WP_Meta_Query + * + * @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 _parse_meta_query( &$qv ) { - $meta_query = array(); - - // Simple query needs to be first for orderby=meta_value to work correctly - foreach ( array( 'key', 'value', 'compare', 'type' ) as $key ) { - if ( !empty( $qv[ "meta_$key" ] ) ) - $meta_query[0][ $key ] = $qv[ "meta_$key" ]; - } - - if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) { - $meta_query = array_merge( $meta_query, $qv['meta_query'] ); - } - - $qv['meta_query'] = $meta_query; +function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) { + $meta_query_obj = new WP_Meta_Query( $meta_query ); + return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context ); } /** * Retrieve the name of the metadata table for the specified object type. * * @since 2.9.0 - * @uses $wpdb WordPress database object for queries. + * + * @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 mixed Metadata table name, or false if no metadata table exists + * @return string|false Metadata table name, or false if no metadata table exists */ function _get_meta_table($type) { global $wpdb; @@ -488,4 +907,81 @@ function _get_meta_table($type) { return $wpdb->$table_name; } -?> + +/** + * 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] ); + + /** + * 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 ); +} + +/** + * 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 ) { + + /** + * 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 ); +} + +/** + * Register meta key + * + * @since 3.3.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. + */ +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 ); + + if ( empty( $auth_callback ) ) { + if ( is_protected_meta( $meta_key, $meta_type ) ) + $auth_callback = '__return_false'; + else + $auth_callback = '__return_true'; + } + + if ( is_callable( $auth_callback ) ) + add_filter( "auth_{$meta_type}_meta_{$meta_key}", $auth_callback, 10, 6 ); +}