delete_post_meta_by_key

The timeline below displays how wordpress function delete_post_meta_by_key has changed across different WordPress versions. If a version is not listed, refer to the next available version below.

WordPress Version: 5.1

/**
 * Deletes everything from post meta matching the given meta key.
 *
 * @since 2.3.0
 *
 * @param string $post_meta_key Key to search for when deleting.
 * @return bool Whether the post meta key was deleted from the database.
 */
function delete_post_meta_by_key($post_meta_key)
{
    return delete_metadata('post', null, $post_meta_key, '', true);
}

WordPress Version: 5.0

/**
 * Delete everything from post meta matching meta key.
 *
 * @since 2.3.0
 *
 * @param string $post_meta_key Key to search for when deleting.
 * @return bool Whether the post meta key was deleted from the database.
 */
function delete_post_meta_by_key($post_meta_key)
{
    return delete_metadata('post', null, $post_meta_key, '', true);
}

WordPress Version: 4.9

/**
 * Delete everything from post meta matching meta key.
 *
 * @since 2.3.0
 *
 * @param string $post_meta_key Key to search for when deleting.
 * @return bool Whether the post meta key was deleted from the database.
 */
function delete_post_meta_by_key($post_meta_key)
{
    $deleted = delete_metadata('post', null, $post_meta_key, '', true);
    if ($deleted) {
        wp_cache_set('last_changed', microtime(), 'posts');
    }
    return $deleted;
}

WordPress Version: 4.0

/**
 * Delete everything from post meta matching meta key.
 *
 * @since 2.3.0
 *
 * @param string $post_meta_key Key to search for when deleting.
 * @return bool Whether the post meta key was deleted from the database.
 */
function delete_post_meta_by_key($post_meta_key)
{
    return delete_metadata('post', null, $post_meta_key, '', true);
}

WordPress Version: 3.7

/**
 * Delete everything from post meta matching meta key.
 *
 * @since 2.3.0
 *
 * @param string $post_meta_key Key to search for when deleting.
 * @return bool Whether the post meta key was deleted from the database
 */
function delete_post_meta_by_key($post_meta_key)
{
    return delete_metadata('post', null, $post_meta_key, '', true);
}