5 * Functions for retrieving and manipulating metadata
12 function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
13 if ( !$meta_type || !$meta_key )
16 if ( ! $table = _get_meta_table($meta_type) )
21 $column = esc_sql($meta_type . '_id');
23 // expected_slashed ($meta_key)
24 $meta_key = stripslashes($meta_key);
26 if ( $unique && $wpdb->get_var( $wpdb->prepare(
27 "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d",
28 $meta_key, $object_id ) ) )
31 $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
33 $wpdb->insert( $table, array(
34 $column => $object_id,
35 'meta_key' => $meta_key,
36 'meta_value' => $meta_value
39 wp_cache_delete($object_id, $meta_type . '_meta');
41 do_action( "added_{$meta_type}_meta", $wpdb->insert_id, $object_id, $meta_key, $meta_value );
46 function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
47 if ( !$meta_type || !$meta_key )
50 if ( ! $table = _get_meta_table($meta_type) )
55 $column = esc_sql($meta_type . '_id');
56 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
58 // expected_slashed ($meta_key)
59 $meta_key = stripslashes($meta_key);
61 if ( ! $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) )
62 return add_metadata($meta_type, $object_id, $meta_key, $meta_value);
64 $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
66 $data = compact( 'meta_value' );
67 $where = array( $column => $object_id, 'meta_key' => $meta_key );
69 if ( !empty( $prev_value ) ) {
70 $prev_value = maybe_serialize($prev_value);
71 $where['meta_value'] = $prev_value;
74 do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );
76 $wpdb->update( $table, $data, $where );
77 wp_cache_delete($object_id, $meta_type . '_meta');
79 do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );
84 function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
85 if ( !$meta_type || !$meta_key || (!$delete_all && ! (int)$object_id) )
88 if ( ! $table = _get_meta_table($meta_type) )
93 $type_column = esc_sql($meta_type . '_id');
94 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
95 // expected_slashed ($meta_key)
96 $meta_key = stripslashes($meta_key);
97 $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
99 $query = $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s", $meta_key );
102 $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
105 $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
107 $meta_ids = $wpdb->get_col( $query );
108 if ( !count( $meta_ids ) )
111 $query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . " )";
113 $count = $wpdb->query($query);
118 wp_cache_delete($object_id, $meta_type . '_meta');
120 do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );
125 function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
129 $meta_cache = wp_cache_get($object_id, $meta_type . '_meta');
131 if ( !$meta_cache ) {
132 update_meta_cache($meta_type, $object_id);
133 $meta_cache = wp_cache_get($object_id, $meta_type . '_meta');
139 if ( isset($meta_cache[$meta_key]) ) {
141 return maybe_unserialize( $meta_cache[$meta_key][0] );
143 return array_map('maybe_unserialize', $meta_cache[$meta_key]);
153 function update_meta_cache($meta_type, $object_ids) {
154 if ( empty( $meta_type ) || empty( $object_ids ) )
157 if ( ! $table = _get_meta_table($meta_type) )
160 $column = esc_sql($meta_type . '_id');
164 if ( !is_array($object_ids) ) {
165 $object_ids = preg_replace('|[^0-9,]|', '', $object_ids);
166 $object_ids = explode(',', $object_ids);
169 $object_ids = array_map('intval', $object_ids);
171 $cache_key = $meta_type . '_meta';
173 foreach ( $object_ids as $id ) {
174 if ( false === wp_cache_get($id, $cache_key) )
182 $id_list = join(',', $ids);
184 $meta_list = $wpdb->get_results( $wpdb->prepare("SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list)",
185 $meta_type), ARRAY_A );
187 if ( !empty($meta_list) ) {
188 foreach ( $meta_list as $metarow) {
189 $mpid = intval($metarow[$column]);
190 $mkey = $metarow['meta_key'];
191 $mval = $metarow['meta_value'];
193 // Force subkeys to be array type:
194 if ( !isset($cache[$mpid]) || !is_array($cache[$mpid]) )
195 $cache[$mpid] = array();
196 if ( !isset($cache[$mpid][$mkey]) || !is_array($cache[$mpid][$mkey]) )
197 $cache[$mpid][$mkey] = array();
199 // Add a value to the current pid/key:
200 $cache[$mpid][$mkey][] = $mval;
204 foreach ( $ids as $id ) {
205 if ( ! isset($cache[$id]) )
206 $cache[$id] = array();
209 foreach ( array_keys($cache) as $object)
210 wp_cache_set($object, $cache[$object], $cache_key);
215 function _get_meta_table($type) {
218 $table_name = $type . 'meta';
220 if ( empty($wpdb->$table_name) )
223 return $wpdb->$table_name;