API Documentation
\
TriTan
Cache
Command
Common
Acl
Context
Hooks
Options
Plugin
Post
Posttype
Site
User
Exception
Interfaces
Acl
Cache
Hooks
Options
Password
Plugin
Plugins
Post
Posttype
Site
User
Queue
Traits

\TriTan\InterfacesMetaDataInterface

Summary

Methods
Constants
create()
read()
update()
delete()
readByMid()
updateByMid()
deleteByMid()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

create()

create(string  $meta_type, integer  $array_id, string  $meta_key, mixed  $meta_value,   $unique = false) : integer|false

Add metadata for the specified array.

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user)
integer $array_id

ID of the array metadata is for
string $meta_key

Metadata key
mixed $meta_value

Metadata value. Must be serializable if non-scalar.
$unique

Returns

integer|false —

The meta ID on success, false on failure.

read()

read(string  $meta_type, integer  $array_id, string  $meta_key = '',   $single = false) : mixed

Retrieve metadata for the specified array.

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user)
integer $array_id

ID of the array metadata is for
string $meta_key

Optional. Metadata key. If not specified, retrieve all metadata for the specified array.
$single

Returns

mixed —

Array of values

update()

update(string  $meta_type, integer  $array_id, string  $meta_key, mixed  $meta_value, mixed  $prev_value = '') : integer|boolean

Update metadata for the specified array. If no value already exists for the specified array ID and metadata key, the metadata will be added.

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user)
integer $array_id

ID of the array metadata is for
string $meta_key

Metadata key
mixed $meta_value

Metadata value. Must be serializable if non-scalar.
mixed $prev_value

Optional. If specified, only update existing metadata entries with the specified value. Otherwise, update all entries.

Returns

integer|boolean —

Meta ID if the key didn't exist, true on successful update, false on failure.

delete()

delete(string  $meta_type, integer  $array_id, string  $meta_key, mixed  $meta_value = '', boolean  $delete_all = false) : boolean

Delete metadata for the specified array.

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user)
integer $array_id

ID of the array metadata is for
string $meta_key

Metadata key
mixed $meta_value

Optional. Metadata value. Must be serializable if non-scalar. If specified, only delete metadata entries with this value. Otherwise, delete all entries with the specified meta_key. Pass null,false`, or an empty string to skip this check. (For backward compatibility, it is not possible to pass an empty string to delete those entries with an empty string for a value.)
boolean $delete_all

Optional, default is false. If true, delete matching metadata entries for all arrays, ignoring the specified array_id. Otherwise, only delete matching metadata entries for the specified array_id.

Returns

boolean —

True on successful delete, false on failure.

readByMid()

readByMid(string  $meta_type, integer  $meta_id) : array|false

Get meta data by meta ID.

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user).
integer $meta_id

ID for a specific meta row

Returns

array|false —

Meta array or false.

updateByMid()

updateByMid(string  $meta_type, integer  $meta_id, string  $meta_value, string  $meta_key = false) : boolean

Update meta data by meta ID

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user)
integer $meta_id

ID for a specific meta row
string $meta_value

Metadata value
string $meta_key

Optional, you can provide a meta key to update it

Returns

boolean —

True on successful update, false on failure.

deleteByMid()

deleteByMid(string  $meta_type, integer  $meta_id) : boolean

Delete meta data by meta ID

Parameters

string $meta_type

Type of array metadata is for (e.g. post or user).
integer $meta_id

ID for a specific meta row

Returns

boolean —

True on successful delete, false on failure.