5 * Functions for retrieving and manipulating metadata of various WordPress object types. Metadata
6 * for an object is a represented by a simple key-value pair. Objects may contain multiple
7 * metadata entries that share the same key and differ only in their value.
15 * Add metadata for the specified object.
18 * @uses $wpdb WordPress database object for queries.
19 * @uses do_action() Calls 'added_{$meta_type}_meta' with meta_id of added metadata entry,
20 * object ID, meta key, and meta value
22 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
23 * @param int $object_id ID of the object metadata is for
24 * @param string $meta_key Metadata key
25 * @param string $meta_value Metadata value
26 * @param bool $unique Optional, default is false. Whether the specified metadata key should be
27 * unique for the object. If true, and the object already has a value for the specified
28 * metadata key, no change will be made
29 * @return bool The meta ID on successful update, false on failure.
31 function add_metadata($meta_type, $object_id, $meta_key, $meta_value, $unique = false) {
32 if ( !$meta_type || !$meta_key )
35 if ( !$object_id = absint($object_id) )
38 if ( ! $table = _get_meta_table($meta_type) )
43 $column = esc_sql($meta_type . '_id');
45 // expected_slashed ($meta_key)
46 $meta_key = stripslashes($meta_key);
47 $meta_value = stripslashes_deep($meta_value);
48 $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
50 $check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );
51 if ( null !== $check )
54 if ( $unique && $wpdb->get_var( $wpdb->prepare(
55 "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d",
56 $meta_key, $object_id ) ) )
59 $_meta_value = $meta_value;
60 $meta_value = maybe_serialize( $meta_value );
62 do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
64 $result = $wpdb->insert( $table, array(
65 $column => $object_id,
66 'meta_key' => $meta_key,
67 'meta_value' => $meta_value
73 $mid = (int) $wpdb->insert_id;
75 wp_cache_delete($object_id, $meta_type . '_meta');
77 do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );
83 * Update metadata for the specified object. If no value already exists for the specified object
84 * ID and metadata key, the metadata will be added.
87 * @uses $wpdb WordPress database object for queries.
88 * @uses do_action() Calls 'update_{$meta_type}_meta' before updating metadata with meta_id of
89 * metadata entry to update, object ID, meta key, and meta value
90 * @uses do_action() Calls 'updated_{$meta_type}_meta' after updating metadata with meta_id of
91 * updated metadata entry, object ID, meta key, and meta value
93 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
94 * @param int $object_id ID of the object metadata is for
95 * @param string $meta_key Metadata key
96 * @param string $meta_value Metadata value
97 * @param string $prev_value Optional. If specified, only update existing metadata entries with
98 * the specified value. Otherwise, update all entries.
99 * @return bool True on successful update, false on failure.
101 function update_metadata($meta_type, $object_id, $meta_key, $meta_value, $prev_value = '') {
102 if ( !$meta_type || !$meta_key )
105 if ( !$object_id = absint($object_id) )
108 if ( ! $table = _get_meta_table($meta_type) )
113 $column = esc_sql($meta_type . '_id');
114 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
116 // expected_slashed ($meta_key)
117 $meta_key = stripslashes($meta_key);
118 $passed_value = $meta_value;
119 $meta_value = stripslashes_deep($meta_value);
120 $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
122 $check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value );
123 if ( null !== $check )
124 return (bool) $check;
126 if ( ! $meta_id = $wpdb->get_var( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ) )
127 return add_metadata($meta_type, $object_id, $meta_key, $passed_value);
129 // Compare existing value to new value if no prev value given and the key exists only once.
130 if ( empty($prev_value) ) {
131 $old_value = get_metadata($meta_type, $object_id, $meta_key);
132 if ( count($old_value) == 1 ) {
133 if ( $old_value[0] === $meta_value )
138 $_meta_value = $meta_value;
139 $meta_value = maybe_serialize( $meta_value );
141 $data = compact( 'meta_value' );
142 $where = array( $column => $object_id, 'meta_key' => $meta_key );
144 if ( !empty( $prev_value ) ) {
145 $prev_value = maybe_serialize($prev_value);
146 $where['meta_value'] = $prev_value;
149 do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
151 if ( 'post' == $meta_type )
152 do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
154 $wpdb->update( $table, $data, $where );
156 wp_cache_delete($object_id, $meta_type . '_meta');
158 do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
160 if ( 'post' == $meta_type )
161 do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
167 * Delete metadata for the specified object.
170 * @uses $wpdb WordPress database object for queries.
171 * @uses do_action() Calls 'deleted_{$meta_type}_meta' after deleting with meta_id of
172 * deleted metadata entries, object ID, meta key, and meta value
174 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
175 * @param int $object_id ID of the object metadata is for
176 * @param string $meta_key Metadata key
177 * @param string $meta_value Optional. Metadata value. If specified, only delete metadata entries
178 * with this value. Otherwise, delete all entries with the specified meta_key.
179 * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries
180 * for all objects, ignoring the specified object_id. Otherwise, only delete matching
181 * metadata entries for the specified object_id.
182 * @return bool True on successful delete, false on failure.
184 function delete_metadata($meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false) {
185 if ( !$meta_type || !$meta_key )
188 if ( (!$object_id = absint($object_id)) && !$delete_all )
191 if ( ! $table = _get_meta_table($meta_type) )
196 $type_column = esc_sql($meta_type . '_id');
197 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
198 // expected_slashed ($meta_key)
199 $meta_key = stripslashes($meta_key);
200 $meta_value = stripslashes_deep($meta_value);
202 $check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all );
203 if ( null !== $check )
204 return (bool) $check;
206 $_meta_value = $meta_value;
207 $meta_value = maybe_serialize( $meta_value );
209 $query = $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s", $meta_key );
212 $query .= $wpdb->prepare(" AND $type_column = %d", $object_id );
215 $query .= $wpdb->prepare(" AND meta_value = %s", $meta_value );
217 $meta_ids = $wpdb->get_col( $query );
218 if ( !count( $meta_ids ) )
222 $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s", $meta_key ) );
224 do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
226 if ( 'post' == $meta_type )
227 do_action( 'delete_postmeta', $meta_ids );
229 $query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . " )";
231 $count = $wpdb->query($query);
237 foreach ( (array) $object_ids as $o_id ) {
238 wp_cache_delete($o_id, $meta_type . '_meta');
241 wp_cache_delete($object_id, $meta_type . '_meta');
244 do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value );
246 if ( 'post' == $meta_type )
247 do_action( 'deleted_postmeta', $meta_ids );
253 * Retrieve metadata for the specified object.
257 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
258 * @param int $object_id ID of the object metadata is for
259 * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for
260 * the specified object.
261 * @param bool $single Optional, default is false. If true, return only the first value of the
262 * specified meta_key. This parameter has no effect if meta_key is not specified.
263 * @return string|array Single metadata value, or array of values
265 function get_metadata($meta_type, $object_id, $meta_key = '', $single = false) {
269 if ( !$object_id = absint($object_id) )
272 $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single );
273 if ( null !== $check ) {
274 if ( $single && is_array( $check ) )
280 $meta_cache = wp_cache_get($object_id, $meta_type . '_meta');
282 if ( !$meta_cache ) {
283 $meta_cache = update_meta_cache( $meta_type, array( $object_id ) );
284 $meta_cache = $meta_cache[$object_id];
290 if ( isset($meta_cache[$meta_key]) ) {
292 return maybe_unserialize( $meta_cache[$meta_key][0] );
294 return array_map('maybe_unserialize', $meta_cache[$meta_key]);
304 * Determine if a meta key is set for a given object
308 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
309 * @param int $object_id ID of the object metadata is for
310 * @param string $meta_key Metadata key.
311 * @return boolean true of the key is set, false if not.
313 function metadata_exists( $meta_type, $object_id, $meta_key ) {
317 if ( ! $object_id = absint( $object_id ) )
320 $check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true );
321 if ( null !== $check )
324 $meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' );
326 if ( !$meta_cache ) {
327 $meta_cache = update_meta_cache( $meta_type, array( $object_id ) );
328 $meta_cache = $meta_cache[$object_id];
331 if ( isset( $meta_cache[ $meta_key ] ) )
338 * Get meta data by meta ID
342 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
343 * @param int $meta_id ID for a specific meta row
344 * @return object Meta object or false.
346 function get_metadata_by_mid( $meta_type, $meta_id ) {
352 if ( !$meta_id = absint( $meta_id ) )
355 if ( ! $table = _get_meta_table($meta_type) )
358 $id_column = ( 'user' == $meta_type ) ? 'umeta_id' : 'meta_id';
360 $meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) );
362 if ( empty( $meta ) )
365 if ( isset( $meta->meta_value ) )
366 $meta->meta_value = maybe_unserialize( $meta->meta_value );
372 * Update meta data by meta ID
376 * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
377 * and object_id of the given meta_id.
379 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
380 * @param int $meta_id ID for a specific meta row
381 * @param string $meta_value Metadata value
382 * @param string $meta_key Optional, you can provide a meta key to update it
383 * @return bool True on successful update, false on failure.
385 function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key = false ) {
388 // Make sure everything is valid.
392 if ( ! $meta_id = absint( $meta_id ) )
395 if ( ! $table = _get_meta_table( $meta_type ) )
398 $column = esc_sql($meta_type . '_id');
399 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
401 // Fetch the meta and go on if it's found.
402 if ( $meta = get_metadata_by_mid( $meta_type, $meta_id ) ) {
403 $original_key = $meta->meta_key;
404 $original_value = $meta->meta_value;
405 $object_id = $meta->{$column};
407 // If a new meta_key (last parameter) was specified, change the meta key,
408 // otherwise use the original key in the update statement.
409 if ( false === $meta_key ) {
410 $meta_key = $original_key;
411 } elseif ( ! is_string( $meta_key ) ) {
416 $_meta_value = $meta_value;
417 $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type );
418 $meta_value = maybe_serialize( $meta_value );
420 // Format the data query arguments.
422 'meta_key' => $meta_key,
423 'meta_value' => $meta_value
426 // Format the where query arguments.
428 $where[$id_column] = $meta_id;
430 do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
432 if ( 'post' == $meta_type )
433 do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
435 // Run the update query, all fields in $data are %s, $where is a %d.
436 $result = (bool) $wpdb->update( $table, $data, $where, '%s', '%d' );
439 wp_cache_delete($object_id, $meta_type . '_meta');
441 do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value );
443 if ( 'post' == $meta_type )
444 do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value );
449 // And if the meta was not found.
454 * Delete meta data by meta ID
458 * @uses get_metadata_by_mid() Calls get_metadata_by_mid() to fetch the meta key, value
459 * and object_id of the given meta_id.
461 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
462 * @param int $meta_id ID for a specific meta row
463 * @return bool True on successful delete, false on failure.
465 function delete_metadata_by_mid( $meta_type, $meta_id ) {
468 // Make sure everything is valid.
472 if ( ! $meta_id = absint( $meta_id ) )
475 if ( ! $table = _get_meta_table( $meta_type ) )
478 // object and id columns
479 $column = esc_sql($meta_type . '_id');
480 $id_column = 'user' == $meta_type ? 'umeta_id' : 'meta_id';
482 // Fetch the meta and go on if it's found.
483 if ( $meta = get_metadata_by_mid( $meta_type, $meta_id ) ) {
484 $object_id = $meta->{$column};
486 do_action( "delete_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
488 if ( 'post' == $meta_type )
489 do_action( 'delete_postmeta', $meta_id );
491 // Run the query, will return true if deleted, false otherwise
492 $result = (bool) $wpdb->query( $wpdb->prepare( "DELETE FROM $table WHERE $id_column = %d LIMIT 1;", $meta_id ) );
495 wp_cache_delete($object_id, $meta_type . '_meta');
497 do_action( "deleted_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value );
499 if ( 'post' == $meta_type )
500 do_action( 'deleted_postmeta', $meta_id );
506 // Meta id was not found.
511 * Update the metadata cache for the specified objects.
514 * @uses $wpdb WordPress database object for queries.
516 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user)
517 * @param int|array $object_ids array or comma delimited list of object IDs to update cache for
518 * @return mixed Metadata cache for the specified objects, or false on failure.
520 function update_meta_cache($meta_type, $object_ids) {
521 if ( empty( $meta_type ) || empty( $object_ids ) )
524 if ( ! $table = _get_meta_table($meta_type) )
527 $column = esc_sql($meta_type . '_id');
531 if ( !is_array($object_ids) ) {
532 $object_ids = preg_replace('|[^0-9,]|', '', $object_ids);
533 $object_ids = explode(',', $object_ids);
536 $object_ids = array_map('intval', $object_ids);
538 $cache_key = $meta_type . '_meta';
541 foreach ( $object_ids as $id ) {
542 $cached_object = wp_cache_get( $id, $cache_key );
543 if ( false === $cached_object )
546 $cache[$id] = $cached_object;
553 $id_list = join(',', $ids);
554 $meta_list = $wpdb->get_results( $wpdb->prepare("SELECT $column, meta_key, meta_value FROM $table WHERE $column IN ($id_list)",
555 $meta_type), ARRAY_A );
557 if ( !empty($meta_list) ) {
558 foreach ( $meta_list as $metarow) {
559 $mpid = intval($metarow[$column]);
560 $mkey = $metarow['meta_key'];
561 $mval = $metarow['meta_value'];
563 // Force subkeys to be array type:
564 if ( !isset($cache[$mpid]) || !is_array($cache[$mpid]) )
565 $cache[$mpid] = array();
566 if ( !isset($cache[$mpid][$mkey]) || !is_array($cache[$mpid][$mkey]) )
567 $cache[$mpid][$mkey] = array();
569 // Add a value to the current pid/key:
570 $cache[$mpid][$mkey][] = $mval;
574 foreach ( $ids as $id ) {
575 if ( ! isset($cache[$id]) )
576 $cache[$id] = array();
577 wp_cache_add( $id, $cache[$id], $cache_key );
584 * Given a meta query, generates SQL clauses to be appended to a main query
590 * @param array $meta_query A meta query
591 * @param string $type Type of meta
592 * @param string $primary_table
593 * @param string $primary_id_column
594 * @param object $context (optional) The main query object
595 * @return array( 'join' => $join_sql, 'where' => $where_sql )
597 function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {
598 $meta_query_obj = new WP_Meta_Query( $meta_query );
599 return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context );
603 * Container class for a multiple metadata query
607 class WP_Meta_Query {
609 * List of metadata queries. A single query is an associative array:
610 * - 'key' string The meta key
611 * - 'value' string|array The meta value
612 * - 'compare' (optional) string How to compare the key to the value.
613 * Possible values: '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'.
615 * - 'type' string (optional) The type of the value.
616 * Possible values: 'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'.
623 public $queries = array();
626 * The relation between the queries. Can be one of 'AND' or 'OR'.
637 * @param array $meta_query (optional) A meta query
639 function __construct( $meta_query = false ) {
643 if ( isset( $meta_query['relation'] ) && strtoupper( $meta_query['relation'] ) == 'OR' ) {
644 $this->relation = 'OR';
646 $this->relation = 'AND';
649 $this->queries = array();
651 foreach ( $meta_query as $key => $query ) {
652 if ( ! is_array( $query ) )
655 $this->queries[] = $query;
660 * Constructs a meta query based on 'meta_*' query vars
665 * @param array $qv The query variables
667 function parse_query_vars( $qv ) {
668 $meta_query = array();
670 // Simple query needs to be first for orderby=meta_value to work correctly
671 foreach ( array( 'key', 'compare', 'type' ) as $key ) {
672 if ( !empty( $qv[ "meta_$key" ] ) )
673 $meta_query[0][ $key ] = $qv[ "meta_$key" ];
676 // WP_Query sets 'meta_value' = '' by default
677 if ( isset( $qv[ 'meta_value' ] ) && '' !== $qv[ 'meta_value' ] )
678 $meta_query[0]['value'] = $qv[ 'meta_value' ];
680 if ( !empty( $qv['meta_query'] ) && is_array( $qv['meta_query'] ) ) {
681 $meta_query = array_merge( $meta_query, $qv['meta_query'] );
684 $this->__construct( $meta_query );
688 * Generates SQL clauses to be appended to a main query.
693 * @param string $type Type of meta
694 * @param string $primary_table
695 * @param string $primary_id_column
696 * @param object $context (optional) The main query object
697 * @return array( 'join' => $join_sql, 'where' => $where_sql )
699 function get_sql( $type, $primary_table, $primary_id_column, $context = null ) {
702 if ( ! $meta_table = _get_meta_table( $type ) )
705 $meta_id_column = esc_sql( $type . '_id' );
710 foreach ( $this->queries as $k => $q ) {
711 $meta_key = isset( $q['key'] ) ? trim( $q['key'] ) : '';
712 $meta_type = isset( $q['type'] ) ? strtoupper( $q['type'] ) : 'CHAR';
714 if ( 'NUMERIC' == $meta_type )
715 $meta_type = 'SIGNED';
716 elseif ( ! in_array( $meta_type, array( 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED' ) ) )
720 $alias = $i ? 'mt' . $i : $meta_table;
723 $join[$i] = "INNER JOIN $meta_table";
724 $join[$i] .= $i ? " AS $alias" : '';
725 $join[$i] .= " ON ($primary_table.$primary_id_column = $alias.$meta_id_column)";
728 if ( !empty( $meta_key ) )
729 $where[$k] = $wpdb->prepare( "$alias.meta_key = %s", $meta_key );
731 if ( !isset( $q['value'] ) ) {
732 if ( empty( $where[$k] ) )
737 $meta_value = $q['value'];
739 $meta_compare = is_array( $meta_value ) ? 'IN' : '=';
740 if ( isset( $q['compare'] ) )
741 $meta_compare = strtoupper( $q['compare'] );
743 if ( ! in_array( $meta_compare, array( '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) )
746 if ( in_array( $meta_compare, array( 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN' ) ) ) {
747 if ( ! is_array( $meta_value ) )
748 $meta_value = preg_split( '/[,\s]+/', $meta_value );
750 if ( empty( $meta_value ) ) {
755 $meta_value = trim( $meta_value );
758 if ( 'IN' == substr( $meta_compare, -2) ) {
759 $meta_compare_string = '(' . substr( str_repeat( ',%s', count( $meta_value ) ), 1 ) . ')';
760 } elseif ( 'BETWEEN' == substr( $meta_compare, -7) ) {
761 $meta_value = array_slice( $meta_value, 0, 2 );
762 $meta_compare_string = '%s AND %s';
763 } elseif ( 'LIKE' == substr( $meta_compare, -4 ) ) {
764 $meta_value = '%' . like_escape( $meta_value ) . '%';
765 $meta_compare_string = '%s';
767 $meta_compare_string = '%s';
770 if ( ! empty( $where[$k] ) )
771 $where[$k] .= ' AND ';
773 $where[$k] = ' (' . $where[$k] . $wpdb->prepare( "CAST($alias.meta_value AS {$meta_type}) {$meta_compare} {$meta_compare_string})", $meta_value );
776 $where = array_filter( $where );
778 if ( empty( $where ) )
781 $where = ' AND (' . implode( "\n{$this->relation} ", $where ) . ' )';
783 $join = implode( "\n", $join );
784 if ( ! empty( $join ) )
787 return apply_filters_ref_array( 'get_meta_sql', array( compact( 'join', 'where' ), $this->queries, $type, $primary_table, $primary_id_column, $context ) );
792 * Retrieve the name of the metadata table for the specified object type.
795 * @uses $wpdb WordPress database object for queries.
797 * @param string $type Type of object to get metadata table for (e.g., comment, post, or user)
798 * @return mixed Metadata table name, or false if no metadata table exists
800 function _get_meta_table($type) {
803 $table_name = $type . 'meta';
805 if ( empty($wpdb->$table_name) )
808 return $wpdb->$table_name;
812 * Determine whether a meta key is protected
816 * @param string $meta_key Meta key
817 * @return bool True if the key is protected, false otherwise.
819 function is_protected_meta( $meta_key, $meta_type = null ) {
820 $protected = ( '_' == $meta_key[0] );
822 return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type );
826 * Sanitize meta value
830 * @param string $meta_key Meta key
831 * @param mixed $meta_value Meta value to sanitize
832 * @param string $meta_type Type of meta
833 * @return mixed Sanitized $meta_value
835 function sanitize_meta( $meta_key, $meta_value, $meta_type ) {
836 return apply_filters( "sanitize_{$meta_type}_meta_{$meta_key}", $meta_value, $meta_key, $meta_type );
844 * @param string $meta_type Type of meta
845 * @param string $meta_key Meta key
846 * @param string|array $sanitize_callback A function or method to call when sanitizing the value of $meta_key.
847 * @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.
848 * @param array $args Arguments
850 function register_meta( $meta_type, $meta_key, $sanitize_callback, $auth_callback = null ) {
851 if ( is_callable( $sanitize_callback ) )
852 add_filter( "sanitize_{$meta_type}_meta_{$meta_key}", $sanitize_callback, 10, 3 );
854 if ( empty( $auth_callback ) ) {
855 if ( is_protected_meta( $meta_key, $meta_type ) )
856 $auth_callback = '__return_false';
858 $auth_callback = '__return_true';
861 if ( is_callable( $auth_callback ) )
862 add_filter( "auth_{$meta_type}_meta_{$meta_key}", $auth_callback, 10, 6 );