[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

title

Body

[close]

/wp-includes/ -> meta.php (summary)

Core Metadata API Functions for retrieving and manipulating metadata of various WordPress object types. Metadata for an object is a represented by a simple key-value pair. Objects may contain multiple metadata entries that share the same key and differ only in their value.

File Size: 1366 lines (44 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 21 functions

  add_metadata()
  update_metadata()
  delete_metadata()
  get_metadata()
  metadata_exists()
  get_metadata_by_mid()
  update_metadata_by_mid()
  delete_metadata_by_mid()
  update_meta_cache()
  wp_metadata_lazyloader()
  get_meta_sql()
  _get_meta_table()
  is_protected_meta()
  sanitize_meta()
  register_meta()
  registered_meta_key_exists()
  unregister_meta_key()
  get_registered_meta_keys()
  get_registered_metadata()
  _wp_register_meta_args_whitelist()
  get_object_subtype()

Functions
Functions that are not part of a class:

add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = false )   X-Ref
Add metadata for the specified object.

return: int|false The meta ID on success, false on failure.
param: string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $object_id  ID of the object metadata is for
param: string $meta_key   Metadata key
param: mixed  $meta_value Metadata value. Must be serializable if non-scalar.
param: bool   $unique     Optional, default is false.

update_metadata( $meta_type, $object_id, $meta_key, $meta_value, $prev_value = '' )   X-Ref
Update metadata for the specified object. If no value already exists for the specified object
ID and metadata key, the metadata will be added.

return: int|bool The new meta field ID if a field with the given key didn't exist and was
param: string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $object_id  ID of the object metadata is for
param: string $meta_key   Metadata key
param: mixed  $meta_value Metadata value. Must be serializable if non-scalar.
param: mixed  $prev_value Optional. If specified, only update existing metadata entries with

delete_metadata( $meta_type, $object_id, $meta_key, $meta_value = '', $delete_all = false )   X-Ref
Delete metadata for the specified object.

return: bool True on successful delete, false on failure.
param: string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $object_id  ID of the object metadata is for
param: string $meta_key   Metadata key
param: mixed  $meta_value Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete
param: bool   $delete_all Optional, default is false. If true, delete matching metadata entries for all objects,

get_metadata( $meta_type, $object_id, $meta_key = '', $single = false )   X-Ref
Retrieve metadata for the specified object.

return: mixed Single metadata value, or array of values
param: string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $object_id ID of the object metadata is for
param: string $meta_key  Optional. Metadata key. If not specified, retrieve all metadata for
param: bool   $single    Optional, default is false.

metadata_exists( $meta_type, $object_id, $meta_key )   X-Ref
Determine if a meta key is set for a given object

return: bool True of the key is set, false if not.
param: string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $object_id ID of the object metadata is for
param: string $meta_key  Metadata key.

get_metadata_by_mid( $meta_type, $meta_id )   X-Ref
Get meta data by meta ID

return: object|false Meta object or false.
param: string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $meta_id   ID for a specific meta row

update_metadata_by_mid( $meta_type, $meta_id, $meta_value, $meta_key = false )   X-Ref
Update meta data by meta ID

return: bool True on successful update, false on failure.
param: string $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $meta_id    ID for a specific meta row
param: string $meta_value Metadata value
param: string $meta_key   Optional, you can provide a meta key to update it

delete_metadata_by_mid( $meta_type, $meta_id )   X-Ref
Delete meta data by meta ID

return: bool True on successful delete, false on failure.
param: string $meta_type Type of object metadata is for (e.g., comment, post, term, or user).
param: int    $meta_id   ID for a specific meta row

update_meta_cache( $meta_type, $object_ids )   X-Ref
Update the metadata cache for the specified objects.

return: array|false Metadata cache for the specified objects, or false on failure.
param: string    $meta_type  Type of object metadata is for (e.g., comment, post, term, or user).
param: int|array $object_ids Array or comma delimited list of object IDs to update cache for

wp_metadata_lazyloader()   X-Ref
Retrieves the queue for lazy-loading metadata.

return: WP_Metadata_Lazyloader $lazyloader Metadata lazyloader queue.

get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null )   X-Ref
Given a meta query, generates SQL clauses to be appended to a main query.

return: array Associative array of `JOIN` and `WHERE` SQL.
param: array $meta_query         A meta query.
param: string $type              Type of meta.
param: string $primary_table     Primary database table name.
param: string $primary_id_column Primary ID column name.
param: object $context           Optional. The main query object

_get_meta_table( $type )   X-Ref
Retrieve the name of the metadata table for the specified object type.

return: string|false Metadata table name, or false if no metadata table exists
param: string $type Type of object to get metadata table for (e.g., comment, post, term, or user).

is_protected_meta( $meta_key, $meta_type = null )   X-Ref
Determines whether a meta key is considered protected.

return: bool Whether the meta key is considered protected.
param: string      $meta_key  Meta key.
param: string|null $meta_type Optional. Type of object metadata is for (e.g., comment, post, term, or user).

sanitize_meta( $meta_key, $meta_value, $object_type, $object_subtype = '' )   X-Ref
Sanitize meta value.

return: mixed Sanitized $meta_value.
param: string $meta_key       Meta key.
param: mixed  $meta_value     Meta value to sanitize.
param: string $object_type    Type of object the meta is registered to.
param: string $object_subtype Optional. The subtype of the object type.

register_meta( $object_type, $meta_key, $args, $deprecated = null )   X-Ref
Registers a meta key.

It is recommended to register meta keys for a specific combination of object type and object subtype. If passing
an object subtype is omitted, the meta key will be registered for the entire object type, however it can be partly
overridden in case a more specific meta key of the same name exists for the same object type and a subtype.

If an object type does not support any subtypes, such as users or comments, you should commonly call this function
without passing a subtype.

return: bool True if the meta key was successfully registered in the global array, false if not.
param: string $object_type    Type of object this meta is registered to.
param: string $meta_key       Meta key to register.
param: array  $args {
param: string|array $deprecated Deprecated. Use `$args` instead.

registered_meta_key_exists( $object_type, $meta_key, $object_subtype = '' )   X-Ref
Checks if a meta key is registered.

return: bool True if the meta key is registered to the object type and, if provided,
param: string $object_type    The type of object.
param: string $meta_key       The meta key.
param: string $object_subtype Optional. The subtype of the object type.

unregister_meta_key( $object_type, $meta_key, $object_subtype = '' )   X-Ref
Unregisters a meta key from the list of registered keys.

return: bool True if successful. False if the meta key was not registered.
param: string $object_type    The type of object.
param: string $meta_key       The meta key.
param: string $object_subtype Optional. The subtype of the object type.

get_registered_meta_keys( $object_type, $object_subtype = '' )   X-Ref
Retrieves a list of registered meta keys for an object type.

return: array List of registered meta keys.
param: string $object_type    The type of object. Post, comment, user, term.
param: string $object_subtype Optional. The subtype of the object type.

get_registered_metadata( $object_type, $object_id, $meta_key = '' )   X-Ref
Retrieves registered metadata for a specified object.

The results include both meta that is registered specifically for the
object's subtype and meta that is registered for the entire object type.

return: mixed A single value or array of values for a key if specified. An array of all registered keys
param: string $object_type Type of object to request metadata for. (e.g. comment, post, term, user)
param: int    $object_id   ID of the object the metadata is for.
param: string $meta_key    Optional. Registered metadata key. If not specified, retrieve all registered

_wp_register_meta_args_whitelist( $args, $default_args )   X-Ref
Filter out `register_meta()` args based on a whitelist.
`register_meta()` args may change over time, so requiring the whitelist
to be explicitly turned off is a warranty seal of sorts.

return: array Filtered arguments.
param: array $args         Arguments from `register_meta()`.
param: array $default_args Default arguments for `register_meta()`.

get_object_subtype( $object_type, $object_id )   X-Ref
Returns the object subtype for a given object ID of a specific type.

return: string The object subtype or an empty string if unspecified subtype.
param: string $object_type Type of object to request metadata for. (e.g. comment, post, term, user)
param: int    $object_id   ID of the object to retrieve its subtype.



Generated: Wed Nov 21 08:20:01 2018 Cross-referenced by PHPXref 0.7