add_metadata( string $meta_type, int $object_id, string $meta_key, mixed $meta_value, bool $unique = false )

Add metadata for the specified object.

Contents

Description Description

Parameters Parameters

$meta_type

(string) (Required) Type of object metadata is for (e.g., comment, post, term, or user).

$object_id

(int) (Required) ID of the object metadata is for

$meta_key

(string) (Required) Metadata key

$meta_value

(mixed) (Required) Metadata value. Must be serializable if non-scalar.

$unique

(bool) (Optional) Whether the specified metadata key should be unique for the object. If true, and the object already has a value for the specified metadata key, no change will be made.

Default value: false

Top ↑

Return Return

(int|false) The meta ID on success, false on failure.

Top ↑

Source Source

File: wp-includes/meta.php

30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
function add_metadata( $meta_type, $object_id, $meta_key, $meta_value, $unique = false ) {
    global $wpdb;
 
    if ( ! $meta_type || ! $meta_key || ! is_numeric( $object_id ) ) {
        return false;
    }
 
    $object_id = absint( $object_id );
    if ( ! $object_id ) {
        return false;
    }
 
    $table = _get_meta_table( $meta_type );
    if ( ! $table ) {
        return false;
    }
 
    $meta_subtype = get_object_subtype( $meta_type, $object_id );
 
    $column = sanitize_key( $meta_type . '_id' );
 
    // expected_slashed ($meta_key)
    $meta_key   = wp_unslash( $meta_key );
    $meta_value = wp_unslash( $meta_value );
    $meta_value = sanitize_meta( $meta_key, $meta_value, $meta_type, $meta_subtype );
 
    /**
     * Filters whether to add metadata of a specific type.
     *
     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     * object type (comment, post, term, or user). Returning a non-null value
     * will effectively short-circuit the function.
     *
     * @since 3.1.0
     *
     * @param null|bool $check      Whether to allow adding metadata for the given type.
     * @param int       $object_id  Object ID.
     * @param string    $meta_key   Meta key.
     * @param mixed     $meta_value Meta value. Must be serializable if non-scalar.
     * @param bool      $unique     Whether the specified meta key should be unique
     *                              for the object. Optional. Default false.
     */
    $check = apply_filters( "add_{$meta_type}_metadata", null, $object_id, $meta_key, $meta_value, $unique );
    if ( null !== $check ) {
        return $check;
    }
 
    if ( $unique && $wpdb->get_var(
        $wpdb->prepare(
            "SELECT COUNT(*) FROM $table WHERE meta_key = %s AND $column = %d",
            $meta_key,
            $object_id
        )
    ) ) {
        return false;
    }
 
    $_meta_value = $meta_value;
    $meta_value  = maybe_serialize( $meta_value );
 
    /**
     * Fires immediately before meta of a specific type is added.
     *
     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     * object type (comment, post, term, or user).
     *
     * @since 3.1.0
     *
     * @param int    $object_id  Object ID.
     * @param string $meta_key   Meta key.
     * @param mixed  $meta_value Meta value.
     */
    do_action( "add_{$meta_type}_meta", $object_id, $meta_key, $_meta_value );
 
    $result = $wpdb->insert(
        $table,
        array(
            $column      => $object_id,
            'meta_key'   => $meta_key,
            'meta_value' => $meta_value,
        )
    );
 
    if ( ! $result ) {
        return false;
    }
 
    $mid = (int) $wpdb->insert_id;
 
    wp_cache_delete( $object_id, $meta_type . '_meta' );
 
    /**
     * Fires immediately after meta of a specific type is added.
     *
     * The dynamic portion of the hook, `$meta_type`, refers to the meta
     * object type (comment, post, term, or user).
     *
     * @since 2.9.0
     *
     * @param int    $mid        The meta ID after successful update.
     * @param int    $object_id  Object ID.
     * @param string $meta_key   Meta key.
     * @param mixed  $meta_value Meta value.
     */
    do_action( "added_{$meta_type}_meta", $mid, $object_id, $meta_key, $_meta_value );
 
    return $mid;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
2.9.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/meta.php: get_object_subtype()

Returns the object subtype for a given object ID of a specific type.
wp-includes/cache.php: wp_cache_delete()

Removes the cache contents matching key and group.
wp-includes/formatting.php: wp_unslash()

Remove slashes from a string or array of strings.
wp-includes/formatting.php: sanitize_key()

Sanitizes a string key.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/functions.php: maybe_serialize()

Serialize data, if needed.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/wp-db.php: wpdb::get_var()

Retrieve one variable from the database.
wp-includes/wp-db.php: wpdb::insert()

Insert a row into a table.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
wp-includes/meta.php: _get_meta_table()

Retrieve the name of the metadata table for the specified object type.
wp-includes/meta.php: sanitize_meta()

Sanitize meta value.
wp-includes/meta.php: add_{$meta_type}_metadata

Filters whether to add metadata of a specific type.
wp-includes/meta.php: add_{$meta_type}_meta

Fires immediately before meta of a specific type is added.
wp-includes/meta.php: added_{$meta_type}_meta

Fires immediately after meta of a specific type is added.
Show 11 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/ms-site.php: add_site_meta()

Adds metadata to a site.
wp-includes/rest-api/fields/class-wp-rest-meta-fields.php: WP_REST_Meta_Fields::update_multi_meta_value()

Updates multiple meta values for an object.
wp-includes/taxonomy.php: add_term_meta()

Adds metadata to a term.
wp-includes/user.php: add_user_meta()

Adds meta data to a user.
wp-includes/post.php: add_post_meta()

Adds a meta field to the given post.
wp-includes/comment.php: add_comment_meta()

Add meta data field to a comment.
wp-includes/meta.php: update_metadata()

Update metadata for the specified object. If no value already exists for the specified object ID and metadata key, the metadata will be added.
Show 2 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.