wp-includes/meta.php

   1 <?php
   2 /**
   3  * Meta API
   4  *
   5  * Functions for retrieving and manipulating metadata
   6  *
   7  * @package WordPress
   8  * @subpackage Meta
   9  * @since 2.9.0
  10  */
  11
  12 function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
  13         if ( !$meta_type || !$meta_key )
  14                 return false;
  15
  16         if ( ! $table = _get_meta_table($meta_type) )
  17                 return false;
  18
  19         global $wpdb;
  20
  21         $column = esc_sql($meta_type . '_id');
  22
  23         // expected_slashed ($meta_key)
  24         $meta_key = stripslashes($meta_key);
  25
  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 ) ) )
  29                 return false;
  30
  31         $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
  32
  33         $wpdb->insert( $table, array(
  34                 $column => $object_id,
  35                 'meta_key' => $meta_key,
  36                 'meta_value' => $meta_value
  37         ) );
  38
  39         wp_cache_delete($object_id, $meta_type . '_meta');
  40
  41         do_action( "added_{$meta_type}_meta", $wpdb->insert_id, $object_id, $meta_key, $meta_value );
  42
  43         return true;
  44 }
  45
  46 function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
  47         if ( !$meta_type || !$meta_key )
  48                 return false;
  49
  50         if ( ! $table = _get_meta_table($meta_type) )
  51                 return false;
  52
  53         global $wpdb;
  54
  55         $column = esc_sql($meta_type . '_id');
  56
  57         // expected_slashed ($meta_key)
  58         $meta_key = stripslashes($meta_key);
  59
  60         if ( ! $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT meta_id FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) )
  61                 return add_metadata($meta_type, $object_id, $meta_key, $meta_value);
  62
  63         $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
  64
  65         $data  = compact( 'meta_value' );
  66         $where = array( $column => $object_id, 'meta_key' => $meta_key );
  67
  68         if ( !empty( $prev_value ) ) {
  69                 $prev_value = maybe_serialize($prev_value);
  70                 $where['meta_value'] = $prev_value;
  71         }
  72
  73         do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );
  74
  75         $wpdb->update( $table, $data, $where );
  76         wp_cache_delete($object_id, $meta_type . '_meta');
  77
  78         do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $meta_value );
  79
  80         return true;
  81 }
  82
  83 function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
  84         if ( !$meta_type || !$meta_key || (!$delete_all && ! (int)$object_id) )
  85                 return false;
  86
  87         if ( ! $table = _get_meta_table($meta_type) )
  88                 return false;
  89
  90         global $wpdb;
  91
  92         $type_column = esc_sql($meta_type . '_id');
  93         // expected_slashed ($meta_key)
  94         $meta_key = stripslashes($meta_key);
  95         $meta_value = maybe_serialize( stripslashes_deep($meta_value) );
  96
  97         $query = $wpdb->prepare( "SELECT meta_id FROM $table WHERE meta_key = %s", $meta_key );
  98
  99         if ( !$delete_all )
 100                 $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
 101
 102         if ( $meta_value )
 103                 $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
 104
 105         $meta_ids = $wpdb->get_col( $query );
 106         if ( !count( $meta_ids ) )
 107                 return false;
 108
 109         $query = "DELETE FROM $table WHERE meta_id IN( " . implode( ',', $meta_ids ) . " )";
 110
 111         $count = $wpdb->query($query);
 112
 113         if ( !$count )
 114                 return false;
 115
 116         wp_cache_delete($object_id, $meta_type . '_meta');
 117
 118         do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );
 119
 120         return true;
 121 }
 122
 123 function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
 124         if ( !$meta_type )
 125                 return false;
 126
 127         $meta_cache = wp_cache_get($object_id, $meta_type . '_meta');
 128
 129         if ( !$meta_cache ) {
 130                 update_meta_cache($meta_type, $object_id);
 131                 $meta_cache = wp_cache_get($object_id, $meta_type . '_meta');
 132         }
 133
 134         if ( ! $meta_key )
 135                 return $meta_cache;
 136
 137         if ( isset($meta_cache[$meta_key]) ) {
 138                 if ( $single ) {
 139                         return maybe_unserialize( $meta_cache[$meta_key][0] );
 140                 } else {
 141                         return array_map('maybe_unserialize', $meta_cache[$meta_key]);
 142                 }
 143         }
 144
 145         if ($single)
 146                 return '';
 147         else
 148                 return array();
 149 }
 150
 151 function update_meta_cache($meta_type, $object_ids) {
 152         if ( empty( $meta_type ) || empty( $object_ids ) )
 153                 return false;
 154
 155         if ( ! $table = _get_meta_table($meta_type) )
 156                 return false;
 157
 158         $column = esc_sql($meta_type . '_id');
 159
 160         global $wpdb;
 161
 162         if ( !is_array($object_ids) ) {
 163                 $object_ids = preg_replace('|[^0-9,]|', '', $object_ids);
 164                 $object_ids = explode(',', $object_ids);
 165         }
 166
 167         $object_ids = array_map('intval', $object_ids);
 168
 169         $cache_key = $meta_type . '_meta';
 170         $ids = array();
 171         foreach ( $object_ids as $id ) {
 172                 if ( false === wp_cache_get($id, $cache_key) )
 173                         $ids[] = $id;
 174         }
 175
 176         if ( empty( $ids ) )
 177                 return false;
 178
 179         // Get meta info
 180         $id_list = join(',', $ids);
 181         $cache = array();
 182         $meta_list = $wpdb->get_results( $wpdb->prepare("SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list)",
 183                 $meta_type), ARRAY_A );
 184
 185         if ( !empty($meta_list) ) {
 186                 foreach ( $meta_list as $metarow) {
 187                         $mpid = intval($metarow[$column]);
 188                         $mkey = $metarow['meta_key'];
 189                         $mval = $metarow['meta_value'];
 190
 191                         // Force subkeys to be array type:
 192                         if ( !isset($cache[$mpid]) || !is_array($cache[$mpid]) )
 193                                 $cache[$mpid] = array();
 194                         if ( !isset($cache[$mpid][$mkey]) || !is_array($cache[$mpid][$mkey]) )
 195                                 $cache[$mpid][$mkey] = array();
 196
 197                         // Add a value to the current pid/key:
 198                         $cache[$mpid][$mkey][] = $mval;
 199                 }
 200         }
 201
 202         foreach ( $ids as $id ) {
 203                 if ( ! isset($cache[$id]) )
 204                         $cache[$id] = array();
 205         }
 206
 207         foreach ( array_keys($cache) as $object)
 208                 wp_cache_set($object, $cache[$object], $cache_key);
 209
 210         return $cache;
 211 }
 212
 213 function _get_meta_table($type) {
 214         global $wpdb;
 215
 216         $table_name = $type . 'meta';
 217
 218         if ( empty($wpdb->$table_name) )
 219                 return false;
 220
 221         return $wpdb->$table_name;
 222 }
 223 ?>