| author | ymh <ymh.work@gmail.com> |
| Tue, 15 Dec 2020 13:49:49 +0100 | |
| changeset 16 | a86126ab1dd4 |
| parent 9 | 177826044cd9 |
| child 18 | be944660c56a |
| permissions | -rw-r--r-- |
| 0 | 1 |
<?php |
2 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
3 |
* Core Metadata API |
| 0 | 4 |
* |
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. |
|
8 |
* |
|
9 |
* @package WordPress |
|
10 |
* @subpackage Meta |
|
11 |
*/ |
|
12 |
||
13 |
/** |
|
| 16 | 14 |
* Adds metadata for the specified object. |
| 0 | 15 |
* |
16 |
* @since 2.9.0 |
|
| 5 | 17 |
* |
18 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
| 0 | 19 |
* |
| 16 | 20 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
21 |
* or any other object type with an associated meta table. |
|
22 |
* @param int $object_id ID of the object metadata is for. |
|
23 |
* @param string $meta_key Metadata key. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
24 |
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar. |
| 16 | 25 |
* @param bool $unique Optional. Whether the specified metadata key should be unique for the object. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
26 |
* If true, and the object already has a value for the specified metadata key, |
| 16 | 27 |
* no change will be made. Default false. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
28 |
* @return int|false The meta ID on success, false on failure. |
| 0 | 29 |
*/ |
| 9 | 30 |
function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = false ) { |
| 5 | 31 |
global $wpdb; |
| 0 | 32 |
|
| 5 | 33 |
if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) { |
| 0 | 34 |
return false; |
| 5 | 35 |
} |
| 0 | 36 |
|
| 5 | 37 |
$object_id = absint( $object_id ); |
38 |
if ( ! $object_id ) { |
|
| 0 | 39 |
return false; |
| 5 | 40 |
} |
| 0 | 41 |
|
| 5 | 42 |
$table = _get_meta_table( $meta_type ); |
43 |
if ( ! $table ) { |
|
44 |
return false; |
|
45 |
} |
|
| 0 | 46 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
47 |
$meta_subtype = get_object_subtype( $meta_type, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
48 |
|
| 9 | 49 |
$column = sanitize_key( $meta_type . '_id' ); |
| 0 | 50 |
|
51 |
// expected_slashed ($meta_key) |
|
| 9 | 52 |
$meta_key = wp_unslash( $meta_key ); |
53 |
$meta_value = wp_unslash( $meta_value ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
54 |
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype ); |
| 0 | 55 |
|
| 5 | 56 |
/** |
| 16 | 57 |
* Short-circuits adding metadata of a specific type. |
| 5 | 58 |
* |
| 16 | 59 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
60 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
61 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 5 | 62 |
* |
63 |
* @since 3.1.0 |
|
64 |
* |
|
65 |
* @param null|bool $check Whether to allow adding metadata for the given type. |
|
| 16 | 66 |
* @param int $object_id ID of the object metadata is for. |
67 |
* @param string $meta_key Metadata key. |
|
68 |
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar. |
|
69 |
* @param bool $unique Whether the specified meta key should be unique for the object. |
|
| 5 | 70 |
*/ |
| 0 | 71 |
$check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique ); |
| 9 | 72 |
if ( null !== $check ) { |
| 0 | 73 |
return $check; |
| 9 | 74 |
} |
| 0 | 75 |
|
| 9 | 76 |
if ( $unique && $wpdb->get_var( |
77 |
$wpdb->prepare( |
|
78 |
"SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d", |
|
79 |
$meta_key, |
|
80 |
$object_id |
|
81 |
) |
|
82 |
) ) { |
|
| 0 | 83 |
return false; |
| 9 | 84 |
} |
| 0 | 85 |
|
86 |
$_meta_value = $meta_value; |
|
| 9 | 87 |
$meta_value = maybe_serialize( $meta_value ); |
| 0 | 88 |
|
| 5 | 89 |
/** |
90 |
* Fires immediately before meta of a specific type is added. |
|
91 |
* |
|
| 16 | 92 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
93 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 94 |
* |
95 |
* @since 3.1.0 |
|
96 |
* |
|
| 16 | 97 |
* @param int $object_id ID of the object metadata is for. |
98 |
* @param string $meta_key Metadata key. |
|
99 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 100 |
*/ |
| 0 | 101 |
do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value ); |
102 |
||
| 9 | 103 |
$result = $wpdb->insert( |
104 |
$table, |
|
105 |
array( |
|
106 |
$column => $object_id, |
|
107 |
'meta_key' => $meta_key, |
|
108 |
'meta_value' => $meta_value, |
|
109 |
) |
|
110 |
); |
|
| 0 | 111 |
|
| 9 | 112 |
if ( ! $result ) { |
| 0 | 113 |
return false; |
| 9 | 114 |
} |
| 0 | 115 |
|
116 |
$mid = (int) $wpdb->insert_id; |
|
117 |
||
| 9 | 118 |
wp_cache_delete( $object_id, $meta_type . '_meta' ); |
| 0 | 119 |
|
| 5 | 120 |
/** |
121 |
* Fires immediately after meta of a specific type is added. |
|
122 |
* |
|
| 16 | 123 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
124 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 125 |
* |
126 |
* @since 2.9.0 |
|
127 |
* |
|
| 9 | 128 |
* @param int $mid The meta ID after successful update. |
| 16 | 129 |
* @param int $object_id ID of the object metadata is for. |
130 |
* @param string $meta_key Metadata key. |
|
131 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 132 |
*/ |
| 0 | 133 |
do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value ); |
134 |
||
135 |
return $mid; |
|
136 |
} |
|
137 |
||
138 |
/** |
|
| 16 | 139 |
* Updates metadata for the specified object. If no value already exists for the specified object |
| 0 | 140 |
* ID and metadata key, the metadata will be added. |
141 |
* |
|
142 |
* @since 2.9.0 |
|
| 5 | 143 |
* |
144 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
| 0 | 145 |
* |
| 16 | 146 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
147 |
* or any other object type with an associated meta table. |
|
148 |
* @param int $object_id ID of the object metadata is for. |
|
149 |
* @param string $meta_key Metadata key. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
150 |
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar. |
| 16 | 151 |
* @param mixed $prev_value Optional. Previous value to check before updating. |
152 |
* If specified, only update existing metadata entries with |
|
153 |
* this value. Otherwise, update all entries. Default empty. |
|
154 |
* @return int|bool The new meta field ID if a field with the given key didn't exist |
|
155 |
* and was therefore added, true on successful update, |
|
156 |
* false on failure or if the value passed to the function |
|
157 |
* is the same as the one that is already in the database. |
|
| 0 | 158 |
*/ |
| 9 | 159 |
function update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' ) { |
| 5 | 160 |
global $wpdb; |
| 0 | 161 |
|
| 5 | 162 |
if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) { |
| 0 | 163 |
return false; |
| 5 | 164 |
} |
| 0 | 165 |
|
| 5 | 166 |
$object_id = absint( $object_id ); |
167 |
if ( ! $object_id ) { |
|
| 0 | 168 |
return false; |
| 5 | 169 |
} |
| 0 | 170 |
|
| 5 | 171 |
$table = _get_meta_table( $meta_type ); |
172 |
if ( ! $table ) { |
|
173 |
return false; |
|
174 |
} |
|
| 0 | 175 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
176 |
$meta_subtype = get_object_subtype( $meta_type, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
177 |
|
| 9 | 178 |
$column = sanitize_key( $meta_type . '_id' ); |
| 16 | 179 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
| 0 | 180 |
|
181 |
// expected_slashed ($meta_key) |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
182 |
$raw_meta_key = $meta_key; |
| 9 | 183 |
$meta_key = wp_unslash( $meta_key ); |
| 0 | 184 |
$passed_value = $meta_value; |
| 9 | 185 |
$meta_value = wp_unslash( $meta_value ); |
186 |
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype ); |
|
| 0 | 187 |
|
| 5 | 188 |
/** |
| 16 | 189 |
* Short-circuits updating metadata of a specific type. |
| 5 | 190 |
* |
| 16 | 191 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
192 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
193 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 5 | 194 |
* |
195 |
* @since 3.1.0 |
|
196 |
* |
|
197 |
* @param null|bool $check Whether to allow updating metadata for the given type. |
|
| 16 | 198 |
* @param int $object_id ID of the object metadata is for. |
199 |
* @param string $meta_key Metadata key. |
|
200 |
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar. |
|
201 |
* @param mixed $prev_value Optional. Previous value to check before updating. |
|
202 |
* If specified, only update existing metadata entries with |
|
203 |
* this value. Otherwise, update all entries. |
|
| 5 | 204 |
*/ |
| 0 | 205 |
$check = apply_filters( "update_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $prev_value ); |
| 9 | 206 |
if ( null !== $check ) { |
| 0 | 207 |
return (bool) $check; |
| 9 | 208 |
} |
| 0 | 209 |
|
210 |
// Compare existing value to new value if no prev value given and the key exists only once. |
|
| 9 | 211 |
if ( empty( $prev_value ) ) { |
| 16 | 212 |
$old_value = get_metadata_raw( $meta_type, $object_id, $meta_key ); |
213 |
if ( is_countable( $old_value ) && count( $old_value ) === 1 ) { |
|
| 9 | 214 |
if ( $old_value[0] === $meta_value ) { |
| 0 | 215 |
return false; |
| 9 | 216 |
} |
| 0 | 217 |
} |
218 |
} |
|
219 |
||
| 5 | 220 |
$meta_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s AND $column = %d", $meta_key, $object_id ) ); |
221 |
if ( empty( $meta_ids ) ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
222 |
return add_metadata( $meta_type, $object_id, $raw_meta_key, $passed_value ); |
| 5 | 223 |
} |
| 0 | 224 |
|
225 |
$_meta_value = $meta_value; |
|
| 9 | 226 |
$meta_value = maybe_serialize( $meta_value ); |
| 0 | 227 |
|
228 |
$data = compact( 'meta_value' ); |
|
| 9 | 229 |
$where = array( |
230 |
$column => $object_id, |
|
231 |
'meta_key' => $meta_key, |
|
232 |
); |
|
| 0 | 233 |
|
| 9 | 234 |
if ( ! empty( $prev_value ) ) { |
235 |
$prev_value = maybe_serialize( $prev_value ); |
|
| 0 | 236 |
$where['meta_value'] = $prev_value; |
237 |
} |
|
238 |
||
| 5 | 239 |
foreach ( $meta_ids as $meta_id ) { |
240 |
/** |
|
241 |
* Fires immediately before updating metadata of a specific type. |
|
242 |
* |
|
| 16 | 243 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
244 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 245 |
* |
246 |
* @since 2.9.0 |
|
247 |
* |
|
| 9 | 248 |
* @param int $meta_id ID of the metadata entry to update. |
| 16 | 249 |
* @param int $object_id ID of the object metadata is for. |
250 |
* @param string $meta_key Metadata key. |
|
251 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 252 |
*/ |
253 |
do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); |
|
| 0 | 254 |
|
| 16 | 255 |
if ( 'post' === $meta_type ) { |
| 5 | 256 |
/** |
257 |
* Fires immediately before updating a post's metadata. |
|
258 |
* |
|
259 |
* @since 2.9.0 |
|
260 |
* |
|
261 |
* @param int $meta_id ID of metadata entry to update. |
|
| 9 | 262 |
* @param int $object_id Post ID. |
| 16 | 263 |
* @param string $meta_key Metadata key. |
264 |
* @param mixed $meta_value Metadata value. This will be a PHP-serialized string representation of the value |
|
265 |
* if the value is an array, an object, or itself a PHP-serialized string. |
|
| 5 | 266 |
*/ |
267 |
do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); |
|
268 |
} |
|
269 |
} |
|
| 0 | 270 |
|
271 |
$result = $wpdb->update( $table, $data, $where ); |
|
| 9 | 272 |
if ( ! $result ) { |
| 0 | 273 |
return false; |
| 9 | 274 |
} |
| 0 | 275 |
|
| 9 | 276 |
wp_cache_delete( $object_id, $meta_type . '_meta' ); |
| 0 | 277 |
|
| 5 | 278 |
foreach ( $meta_ids as $meta_id ) { |
279 |
/** |
|
280 |
* Fires immediately after updating metadata of a specific type. |
|
281 |
* |
|
| 16 | 282 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
283 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 284 |
* |
285 |
* @since 2.9.0 |
|
286 |
* |
|
| 9 | 287 |
* @param int $meta_id ID of updated metadata entry. |
| 16 | 288 |
* @param int $object_id ID of the object metadata is for. |
289 |
* @param string $meta_key Metadata key. |
|
290 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 291 |
*/ |
292 |
do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); |
|
| 0 | 293 |
|
| 16 | 294 |
if ( 'post' === $meta_type ) { |
| 5 | 295 |
/** |
296 |
* Fires immediately after updating a post's metadata. |
|
297 |
* |
|
298 |
* @since 2.9.0 |
|
299 |
* |
|
300 |
* @param int $meta_id ID of updated metadata entry. |
|
| 9 | 301 |
* @param int $object_id Post ID. |
| 16 | 302 |
* @param string $meta_key Metadata key. |
303 |
* @param mixed $meta_value Metadata value. This will be a PHP-serialized string representation of the value |
|
304 |
* if the value is an array, an object, or itself a PHP-serialized string. |
|
| 5 | 305 |
*/ |
306 |
do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); |
|
307 |
} |
|
308 |
} |
|
| 0 | 309 |
|
310 |
return true; |
|
311 |
} |
|
312 |
||
313 |
/** |
|
| 16 | 314 |
* Deletes metadata for the specified object. |
| 0 | 315 |
* |
316 |
* @since 2.9.0 |
|
| 5 | 317 |
* |
318 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
| 0 | 319 |
* |
| 16 | 320 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
321 |
* or any other object type with an associated meta table. |
|
322 |
* @param int $object_id ID of the object metadata is for. |
|
323 |
* @param string $meta_key Metadata key. |
|
324 |
* @param mixed $meta_value Optional. Metadata value. Must be serializable if non-scalar. |
|
325 |
* If specified, only delete metadata entries with this value. |
|
326 |
* Otherwise, delete all entries with the specified meta_key. |
|
327 |
* Pass `null`, `false`, or an empty string to skip this check. |
|
328 |
* (For backward compatibility, it is not possible to pass an empty string |
|
329 |
* to delete those entries with an empty string for a value.) |
|
330 |
* @param bool $delete_all Optional. If true, delete matching metadata entries for all objects, |
|
331 |
* ignoring the specified object_id. Otherwise, only delete |
|
332 |
* matching metadata entries for the specified object_id. Default false. |
|
| 0 | 333 |
* @return bool True on successful delete, false on failure. |
334 |
*/ |
|
| 9 | 335 |
function delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false ) { |
| 5 | 336 |
global $wpdb; |
| 0 | 337 |
|
| 5 | 338 |
if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) && ! $delete_all ) { |
| 0 | 339 |
return false; |
| 5 | 340 |
} |
| 0 | 341 |
|
| 5 | 342 |
$object_id = absint( $object_id ); |
343 |
if ( ! $object_id && ! $delete_all ) { |
|
| 0 | 344 |
return false; |
| 5 | 345 |
} |
| 0 | 346 |
|
| 5 | 347 |
$table = _get_meta_table( $meta_type ); |
348 |
if ( ! $table ) { |
|
349 |
return false; |
|
350 |
} |
|
| 0 | 351 |
|
| 9 | 352 |
$type_column = sanitize_key( $meta_type . '_id' ); |
| 16 | 353 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
354 |
||
| 0 | 355 |
// expected_slashed ($meta_key) |
| 9 | 356 |
$meta_key = wp_unslash( $meta_key ); |
357 |
$meta_value = wp_unslash( $meta_value ); |
|
| 0 | 358 |
|
| 5 | 359 |
/** |
| 16 | 360 |
* Short-circuits deleting metadata of a specific type. |
| 5 | 361 |
* |
| 16 | 362 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
363 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
364 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 5 | 365 |
* |
366 |
* @since 3.1.0 |
|
367 |
* |
|
368 |
* @param null|bool $delete Whether to allow metadata deletion of the given type. |
|
| 16 | 369 |
* @param int $object_id ID of the object metadata is for. |
370 |
* @param string $meta_key Metadata key. |
|
371 |
* @param mixed $meta_value Metadata value. Must be serializable if non-scalar. |
|
| 5 | 372 |
* @param bool $delete_all Whether to delete the matching metadata entries |
373 |
* for all objects, ignoring the specified $object_id. |
|
374 |
* Default false. |
|
375 |
*/ |
|
| 0 | 376 |
$check = apply_filters( "delete_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $delete_all ); |
| 9 | 377 |
if ( null !== $check ) { |
| 0 | 378 |
return (bool) $check; |
| 9 | 379 |
} |
| 0 | 380 |
|
381 |
$_meta_value = $meta_value; |
|
| 9 | 382 |
$meta_value = maybe_serialize( $meta_value ); |
| 0 | 383 |
|
384 |
$query = $wpdb->prepare( "SELECT $id_column FROM $table WHERE meta_key = %s", $meta_key ); |
|
385 |
||
| 9 | 386 |
if ( ! $delete_all ) { |
387 |
$query .= $wpdb->prepare( " AND $type_column = %d", $object_id ); |
|
388 |
} |
|
| 0 | 389 |
|
| 9 | 390 |
if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) { |
391 |
$query .= $wpdb->prepare( ' AND meta_value = %s', $meta_value ); |
|
392 |
} |
|
| 0 | 393 |
|
394 |
$meta_ids = $wpdb->get_col( $query ); |
|
| 9 | 395 |
if ( ! count( $meta_ids ) ) { |
| 0 | 396 |
return false; |
| 9 | 397 |
} |
| 0 | 398 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
399 |
if ( $delete_all ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
400 |
if ( '' !== $meta_value && null !== $meta_value && false !== $meta_value ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
401 |
$object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s AND meta_value = %s", $meta_key, $meta_value ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
402 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
403 |
$object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT $type_column FROM $table WHERE meta_key = %s", $meta_key ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
404 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
405 |
} |
| 0 | 406 |
|
| 5 | 407 |
/** |
408 |
* Fires immediately before deleting metadata of a specific type. |
|
409 |
* |
|
| 16 | 410 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
411 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 412 |
* |
413 |
* @since 3.1.0 |
|
414 |
* |
|
| 16 | 415 |
* @param string[] $meta_ids An array of metadata entry IDs to delete. |
416 |
* @param int $object_id ID of the object metadata is for. |
|
417 |
* @param string $meta_key Metadata key. |
|
418 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 419 |
*/ |
| 0 | 420 |
do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value ); |
421 |
||
422 |
// Old-style action. |
|
| 16 | 423 |
if ( 'post' === $meta_type ) { |
| 5 | 424 |
/** |
425 |
* Fires immediately before deleting metadata for a post. |
|
426 |
* |
|
427 |
* @since 2.9.0 |
|
428 |
* |
|
| 16 | 429 |
* @param string[] $meta_ids An array of metadata entry IDs to delete. |
| 5 | 430 |
*/ |
| 0 | 431 |
do_action( 'delete_postmeta', $meta_ids ); |
| 5 | 432 |
} |
| 0 | 433 |
|
| 9 | 434 |
$query = "DELETE FROM $table WHERE $id_column IN( " . implode( ',', $meta_ids ) . ' )'; |
435 |
||
436 |
$count = $wpdb->query( $query ); |
|
| 0 | 437 |
|
| 9 | 438 |
if ( ! $count ) { |
| 0 | 439 |
return false; |
| 9 | 440 |
} |
| 0 | 441 |
|
442 |
if ( $delete_all ) { |
|
443 |
foreach ( (array) $object_ids as $o_id ) { |
|
| 9 | 444 |
wp_cache_delete( $o_id, $meta_type . '_meta' ); |
| 0 | 445 |
} |
446 |
} else { |
|
| 9 | 447 |
wp_cache_delete( $object_id, $meta_type . '_meta' ); |
| 0 | 448 |
} |
449 |
||
| 5 | 450 |
/** |
451 |
* Fires immediately after deleting metadata of a specific type. |
|
452 |
* |
|
| 16 | 453 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
454 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
| 5 | 455 |
* |
456 |
* @since 2.9.0 |
|
457 |
* |
|
| 16 | 458 |
* @param string[] $meta_ids An array of metadata entry IDs to delete. |
459 |
* @param int $object_id ID of the object metadata is for. |
|
460 |
* @param string $meta_key Metadata key. |
|
461 |
* @param mixed $_meta_value Metadata value. Serialized if non-scalar. |
|
| 5 | 462 |
*/ |
| 0 | 463 |
do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $_meta_value ); |
464 |
||
465 |
// Old-style action. |
|
| 16 | 466 |
if ( 'post' === $meta_type ) { |
| 5 | 467 |
/** |
468 |
* Fires immediately after deleting metadata for a post. |
|
469 |
* |
|
470 |
* @since 2.9.0 |
|
471 |
* |
|
| 16 | 472 |
* @param string[] $meta_ids An array of metadata entry IDs to delete. |
| 5 | 473 |
*/ |
| 0 | 474 |
do_action( 'deleted_postmeta', $meta_ids ); |
| 5 | 475 |
} |
| 0 | 476 |
|
477 |
return true; |
|
478 |
} |
|
479 |
||
480 |
/** |
|
| 16 | 481 |
* Retrieves the value of a metadata field for the specified object type and ID. |
482 |
* |
|
483 |
* If the meta field exists, a single value is returned if `$single` is true, |
|
484 |
* or an array of values if it's false. |
|
485 |
* |
|
486 |
* If the meta field does not exist, the result depends on get_metadata_default(). |
|
487 |
* By default, an empty string is returned if `$single` is true, or an empty array |
|
488 |
* if it's false. |
|
| 0 | 489 |
* |
490 |
* @since 2.9.0 |
|
491 |
* |
|
| 16 | 492 |
* @see get_metadata_raw() |
493 |
* @see get_metadata_default() |
|
494 |
* |
|
495 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
496 |
* or any other object type with an associated meta table. |
|
497 |
* @param int $object_id ID of the object metadata is for. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
498 |
* @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for |
| 16 | 499 |
* the specified object. Default empty. |
500 |
* @param bool $single Optional. If true, return only the first value of the specified meta_key. |
|
501 |
* This parameter has no effect if meta_key is not specified. Default false. |
|
502 |
* @return mixed Single metadata value, or array of values. |
|
503 |
* False if there's a problem with the parameters passed to the function. |
|
| 0 | 504 |
*/ |
| 9 | 505 |
function get_metadata( $meta_type, $object_id, $meta_key = '', $single = false ) { |
| 16 | 506 |
$value = get_metadata_raw( $meta_type, $object_id, $meta_key, $single ); |
507 |
if ( ! is_null( $value ) ) { |
|
508 |
return $value; |
|
509 |
} |
|
510 |
||
511 |
return get_metadata_default( $meta_type, $object_id, $meta_key, $single ); |
|
512 |
} |
|
513 |
||
514 |
/** |
|
515 |
* Retrieves raw metadata value for the specified object. |
|
516 |
* |
|
517 |
* @since 5.5.0 |
|
518 |
* |
|
519 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
520 |
* or any other object type with an associated meta table. |
|
521 |
* @param int $object_id ID of the object metadata is for. |
|
522 |
* @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for |
|
523 |
* the specified object. Default empty. |
|
524 |
* @param bool $single Optional. If true, return only the first value of the specified meta_key. |
|
525 |
* This parameter has no effect if meta_key is not specified. Default false. |
|
526 |
* @return mixed Single metadata value, or array of values. Null if the value does not exist. |
|
527 |
* False if there's a problem with the parameters passed to the function. |
|
528 |
*/ |
|
529 |
function get_metadata_raw( $meta_type, $object_id, $meta_key = '', $single = false ) { |
|
| 5 | 530 |
if ( ! $meta_type || ! is_numeric( $object_id ) ) { |
| 0 | 531 |
return false; |
| 5 | 532 |
} |
533 |
||
534 |
$object_id = absint( $object_id ); |
|
535 |
if ( ! $object_id ) { |
|
536 |
return false; |
|
537 |
} |
|
| 0 | 538 |
|
| 5 | 539 |
/** |
| 16 | 540 |
* Short-circuits the return value of a meta field. |
541 |
* |
|
542 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
|
543 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
544 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 5 | 545 |
* |
| 16 | 546 |
* Possible filter names include: |
547 |
* |
|
548 |
* - `get_post_metadata` |
|
549 |
* - `get_comment_metadata` |
|
550 |
* - `get_term_metadata` |
|
551 |
* - `get_user_metadata` |
|
| 5 | 552 |
* |
553 |
* @since 3.1.0 |
|
| 16 | 554 |
* @since 5.5.0 Added the `$meta_type` parameter. |
| 5 | 555 |
* |
| 16 | 556 |
* @param mixed $value The value to return, either a single metadata value or an array |
557 |
* of values depending on the value of `$single`. Default null. |
|
558 |
* @param int $object_id ID of the object metadata is for. |
|
559 |
* @param string $meta_key Metadata key. |
|
560 |
* @param bool $single Whether to return only the first value of the specified `$meta_key`. |
|
561 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
562 |
* or any other object type with an associated meta table. |
|
| 5 | 563 |
*/ |
| 16 | 564 |
$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, $single, $meta_type ); |
| 0 | 565 |
if ( null !== $check ) { |
| 9 | 566 |
if ( $single && is_array( $check ) ) { |
| 0 | 567 |
return $check[0]; |
| 9 | 568 |
} else { |
| 0 | 569 |
return $check; |
| 9 | 570 |
} |
| 0 | 571 |
} |
572 |
||
| 9 | 573 |
$meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' ); |
| 0 | 574 |
|
| 9 | 575 |
if ( ! $meta_cache ) { |
| 0 | 576 |
$meta_cache = update_meta_cache( $meta_type, array( $object_id ) ); |
| 16 | 577 |
if ( isset( $meta_cache[ $object_id ] ) ) { |
578 |
$meta_cache = $meta_cache[ $object_id ]; |
|
579 |
} else { |
|
580 |
$meta_cache = null; |
|
581 |
} |
|
| 0 | 582 |
} |
583 |
||
| 5 | 584 |
if ( ! $meta_key ) { |
| 0 | 585 |
return $meta_cache; |
| 5 | 586 |
} |
| 0 | 587 |
|
| 9 | 588 |
if ( isset( $meta_cache[ $meta_key ] ) ) { |
589 |
if ( $single ) { |
|
590 |
return maybe_unserialize( $meta_cache[ $meta_key ][0] ); |
|
591 |
} else { |
|
592 |
return array_map( 'maybe_unserialize', $meta_cache[ $meta_key ] ); |
|
593 |
} |
|
| 0 | 594 |
} |
595 |
||
| 16 | 596 |
return null; |
| 0 | 597 |
} |
598 |
||
599 |
/** |
|
| 16 | 600 |
* Retrieves default metadata value for the specified meta key and object. |
601 |
* |
|
602 |
* By default, an empty string is returned if `$single` is true, or an empty array |
|
603 |
* if it's false. |
|
604 |
* |
|
605 |
* @since 5.5.0 |
|
606 |
* |
|
607 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
608 |
* or any other object type with an associated meta table. |
|
609 |
* @param int $object_id ID of the object metadata is for. |
|
610 |
* @param string $meta_key Metadata key. |
|
611 |
* @param bool $single Optional. If true, return only the first value of the specified meta_key. |
|
612 |
* This parameter has no effect if meta_key is not specified. Default false. |
|
613 |
* @return mixed Single metadata value, or array of values. |
|
614 |
*/ |
|
615 |
function get_metadata_default( $meta_type, $object_id, $meta_key, $single = false ) { |
|
616 |
if ( $single ) { |
|
617 |
$value = ''; |
|
618 |
} else { |
|
619 |
$value = array(); |
|
620 |
} |
|
621 |
||
622 |
/** |
|
623 |
* Filters the default metadata value for a specified meta key and object. |
|
624 |
* |
|
625 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
|
626 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
627 |
* |
|
628 |
* Possible filter names include: |
|
629 |
* |
|
630 |
* - `default_post_metadata` |
|
631 |
* - `default_comment_metadata` |
|
632 |
* - `default_term_metadata` |
|
633 |
* - `default_user_metadata` |
|
634 |
* |
|
635 |
* @since 5.5.0 |
|
636 |
* |
|
637 |
* @param mixed $value The value to return, either a single metadata value or an array |
|
638 |
* of values depending on the value of `$single`. |
|
639 |
* @param int $object_id ID of the object metadata is for. |
|
640 |
* @param string $meta_key Metadata key. |
|
641 |
* @param bool $single Whether to return only the first value of the specified `$meta_key`. |
|
642 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
643 |
* or any other object type with an associated meta table. |
|
644 |
*/ |
|
645 |
$value = apply_filters( "default_{$meta_type}_metadata", $value, $object_id, $meta_key, $single, $meta_type ); |
|
646 |
||
647 |
if ( ! $single && ! wp_is_numeric_array( $value ) ) { |
|
648 |
$value = array( $value ); |
|
649 |
} |
|
650 |
||
651 |
return $value; |
|
652 |
} |
|
653 |
||
654 |
/** |
|
655 |
* Determines if a meta field with the given key exists for the given object ID. |
|
| 0 | 656 |
* |
657 |
* @since 3.3.0 |
|
658 |
* |
|
| 16 | 659 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
660 |
* or any other object type with an associated meta table. |
|
661 |
* @param int $object_id ID of the object metadata is for. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
662 |
* @param string $meta_key Metadata key. |
| 16 | 663 |
* @return bool Whether a meta field with the given key exists. |
| 0 | 664 |
*/ |
665 |
function metadata_exists( $meta_type, $object_id, $meta_key ) { |
|
| 5 | 666 |
if ( ! $meta_type || ! is_numeric( $object_id ) ) { |
| 0 | 667 |
return false; |
| 5 | 668 |
} |
| 0 | 669 |
|
| 5 | 670 |
$object_id = absint( $object_id ); |
671 |
if ( ! $object_id ) { |
|
| 0 | 672 |
return false; |
| 5 | 673 |
} |
| 0 | 674 |
|
| 5 | 675 |
/** This filter is documented in wp-includes/meta.php */ |
| 0 | 676 |
$check = apply_filters( "get_{$meta_type}_metadata", null, $object_id, $meta_key, true ); |
| 9 | 677 |
if ( null !== $check ) { |
| 5 | 678 |
return (bool) $check; |
| 9 | 679 |
} |
| 0 | 680 |
|
681 |
$meta_cache = wp_cache_get( $object_id, $meta_type . '_meta' ); |
|
682 |
||
| 9 | 683 |
if ( ! $meta_cache ) { |
| 0 | 684 |
$meta_cache = update_meta_cache( $meta_type, array( $object_id ) ); |
| 9 | 685 |
$meta_cache = $meta_cache[ $object_id ]; |
| 0 | 686 |
} |
687 |
||
| 9 | 688 |
if ( isset( $meta_cache[ $meta_key ] ) ) { |
| 0 | 689 |
return true; |
| 9 | 690 |
} |
| 0 | 691 |
|
692 |
return false; |
|
693 |
} |
|
694 |
||
695 |
/** |
|
| 16 | 696 |
* Retrieves metadata by meta ID. |
| 0 | 697 |
* |
698 |
* @since 3.3.0 |
|
699 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
700 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
701 |
* |
| 16 | 702 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
703 |
* or any other object type with an associated meta table. |
|
704 |
* @param int $meta_id ID for a specific meta row. |
|
705 |
* @return stdClass|false { |
|
706 |
* Metadata object, or boolean `false` if the metadata doesn't exist. |
|
707 |
* |
|
708 |
* @type string $meta_key The meta key. |
|
709 |
* @type mixed $meta_value The unserialized meta value. |
|
710 |
* @type string $meta_id Optional. The meta ID when the meta type is any value except 'user'. |
|
711 |
* @type string $umeta_id Optional. The meta ID when the meta type is 'user'. |
|
712 |
* @type string $post_id Optional. The object ID when the meta type is 'post'. |
|
713 |
* @type string $comment_id Optional. The object ID when the meta type is 'comment'. |
|
714 |
* @type string $term_id Optional. The object ID when the meta type is 'term'. |
|
715 |
* @type string $user_id Optional. The object ID when the meta type is 'user'. |
|
716 |
* } |
|
| 0 | 717 |
*/ |
718 |
function get_metadata_by_mid( $meta_type, $meta_id ) { |
|
719 |
global $wpdb; |
|
720 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
721 |
if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) { |
| 0 | 722 |
return false; |
| 5 | 723 |
} |
| 0 | 724 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
725 |
$meta_id = intval( $meta_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
726 |
if ( $meta_id <= 0 ) { |
| 0 | 727 |
return false; |
| 5 | 728 |
} |
| 0 | 729 |
|
| 5 | 730 |
$table = _get_meta_table( $meta_type ); |
731 |
if ( ! $table ) { |
|
| 0 | 732 |
return false; |
| 5 | 733 |
} |
| 0 | 734 |
|
| 9 | 735 |
/** |
| 16 | 736 |
* Short-circuits the return value when fetching a meta field by meta ID. |
| 9 | 737 |
* |
| 16 | 738 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
739 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
740 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 9 | 741 |
* |
742 |
* @since 5.0.0 |
|
743 |
* |
|
| 16 | 744 |
* @param stdClass|null $value The value to return. |
745 |
* @param int $meta_id Meta ID. |
|
| 9 | 746 |
*/ |
747 |
$check = apply_filters( "get_{$meta_type}_metadata_by_mid", null, $meta_id ); |
|
748 |
if ( null !== $check ) { |
|
749 |
return $check; |
|
750 |
} |
|
751 |
||
| 16 | 752 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
753 |
||
| 0 | 754 |
$meta = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM $table WHERE $id_column = %d", $meta_id ) ); |
755 |
||
| 9 | 756 |
if ( empty( $meta ) ) { |
| 0 | 757 |
return false; |
| 9 | 758 |
} |
| 0 | 759 |
|
| 9 | 760 |
if ( isset( $meta->meta_value ) ) { |
| 0 | 761 |
$meta->meta_value = maybe_unserialize( $meta->meta_value ); |
| 9 | 762 |
} |
| 0 | 763 |
|
764 |
return $meta; |
|
765 |
} |
|
766 |
||
767 |
/** |
|
| 16 | 768 |
* Updates metadata by meta ID. |
| 0 | 769 |
* |
770 |
* @since 3.3.0 |
|
771 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
772 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
773 |
* |
| 16 | 774 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
775 |
* or any other object type with an associated meta table. |
|
776 |
* @param int $meta_id ID for a specific meta row. |
|
777 |
* @param string $meta_value Metadata value. Must be serializable if non-scalar. |
|
778 |
* @param string $meta_key Optional. You can provide a meta key to update it. Default false. |
|
| 0 | 779 |
* @return bool True on successful update, false on failure. |
780 |
*/ |
|
781 |
function update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key = false ) { |
|
782 |
global $wpdb; |
|
783 |
||
784 |
// Make sure everything is valid. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
785 |
if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) { |
| 0 | 786 |
return false; |
| 5 | 787 |
} |
| 0 | 788 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
789 |
$meta_id = intval( $meta_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
790 |
if ( $meta_id <= 0 ) { |
| 0 | 791 |
return false; |
| 5 | 792 |
} |
| 0 | 793 |
|
| 5 | 794 |
$table = _get_meta_table( $meta_type ); |
795 |
if ( ! $table ) { |
|
| 0 | 796 |
return false; |
| 5 | 797 |
} |
| 0 | 798 |
|
| 9 | 799 |
$column = sanitize_key( $meta_type . '_id' ); |
| 16 | 800 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
| 0 | 801 |
|
| 9 | 802 |
/** |
| 16 | 803 |
* Short-circuits updating metadata of a specific type by meta ID. |
| 9 | 804 |
* |
| 16 | 805 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
806 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
807 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 9 | 808 |
* |
809 |
* @since 5.0.0 |
|
810 |
* |
|
811 |
* @param null|bool $check Whether to allow updating metadata for the given type. |
|
812 |
* @param int $meta_id Meta ID. |
|
813 |
* @param mixed $meta_value Meta value. Must be serializable if non-scalar. |
|
814 |
* @param string|bool $meta_key Meta key, if provided. |
|
815 |
*/ |
|
816 |
$check = apply_filters( "update_{$meta_type}_metadata_by_mid", null, $meta_id, $meta_value, $meta_key ); |
|
817 |
if ( null !== $check ) { |
|
818 |
return (bool) $check; |
|
819 |
} |
|
820 |
||
| 0 | 821 |
// Fetch the meta and go on if it's found. |
| 16 | 822 |
$meta = get_metadata_by_mid( $meta_type, $meta_id ); |
823 |
if ( $meta ) { |
|
| 0 | 824 |
$original_key = $meta->meta_key; |
| 9 | 825 |
$object_id = $meta->{$column}; |
| 0 | 826 |
|
827 |
// If a new meta_key (last parameter) was specified, change the meta key, |
|
828 |
// otherwise use the original key in the update statement. |
|
829 |
if ( false === $meta_key ) { |
|
830 |
$meta_key = $original_key; |
|
831 |
} elseif ( ! is_string( $meta_key ) ) { |
|
832 |
return false; |
|
833 |
} |
|
834 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
835 |
$meta_subtype = get_object_subtype( $meta_type, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
836 |
|
| 16 | 837 |
// Sanitize the meta. |
| 0 | 838 |
$_meta_value = $meta_value; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
839 |
$meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
840 |
$meta_value = maybe_serialize( $meta_value ); |
| 0 | 841 |
|
842 |
// Format the data query arguments. |
|
843 |
$data = array( |
|
| 9 | 844 |
'meta_key' => $meta_key, |
845 |
'meta_value' => $meta_value, |
|
| 0 | 846 |
); |
847 |
||
848 |
// Format the where query arguments. |
|
| 9 | 849 |
$where = array(); |
850 |
$where[ $id_column ] = $meta_id; |
|
| 0 | 851 |
|
| 5 | 852 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 853 |
do_action( "update_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); |
854 |
||
| 16 | 855 |
if ( 'post' === $meta_type ) { |
| 5 | 856 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 857 |
do_action( 'update_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); |
| 5 | 858 |
} |
| 0 | 859 |
|
860 |
// Run the update query, all fields in $data are %s, $where is a %d. |
|
861 |
$result = $wpdb->update( $table, $data, $where, '%s', '%d' ); |
|
| 9 | 862 |
if ( ! $result ) { |
| 0 | 863 |
return false; |
| 9 | 864 |
} |
| 0 | 865 |
|
866 |
// Clear the caches. |
|
| 9 | 867 |
wp_cache_delete( $object_id, $meta_type . '_meta' ); |
| 0 | 868 |
|
| 5 | 869 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 870 |
do_action( "updated_{$meta_type}_meta", $meta_id, $object_id, $meta_key, $_meta_value ); |
871 |
||
| 16 | 872 |
if ( 'post' === $meta_type ) { |
| 5 | 873 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 874 |
do_action( 'updated_postmeta', $meta_id, $object_id, $meta_key, $meta_value ); |
| 5 | 875 |
} |
| 0 | 876 |
|
877 |
return true; |
|
878 |
} |
|
879 |
||
880 |
// And if the meta was not found. |
|
881 |
return false; |
|
882 |
} |
|
883 |
||
884 |
/** |
|
| 16 | 885 |
* Deletes metadata by meta ID. |
| 0 | 886 |
* |
887 |
* @since 3.3.0 |
|
888 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
889 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
890 |
* |
| 16 | 891 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
892 |
* or any other object type with an associated meta table. |
|
893 |
* @param int $meta_id ID for a specific meta row. |
|
| 0 | 894 |
* @return bool True on successful delete, false on failure. |
895 |
*/ |
|
896 |
function delete_metadata_by_mid( $meta_type, $meta_id ) { |
|
897 |
global $wpdb; |
|
898 |
||
899 |
// Make sure everything is valid. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
900 |
if ( ! $meta_type || ! is_numeric( $meta_id ) || floor( $meta_id ) != $meta_id ) { |
| 0 | 901 |
return false; |
| 5 | 902 |
} |
| 0 | 903 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
904 |
$meta_id = intval( $meta_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
905 |
if ( $meta_id <= 0 ) { |
| 0 | 906 |
return false; |
| 5 | 907 |
} |
| 0 | 908 |
|
| 5 | 909 |
$table = _get_meta_table( $meta_type ); |
910 |
if ( ! $table ) { |
|
| 0 | 911 |
return false; |
| 5 | 912 |
} |
| 0 | 913 |
|
| 16 | 914 |
// Object and ID columns. |
| 9 | 915 |
$column = sanitize_key( $meta_type . '_id' ); |
| 16 | 916 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
| 0 | 917 |
|
| 9 | 918 |
/** |
| 16 | 919 |
* Short-circuits deleting metadata of a specific type by meta ID. |
| 9 | 920 |
* |
| 16 | 921 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
922 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
923 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 9 | 924 |
* |
925 |
* @since 5.0.0 |
|
926 |
* |
|
927 |
* @param null|bool $delete Whether to allow metadata deletion of the given type. |
|
928 |
* @param int $meta_id Meta ID. |
|
929 |
*/ |
|
930 |
$check = apply_filters( "delete_{$meta_type}_metadata_by_mid", null, $meta_id ); |
|
931 |
if ( null !== $check ) { |
|
932 |
return (bool) $check; |
|
933 |
} |
|
934 |
||
| 0 | 935 |
// Fetch the meta and go on if it's found. |
| 16 | 936 |
$meta = get_metadata_by_mid( $meta_type, $meta_id ); |
937 |
if ( $meta ) { |
|
| 9 | 938 |
$object_id = (int) $meta->{$column}; |
| 0 | 939 |
|
| 5 | 940 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 941 |
do_action( "delete_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value ); |
942 |
||
943 |
// Old-style action. |
|
| 16 | 944 |
if ( 'post' === $meta_type || 'comment' === $meta_type ) { |
| 5 | 945 |
/** |
946 |
* Fires immediately before deleting post or comment metadata of a specific type. |
|
947 |
* |
|
948 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta |
|
949 |
* object type (post or comment). |
|
950 |
* |
|
951 |
* @since 3.4.0 |
|
952 |
* |
|
953 |
* @param int $meta_id ID of the metadata entry to delete. |
|
954 |
*/ |
|
| 0 | 955 |
do_action( "delete_{$meta_type}meta", $meta_id ); |
| 5 | 956 |
} |
| 0 | 957 |
|
| 16 | 958 |
// Run the query, will return true if deleted, false otherwise. |
| 0 | 959 |
$result = (bool) $wpdb->delete( $table, array( $id_column => $meta_id ) ); |
960 |
||
961 |
// Clear the caches. |
|
| 9 | 962 |
wp_cache_delete( $object_id, $meta_type . '_meta' ); |
| 0 | 963 |
|
| 5 | 964 |
/** This action is documented in wp-includes/meta.php */ |
| 0 | 965 |
do_action( "deleted_{$meta_type}_meta", (array) $meta_id, $object_id, $meta->meta_key, $meta->meta_value ); |
966 |
||
967 |
// Old-style action. |
|
| 16 | 968 |
if ( 'post' === $meta_type || 'comment' === $meta_type ) { |
| 5 | 969 |
/** |
970 |
* Fires immediately after deleting post or comment metadata of a specific type. |
|
971 |
* |
|
972 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta |
|
973 |
* object type (post or comment). |
|
974 |
* |
|
975 |
* @since 3.4.0 |
|
976 |
* |
|
977 |
* @param int $meta_ids Deleted metadata entry ID. |
|
978 |
*/ |
|
| 0 | 979 |
do_action( "deleted_{$meta_type}meta", $meta_id ); |
| 5 | 980 |
} |
| 0 | 981 |
|
982 |
return $result; |
|
983 |
||
984 |
} |
|
985 |
||
| 16 | 986 |
// Meta ID was not found. |
| 0 | 987 |
return false; |
988 |
} |
|
989 |
||
990 |
/** |
|
| 16 | 991 |
* Updates the metadata cache for the specified objects. |
| 0 | 992 |
* |
993 |
* @since 2.9.0 |
|
| 5 | 994 |
* |
995 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
| 0 | 996 |
* |
| 16 | 997 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
998 |
* or any other object type with an associated meta table. |
|
999 |
* @param string|int[] $object_ids Array or comma delimited list of object IDs to update cache for. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1000 |
* @return array|false Metadata cache for the specified objects, or false on failure. |
| 0 | 1001 |
*/ |
| 9 | 1002 |
function update_meta_cache( $meta_type, $object_ids ) { |
| 5 | 1003 |
global $wpdb; |
| 0 | 1004 |
|
| 5 | 1005 |
if ( ! $meta_type || ! $object_ids ) { |
| 0 | 1006 |
return false; |
| 5 | 1007 |
} |
1008 |
||
1009 |
$table = _get_meta_table( $meta_type ); |
|
1010 |
if ( ! $table ) { |
|
1011 |
return false; |
|
1012 |
} |
|
| 0 | 1013 |
|
| 9 | 1014 |
$column = sanitize_key( $meta_type . '_id' ); |
| 0 | 1015 |
|
| 9 | 1016 |
if ( ! is_array( $object_ids ) ) { |
1017 |
$object_ids = preg_replace( '|[^0-9,]|', '', $object_ids ); |
|
1018 |
$object_ids = explode( ',', $object_ids ); |
|
| 0 | 1019 |
} |
1020 |
||
| 9 | 1021 |
$object_ids = array_map( 'intval', $object_ids ); |
1022 |
||
1023 |
/** |
|
| 16 | 1024 |
* Short-circuits updating the metadata cache of a specific type. |
| 9 | 1025 |
* |
| 16 | 1026 |
* The dynamic portion of the hook, `$meta_type`, refers to the meta object type |
1027 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
1028 |
* Returning a non-null value will effectively short-circuit the function. |
|
| 9 | 1029 |
* |
1030 |
* @since 5.0.0 |
|
1031 |
* |
|
1032 |
* @param mixed $check Whether to allow updating the meta cache of the given type. |
|
| 16 | 1033 |
* @param int[] $object_ids Array of object IDs to update the meta cache for. |
| 9 | 1034 |
*/ |
1035 |
$check = apply_filters( "update_{$meta_type}_metadata_cache", null, $object_ids ); |
|
1036 |
if ( null !== $check ) { |
|
1037 |
return (bool) $check; |
|
1038 |
} |
|
| 0 | 1039 |
|
| 16 | 1040 |
$cache_key = $meta_type . '_meta'; |
1041 |
$non_cached_ids = array(); |
|
1042 |
$cache = array(); |
|
1043 |
$cache_values = wp_cache_get_multiple( $object_ids, $cache_key ); |
|
1044 |
||
1045 |
foreach ( $cache_values as $id => $cached_object ) { |
|
| 9 | 1046 |
if ( false === $cached_object ) { |
| 16 | 1047 |
$non_cached_ids[] = $id; |
| 9 | 1048 |
} else { |
1049 |
$cache[ $id ] = $cached_object; |
|
1050 |
} |
|
| 0 | 1051 |
} |
1052 |
||
| 16 | 1053 |
if ( empty( $non_cached_ids ) ) { |
| 0 | 1054 |
return $cache; |
| 9 | 1055 |
} |
| 0 | 1056 |
|
| 16 | 1057 |
// Get meta info. |
1058 |
$id_list = join( ',', $non_cached_ids ); |
|
1059 |
$id_column = ( 'user' === $meta_type ) ? 'umeta_id' : 'meta_id'; |
|
1060 |
||
| 5 | 1061 |
$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 ); |
| 0 | 1062 |
|
| 9 | 1063 |
if ( ! empty( $meta_list ) ) { |
1064 |
foreach ( $meta_list as $metarow ) { |
|
1065 |
$mpid = intval( $metarow[ $column ] ); |
|
| 0 | 1066 |
$mkey = $metarow['meta_key']; |
1067 |
$mval = $metarow['meta_value']; |
|
1068 |
||
| 16 | 1069 |
// Force subkeys to be array type. |
| 9 | 1070 |
if ( ! isset( $cache[ $mpid ] ) || ! is_array( $cache[ $mpid ] ) ) { |
1071 |
$cache[ $mpid ] = array(); |
|
1072 |
} |
|
1073 |
if ( ! isset( $cache[ $mpid ][ $mkey ] ) || ! is_array( $cache[ $mpid ][ $mkey ] ) ) { |
|
1074 |
$cache[ $mpid ][ $mkey ] = array(); |
|
1075 |
} |
|
| 0 | 1076 |
|
| 16 | 1077 |
// Add a value to the current pid/key. |
| 9 | 1078 |
$cache[ $mpid ][ $mkey ][] = $mval; |
| 0 | 1079 |
} |
1080 |
} |
|
1081 |
||
| 16 | 1082 |
foreach ( $non_cached_ids as $id ) { |
| 9 | 1083 |
if ( ! isset( $cache[ $id ] ) ) { |
1084 |
$cache[ $id ] = array(); |
|
1085 |
} |
|
1086 |
wp_cache_add( $id, $cache[ $id ], $cache_key ); |
|
| 0 | 1087 |
} |
1088 |
||
1089 |
return $cache; |
|
1090 |
} |
|
1091 |
||
1092 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1093 |
* Retrieves the queue for lazy-loading metadata. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1094 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1095 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1096 |
* |
| 16 | 1097 |
* @return WP_Metadata_Lazyloader Metadata lazyloader queue. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1098 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1099 |
function wp_metadata_lazyloader() { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1100 |
static $wp_metadata_lazyloader; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1101 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1102 |
if ( null === $wp_metadata_lazyloader ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1103 |
$wp_metadata_lazyloader = new WP_Metadata_Lazyloader(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1104 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1105 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1106 |
return $wp_metadata_lazyloader; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1107 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1108 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1109 |
/** |
| 5 | 1110 |
* Given a meta query, generates SQL clauses to be appended to a main query. |
| 0 | 1111 |
* |
1112 |
* @since 3.2.0 |
|
1113 |
* |
|
1114 |
* @see WP_Meta_Query |
|
1115 |
* |
|
| 16 | 1116 |
* @param array $meta_query A meta query. |
| 5 | 1117 |
* @param string $type Type of meta. |
1118 |
* @param string $primary_table Primary database table name. |
|
1119 |
* @param string $primary_id_column Primary ID column name. |
|
1120 |
* @param object $context Optional. The main query object |
|
1121 |
* @return array Associative array of `JOIN` and `WHERE` SQL. |
|
| 0 | 1122 |
*/ |
1123 |
function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) { |
|
1124 |
$meta_query_obj = new WP_Meta_Query( $meta_query ); |
|
1125 |
return $meta_query_obj->get_sql( $type, $primary_table, $primary_id_column, $context ); |
|
1126 |
} |
|
1127 |
||
1128 |
/** |
|
| 16 | 1129 |
* Retrieves the name of the metadata table for the specified object type. |
| 0 | 1130 |
* |
1131 |
* @since 2.9.0 |
|
| 5 | 1132 |
* |
1133 |
* @global wpdb $wpdb WordPress database abstraction object. |
|
| 0 | 1134 |
* |
| 16 | 1135 |
* @param string $type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1136 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1137 |
* @return string|false Metadata table name, or false if no metadata table exists |
| 0 | 1138 |
*/ |
| 9 | 1139 |
function _get_meta_table( $type ) { |
| 0 | 1140 |
global $wpdb; |
1141 |
||
1142 |
$table_name = $type . 'meta'; |
|
1143 |
||
| 9 | 1144 |
if ( empty( $wpdb->$table_name ) ) { |
| 0 | 1145 |
return false; |
| 9 | 1146 |
} |
| 0 | 1147 |
|
1148 |
return $wpdb->$table_name; |
|
1149 |
} |
|
1150 |
||
1151 |
/** |
|
| 9 | 1152 |
* Determines whether a meta key is considered protected. |
| 0 | 1153 |
* |
1154 |
* @since 3.1.3 |
|
1155 |
* |
|
| 16 | 1156 |
* @param string $meta_key Metadata key. |
1157 |
* @param string $meta_type Optional. Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1158 |
* or any other object type with an associated meta table. Default empty. |
|
| 9 | 1159 |
* @return bool Whether the meta key is considered protected. |
| 0 | 1160 |
*/ |
| 16 | 1161 |
function is_protected_meta( $meta_key, $meta_type = '' ) { |
1162 |
$protected = ( '_' === $meta_key[0] ); |
|
| 0 | 1163 |
|
| 5 | 1164 |
/** |
| 9 | 1165 |
* Filters whether a meta key is considered protected. |
| 5 | 1166 |
* |
1167 |
* @since 3.2.0 |
|
1168 |
* |
|
| 16 | 1169 |
* @param bool $protected Whether the key is considered protected. |
1170 |
* @param string $meta_key Metadata key. |
|
1171 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1172 |
* or any other object type with an associated meta table. |
|
| 5 | 1173 |
*/ |
| 0 | 1174 |
return apply_filters( 'is_protected_meta', $protected, $meta_key, $meta_type ); |
1175 |
} |
|
1176 |
||
1177 |
/** |
|
| 16 | 1178 |
* Sanitizes meta value. |
| 0 | 1179 |
* |
1180 |
* @since 3.1.3 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1181 |
* @since 4.9.8 The `$object_subtype` parameter was added. |
| 0 | 1182 |
* |
| 16 | 1183 |
* @param string $meta_key Metadata key. |
1184 |
* @param mixed $meta_value Metadata value to sanitize. |
|
1185 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1186 |
* or any other object type with an associated meta table. |
|
| 9 | 1187 |
* @param string $object_subtype Optional. The subtype of the object type. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1188 |
* @return mixed Sanitized $meta_value. |
| 0 | 1189 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1190 |
function sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype = '' ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1191 |
if ( ! empty( $object_subtype ) && has_filter( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}" ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1192 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1193 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1194 |
* Filters the sanitization of a specific meta key of a specific meta type and subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1195 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1196 |
* The dynamic portions of the hook name, `$object_type`, `$meta_key`, |
| 9 | 1197 |
* and `$object_subtype`, refer to the metadata object type (comment, post, term, or user), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1198 |
* the meta key value, and the object subtype respectively. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1199 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1200 |
* @since 4.9.8 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1201 |
* |
| 16 | 1202 |
* @param mixed $meta_value Metadata value to sanitize. |
1203 |
* @param string $meta_key Metadata key. |
|
1204 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1205 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1206 |
* @param string $object_subtype Object subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1207 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1208 |
return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $meta_value, $meta_key, $object_type, $object_subtype ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1209 |
} |
| 5 | 1210 |
|
1211 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1212 |
* Filters the sanitization of a specific meta key of a specific meta type. |
| 5 | 1213 |
* |
1214 |
* The dynamic portions of the hook name, `$meta_type`, and `$meta_key`, |
|
| 9 | 1215 |
* refer to the metadata object type (comment, post, term, or user) and the meta |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1216 |
* key value, respectively. |
| 5 | 1217 |
* |
1218 |
* @since 3.3.0 |
|
1219 |
* |
|
| 16 | 1220 |
* @param mixed $meta_value Metadata value to sanitize. |
1221 |
* @param string $meta_key Metadata key. |
|
1222 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1223 |
* or any other object type with an associated meta table. |
|
| 5 | 1224 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1225 |
return apply_filters( "sanitize_{$object_type}_meta_{$meta_key}", $meta_value, $meta_key, $object_type ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1226 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1227 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1228 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1229 |
* Registers a meta key. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1230 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1231 |
* It is recommended to register meta keys for a specific combination of object type and object subtype. If passing |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1232 |
* an object subtype is omitted, the meta key will be registered for the entire object type, however it can be partly |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1233 |
* overridden in case a more specific meta key of the same name exists for the same object type and a subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1234 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1235 |
* If an object type does not support any subtypes, such as users or comments, you should commonly call this function |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1236 |
* without passing a subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1237 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1238 |
* @since 3.3.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1239 |
* @since 4.6.0 {@link https://core.trac.wordpress.org/ticket/35658 Modified |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1240 |
* to support an array of data to attach to registered meta keys}. Previous arguments for |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1241 |
* `$sanitize_callback` and `$auth_callback` have been folded into this array. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1242 |
* @since 4.9.8 The `$object_subtype` argument was added to the arguments array. |
| 16 | 1243 |
* @since 5.3.0 Valid meta types expanded to include "array" and "object". |
1244 |
* @since 5.5.0 The `$default` argument was added to the arguments array. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1245 |
* |
| 16 | 1246 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1247 |
* or any other object type with an associated meta table. |
|
1248 |
* @param string $meta_key Meta key to register. |
|
1249 |
* @param array $args { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1250 |
* Data used to describe the meta key when registered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1251 |
* |
| 16 | 1252 |
* @type string $object_subtype A subtype; e.g. if the object type is "post", the post type. If left empty, |
1253 |
* the meta key will be registered on the entire object type. Default empty. |
|
1254 |
* @type string $type The type of data associated with this meta key. |
|
1255 |
* Valid values are 'string', 'boolean', 'integer', 'number', 'array', and 'object'. |
|
1256 |
* @type string $description A description of the data attached to this meta key. |
|
1257 |
* @type bool $single Whether the meta key has one value per object, or an array of values per object. |
|
1258 |
* @type mixed $default The default value returned from get_metadata() if no value has been set yet. |
|
1259 |
* When using a non-single meta key, the default value is for the first entry. |
|
1260 |
* In other words, when calling get_metadata() with `$single` set to `false`, |
|
1261 |
* the default value given here will be wrapped in an array. |
|
1262 |
* @type callable $sanitize_callback A function or method to call when sanitizing `$meta_key` data. |
|
1263 |
* @type callable $auth_callback Optional. A function or method to call when performing edit_post_meta, |
|
1264 |
* add_post_meta, and delete_post_meta capability checks. |
|
1265 |
* @type bool|array $show_in_rest Whether data associated with this meta key can be considered public and |
|
1266 |
* should be accessible via the REST API. A custom post type must also declare |
|
1267 |
* support for custom fields for registered meta to be accessible via REST. |
|
1268 |
* When registering complex meta values this argument may optionally be an |
|
1269 |
* array with 'schema' or 'prepare_callback' keys instead of a boolean. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1270 |
* } |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1271 |
* @param string|array $deprecated Deprecated. Use `$args` instead. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1272 |
* @return bool True if the meta key was successfully registered in the global array, false if not. |
| 16 | 1273 |
* Registering a meta key with distinct sanitize and auth callbacks will fire those callbacks, |
1274 |
* but will not add to the global registry. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1275 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1276 |
function register_meta( $object_type, $meta_key, $args, $deprecated = null ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1277 |
global $wp_meta_keys; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1278 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1279 |
if ( ! is_array( $wp_meta_keys ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1280 |
$wp_meta_keys = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1281 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1282 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1283 |
$defaults = array( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1284 |
'object_subtype' => '', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1285 |
'type' => 'string', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1286 |
'description' => '', |
| 16 | 1287 |
'default' => '', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1288 |
'single' => false, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1289 |
'sanitize_callback' => null, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1290 |
'auth_callback' => null, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1291 |
'show_in_rest' => false, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1292 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1293 |
|
| 16 | 1294 |
// There used to be individual args for sanitize and auth callbacks. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1295 |
$has_old_sanitize_cb = false; |
| 9 | 1296 |
$has_old_auth_cb = false; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1297 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1298 |
if ( is_callable( $args ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1299 |
$args = array( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1300 |
'sanitize_callback' => $args, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1301 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1302 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1303 |
$has_old_sanitize_cb = true; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1304 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1305 |
$args = (array) $args; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1306 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1307 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1308 |
if ( is_callable( $deprecated ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1309 |
$args['auth_callback'] = $deprecated; |
| 9 | 1310 |
$has_old_auth_cb = true; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1311 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1312 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1313 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1314 |
* Filters the registration arguments when registering meta. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1315 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1316 |
* @since 4.6.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1317 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1318 |
* @param array $args Array of meta registration arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1319 |
* @param array $defaults Array of default arguments. |
| 16 | 1320 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1321 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1322 |
* @param string $meta_key Meta key. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1323 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1324 |
$args = apply_filters( 'register_meta_args', $args, $defaults, $object_type, $meta_key ); |
| 16 | 1325 |
unset( $defaults['default'] ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1326 |
$args = wp_parse_args( $args, $defaults ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1327 |
|
| 16 | 1328 |
// Require an item schema when registering array meta. |
1329 |
if ( false !== $args['show_in_rest'] && 'array' === $args['type'] ) { |
|
1330 |
if ( ! is_array( $args['show_in_rest'] ) || ! isset( $args['show_in_rest']['schema']['items'] ) ) { |
|
1331 |
_doing_it_wrong( __FUNCTION__, __( 'When registering an "array" meta type to show in the REST API, you must specify the schema for each array item in "show_in_rest.schema.items".' ), '5.3.0' ); |
|
1332 |
||
1333 |
return false; |
|
1334 |
} |
|
1335 |
} |
|
1336 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1337 |
$object_subtype = ! empty( $args['object_subtype'] ) ? $args['object_subtype'] : ''; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1338 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1339 |
// If `auth_callback` is not provided, fall back to `is_protected_meta()`. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1340 |
if ( empty( $args['auth_callback'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1341 |
if ( is_protected_meta( $meta_key, $object_type ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1342 |
$args['auth_callback'] = '__return_false'; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1343 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1344 |
$args['auth_callback'] = '__return_true'; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1345 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1346 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1347 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1348 |
// Back-compat: old sanitize and auth callbacks are applied to all of an object type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1349 |
if ( is_callable( $args['sanitize_callback'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1350 |
if ( ! empty( $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1351 |
add_filter( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['sanitize_callback'], 10, 4 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1352 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1353 |
add_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'], 10, 3 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1354 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1355 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1356 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1357 |
if ( is_callable( $args['auth_callback'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1358 |
if ( ! empty( $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1359 |
add_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['auth_callback'], 10, 6 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1360 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1361 |
add_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'], 10, 6 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1362 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1363 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1364 |
|
| 16 | 1365 |
if ( array_key_exists( 'default', $args ) ) { |
1366 |
$schema = $args; |
|
1367 |
if ( is_array( $args['show_in_rest'] ) && isset( $args['show_in_rest']['schema'] ) ) { |
|
1368 |
$schema = array_merge( $schema, $args['show_in_rest']['schema'] ); |
|
1369 |
} |
|
1370 |
||
1371 |
$check = rest_validate_value_from_schema( $args['default'], $schema ); |
|
1372 |
if ( is_wp_error( $check ) ) { |
|
1373 |
_doing_it_wrong( __FUNCTION__, __( 'When registering a default meta value the data must match the type provided.' ), '5.5.0' ); |
|
1374 |
||
1375 |
return false; |
|
1376 |
} |
|
1377 |
||
1378 |
if ( ! has_filter( "default_{$object_type}_metadata", 'filter_default_metadata' ) ) { |
|
1379 |
add_filter( "default_{$object_type}_metadata", 'filter_default_metadata', 10, 5 ); |
|
1380 |
} |
|
1381 |
} |
|
1382 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1383 |
// Global registry only contains meta keys registered with the array of arguments added in 4.6.0. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1384 |
if ( ! $has_old_auth_cb && ! $has_old_sanitize_cb ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1385 |
unset( $args['object_subtype'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1386 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1387 |
$wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] = $args; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1388 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1389 |
return true; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1390 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1391 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1392 |
return false; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1393 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1394 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1395 |
/** |
| 16 | 1396 |
* Filters into default_{$object_type}_metadata and adds in default value. |
1397 |
* |
|
1398 |
* @since 5.5.0 |
|
1399 |
* |
|
1400 |
* @param mixed $value Current value passed to filter. |
|
1401 |
* @param int $object_id ID of the object metadata is for. |
|
1402 |
* @param string $meta_key Metadata key. |
|
1403 |
* @param bool $single If true, return only the first value of the specified meta_key. |
|
1404 |
* This parameter has no effect if meta_key is not specified. |
|
1405 |
* @param string $meta_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
|
1406 |
* or any other object type with an associated meta table. |
|
1407 |
* @return mixed Single metadata default, or array of defaults. |
|
1408 |
*/ |
|
1409 |
function filter_default_metadata( $value, $object_id, $meta_key, $single, $meta_type ) { |
|
1410 |
global $wp_meta_keys; |
|
1411 |
||
1412 |
if ( wp_installing() ) { |
|
1413 |
return $value; |
|
1414 |
} |
|
1415 |
||
1416 |
if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $meta_type ] ) ) { |
|
1417 |
return $value; |
|
1418 |
} |
|
1419 |
||
1420 |
$defaults = array(); |
|
1421 |
foreach ( $wp_meta_keys[ $meta_type ] as $sub_type => $meta_data ) { |
|
1422 |
foreach ( $meta_data as $_meta_key => $args ) { |
|
1423 |
if ( $_meta_key === $meta_key && array_key_exists( 'default', $args ) ) { |
|
1424 |
$defaults[ $sub_type ] = $args; |
|
1425 |
} |
|
1426 |
} |
|
1427 |
} |
|
1428 |
||
1429 |
if ( ! $defaults ) { |
|
1430 |
return $value; |
|
1431 |
} |
|
1432 |
||
1433 |
// If this meta type does not have subtypes, then the default is keyed as an empty string. |
|
1434 |
if ( isset( $defaults[''] ) ) { |
|
1435 |
$metadata = $defaults['']; |
|
1436 |
} else { |
|
1437 |
$sub_type = get_object_subtype( $meta_type, $object_id ); |
|
1438 |
if ( ! isset( $defaults[ $sub_type ] ) ) { |
|
1439 |
return $value; |
|
1440 |
} |
|
1441 |
$metadata = $defaults[ $sub_type ]; |
|
1442 |
} |
|
1443 |
||
1444 |
if ( $single ) { |
|
1445 |
$value = $metadata['default']; |
|
1446 |
} else { |
|
1447 |
$value = array( $metadata['default'] ); |
|
1448 |
} |
|
1449 |
||
1450 |
return $value; |
|
1451 |
} |
|
1452 |
||
1453 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1454 |
* Checks if a meta key is registered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1455 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1456 |
* @since 4.6.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1457 |
* @since 4.9.8 The `$object_subtype` parameter was added. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1458 |
* |
| 16 | 1459 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1460 |
* or any other object type with an associated meta table. |
|
1461 |
* @param string $meta_key Metadata key. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1462 |
* @param string $object_subtype Optional. The subtype of the object type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1463 |
* @return bool True if the meta key is registered to the object type and, if provided, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1464 |
* the object subtype. False if not. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1465 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1466 |
function registered_meta_key_exists( $object_type, $meta_key, $object_subtype = '' ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1467 |
$meta_keys = get_registered_meta_keys( $object_type, $object_subtype ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1468 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1469 |
return isset( $meta_keys[ $meta_key ] ); |
| 0 | 1470 |
} |
1471 |
||
1472 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1473 |
* Unregisters a meta key from the list of registered keys. |
| 0 | 1474 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1475 |
* @since 4.6.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1476 |
* @since 4.9.8 The `$object_subtype` parameter was added. |
| 0 | 1477 |
* |
| 16 | 1478 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1479 |
* or any other object type with an associated meta table. |
|
1480 |
* @param string $meta_key Metadata key. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1481 |
* @param string $object_subtype Optional. The subtype of the object type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1482 |
* @return bool True if successful. False if the meta key was not registered. |
| 0 | 1483 |
*/ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1484 |
function unregister_meta_key( $object_type, $meta_key, $object_subtype = '' ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1485 |
global $wp_meta_keys; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1486 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1487 |
if ( ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1488 |
return false; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1489 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1490 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1491 |
$args = $wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ]; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1492 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1493 |
if ( isset( $args['sanitize_callback'] ) && is_callable( $args['sanitize_callback'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1494 |
if ( ! empty( $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1495 |
remove_filter( "sanitize_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['sanitize_callback'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1496 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1497 |
remove_filter( "sanitize_{$object_type}_meta_{$meta_key}", $args['sanitize_callback'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1498 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1499 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1500 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1501 |
if ( isset( $args['auth_callback'] ) && is_callable( $args['auth_callback'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1502 |
if ( ! empty( $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1503 |
remove_filter( "auth_{$object_type}_meta_{$meta_key}_for_{$object_subtype}", $args['auth_callback'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1504 |
} else { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1505 |
remove_filter( "auth_{$object_type}_meta_{$meta_key}", $args['auth_callback'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1506 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1507 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1508 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1509 |
unset( $wp_meta_keys[ $object_type ][ $object_subtype ][ $meta_key ] ); |
| 0 | 1510 |
|
| 16 | 1511 |
// Do some clean up. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1512 |
if ( empty( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1513 |
unset( $wp_meta_keys[ $object_type ][ $object_subtype ] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1514 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1515 |
if ( empty( $wp_meta_keys[ $object_type ] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1516 |
unset( $wp_meta_keys[ $object_type ] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1517 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1518 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1519 |
return true; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1520 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1521 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1522 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1523 |
* Retrieves a list of registered meta keys for an object type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1524 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1525 |
* @since 4.6.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1526 |
* @since 4.9.8 The `$object_subtype` parameter was added. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1527 |
* |
| 16 | 1528 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1529 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1530 |
* @param string $object_subtype Optional. The subtype of the object type. |
| 16 | 1531 |
* @return string[] List of registered meta keys. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1532 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1533 |
function get_registered_meta_keys( $object_type, $object_subtype = '' ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1534 |
global $wp_meta_keys; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1535 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1536 |
if ( ! is_array( $wp_meta_keys ) || ! isset( $wp_meta_keys[ $object_type ] ) || ! isset( $wp_meta_keys[ $object_type ][ $object_subtype ] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1537 |
return array(); |
| 0 | 1538 |
} |
1539 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1540 |
return $wp_meta_keys[ $object_type ][ $object_subtype ]; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1541 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1542 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1543 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1544 |
* Retrieves registered metadata for a specified object. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1545 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1546 |
* The results include both meta that is registered specifically for the |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1547 |
* object's subtype and meta that is registered for the entire object type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1548 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1549 |
* @since 4.6.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1550 |
* |
| 16 | 1551 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1552 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1553 |
* @param int $object_id ID of the object the metadata is for. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1554 |
* @param string $meta_key Optional. Registered metadata key. If not specified, retrieve all registered |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1555 |
* metadata for the specified object. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1556 |
* @return mixed A single value or array of values for a key if specified. An array of all registered keys |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1557 |
* and values for an object ID if not. False if a given $meta_key is not registered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1558 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1559 |
function get_registered_metadata( $object_type, $object_id, $meta_key = '' ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1560 |
$object_subtype = get_object_subtype( $object_type, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1561 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1562 |
if ( ! empty( $meta_key ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1563 |
if ( ! empty( $object_subtype ) && ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1564 |
$object_subtype = ''; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1565 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1566 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1567 |
if ( ! registered_meta_key_exists( $object_type, $meta_key, $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1568 |
return false; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1569 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1570 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1571 |
$meta_keys = get_registered_meta_keys( $object_type, $object_subtype ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1572 |
$meta_key_data = $meta_keys[ $meta_key ]; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1573 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1574 |
$data = get_metadata( $object_type, $object_id, $meta_key, $meta_key_data['single'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1575 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1576 |
return $data; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1577 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1578 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1579 |
$data = get_metadata( $object_type, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1580 |
if ( ! $data ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1581 |
return array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1582 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1583 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1584 |
$meta_keys = get_registered_meta_keys( $object_type ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1585 |
if ( ! empty( $object_subtype ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1586 |
$meta_keys = array_merge( $meta_keys, get_registered_meta_keys( $object_type, $object_subtype ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1587 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1588 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1589 |
return array_intersect_key( $data, $meta_keys ); |
| 0 | 1590 |
} |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1591 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1592 |
/** |
| 16 | 1593 |
* Filters out `register_meta()` args based on an allowed list. |
1594 |
* |
|
1595 |
* `register_meta()` args may change over time, so requiring the allowed list |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1596 |
* to be explicitly turned off is a warranty seal of sorts. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1597 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1598 |
* @access private |
| 16 | 1599 |
* @since 5.5.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1600 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1601 |
* @param array $args Arguments from `register_meta()`. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1602 |
* @param array $default_args Default arguments for `register_meta()`. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1603 |
* @return array Filtered arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1604 |
*/ |
| 16 | 1605 |
function _wp_register_meta_args_allowed_list( $args, $default_args ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1606 |
return array_intersect_key( $args, $default_args ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1607 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1608 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1609 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1610 |
* Returns the object subtype for a given object ID of a specific type. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1611 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1612 |
* @since 4.9.8 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1613 |
* |
| 16 | 1614 |
* @param string $object_type Type of object metadata is for. Accepts 'post', 'comment', 'term', 'user', |
1615 |
* or any other object type with an associated meta table. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1616 |
* @param int $object_id ID of the object to retrieve its subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1617 |
* @return string The object subtype or an empty string if unspecified subtype. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1618 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1619 |
function get_object_subtype( $object_type, $object_id ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1620 |
$object_id = (int) $object_id; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1621 |
$object_subtype = ''; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1622 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1623 |
switch ( $object_type ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1624 |
case 'post': |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1625 |
$post_type = get_post_type( $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1626 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1627 |
if ( ! empty( $post_type ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1628 |
$object_subtype = $post_type; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1629 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1630 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1631 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1632 |
case 'term': |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1633 |
$term = get_term( $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1634 |
if ( ! $term instanceof WP_Term ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1635 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1636 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1637 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1638 |
$object_subtype = $term->taxonomy; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1639 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1640 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1641 |
case 'comment': |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1642 |
$comment = get_comment( $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1643 |
if ( ! $comment ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1644 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1645 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1646 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1647 |
$object_subtype = 'comment'; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1648 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1649 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1650 |
case 'user': |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1651 |
$user = get_user_by( 'id', $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1652 |
if ( ! $user ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1653 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1654 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1655 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1656 |
$object_subtype = 'user'; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1657 |
break; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1658 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1659 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1660 |
/** |
| 16 | 1661 |
* Filters the object subtype identifier for a non-standard object type. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1662 |
* |
| 16 | 1663 |
* The dynamic portion of the hook, `$object_type`, refers to the meta object type |
1664 |
* (post, comment, term, user, or any other type with an associated meta table). |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1665 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1666 |
* @since 4.9.8 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1667 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1668 |
* @param string $object_subtype Empty string to override. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1669 |
* @param int $object_id ID of the object to get the subtype for. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1670 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1671 |
return apply_filters( "get_object_subtype_{$object_type}", $object_subtype, $object_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1672 |
} |