Changeset 19593 for trunk/wp-includes/meta.php
- Timestamp:
- 12/13/2011 11:45:31 PM (12 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/wp-includes/meta.php
r19054 r19593 3 3 * Metadata API 4 4 * 5 * Functions for retrieving and manipulating metadata of various WordPress object types. 6 * for an object is a represented by a simple key-value pair. 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 7 * metadata entries that share the same key and differ only in their value. 8 8 * … … 24 24 * @param string $meta_key Metadata key 25 25 * @param string $meta_value Metadata value 26 * @param bool $unique Optional, default is false. 27 * unique for the object. 26 * @param bool $unique Optional, default is false. Whether the specified metadata key should be 27 * unique for the object. If true, and the object already has a value for the specified 28 28 * metadata key, no change will be made 29 29 * @return bool The meta ID on successful update, false on failure. … … 81 81 82 82 /** 83 * Update metadata for the specified object. 83 * Update metadata for the specified object. If no value already exists for the specified object 84 84 * ID and metadata key, the metadata will be added. 85 85 * … … 95 95 * @param string $meta_key Metadata key 96 96 * @param string $meta_value Metadata value 97 * @param string $prev_value Optional. 98 * the specified value. 97 * @param string $prev_value Optional. If specified, only update existing metadata entries with 98 * the specified value. Otherwise, update all entries. 99 99 * @return bool True on successful update, false on failure. 100 100 */ … … 175 175 * @param int $object_id ID of the object metadata is for 176 176 * @param string $meta_key Metadata key 177 * @param string $meta_value Optional. Metadata value. 178 * with this value. 179 * @param bool $delete_all Optional, default is false. 180 * for all objects, ignoring the specified object_id. 177 * @param string $meta_value Optional. Metadata value. If specified, only delete metadata entries 178 * with this value. Otherwise, delete all entries with the specified meta_key. 179 * @param bool $delete_all Optional, default is false. If true, delete matching metadata entries 180 * for all objects, ignoring the specified object_id. Otherwise, only delete matching 181 181 * metadata entries for the specified object_id. 182 182 * @return bool True on successful delete, false on failure. … … 257 257 * @param string $meta_type Type of object metadata is for (e.g., comment, post, or user) 258 258 * @param int $object_id ID of the object metadata is for 259 * @param string $meta_key Optional. Metadata key.If not specified, retrieve all metadata for259 * @param string $meta_key Optional. Metadata key. If not specified, retrieve all metadata for 260 260 * the specified object. 261 * @param bool $single Optional, default is false. 262 * specified meta_key. 261 * @param bool $single Optional, default is false. If true, return only the first value of the 262 * specified meta_key. This parameter has no effect if meta_key is not specified. 263 263 * @return string|array Single metadata value, or array of values 264 264 */
Note: See TracChangeset
for help on using the changeset viewer.