发布于 由admin

阐述 `delete_post_meta()` 函数如何通过 `post_id` 和 `meta_key` 从 `wp_postmeta` 表中删除数据。

各位观众老爷，晚上好！今天咱们来聊聊 WordPress 里一个“狠角色”—— delete_post_meta() 函数。这玩意儿，用好了，能帮你清理数据库，让你的博客轻装上阵；用不好，手一抖，删错了数据，那可就麻烦大了。所以，咱们今天就来好好扒一扒它的底裤，看看它是怎么通过 post_id 和 meta_key，在 wp_postmeta 表里“兴风作浪”的。

一、Meta Data 的前世今生

在深入 delete_post_meta() 之前，咱们得先了解一下 Meta Data 到底是啥玩意儿。你可以把它想象成附加在 WordPress 文章（Post）、页面（Page）或者其他内容类型上的“标签”。这些标签可以存储各种各样的信息，比如文章的作者心情、页面的SEO关键词、甚至是一张图片的拍摄地点。

WordPress 使用 wp_postmeta 表来存储这些 Meta Data。这个表结构非常简单，主要包含以下几个字段：

字段名 数据类型 说明
meta_id BIGINT(20) 自增主键，用于唯一标识每一条 Meta Data 记录。
post_id BIGINT(20) 外键，关联到 wp_posts 表的 ID 字段，表示这条 Meta Data 属于哪个文章。
meta_key VARCHAR(255) Meta Data 的键名，也就是“标签”的名字。比如 _wp_page_template 表示页面模板，_yoast_wpseo_metadesc 表示 Yoast SEO 插件的描述信息。 注意，以_开头的meta_key通常被认为是隐藏的或者内部使用的，不应该直接在前端显示或修改。虽然WordPress并没有强制限制，但这是一个约定俗成的规则。
meta_value LONGTEXT Meta Data 的值，也就是“标签”的内容。可以是字符串、数字、数组、对象等等。WordPress 会自动对复杂数据类型进行序列化和反序列化，以便存储和读取。

二、delete_post_meta() 函数：挥舞着删除大棒的家伙

delete_post_meta() 函数，顾名思义，就是用来删除文章 Meta Data 的。它的原型如下：

/**
 * Delete post meta field based on post ID.
 *
 * @since 2.9.0
 *
 * @param int    $post_id  Post ID.
 * @param string $meta_key Meta key.
 * @param mixed  $meta_value Optional. Meta value. Must be serializable if non-scalar.
 * @return bool True on successful delete, false on failure.
 */
function delete_post_meta( $post_id, $meta_key = '', $meta_value = '' ) {
    return delete_metadata( 'post', $post_id, $meta_key, $meta_value );
}

可以看到，delete_post_meta() 实际上是 delete_metadata() 函数的一个包装。它接收三个参数：

  • $post_id：要删除 Meta Data 的文章 ID。
  • $meta_key：要删除的 Meta Data 的键名。
  • $meta_value (可选)：要删除的 Meta Data 的值。如果指定了 meta_value，则只会删除 meta_key 和 meta_value 都匹配的 Meta Data。

三、delete_metadata() 函数：真正的幕后黑手

delete_post_meta() 本身并没有太多逻辑，它只是调用了 delete_metadata() 函数。所以，咱们要真正理解 Meta Data 的删除过程，还得深入 delete_metadata() 函数的源码。

/**
 * Deletes metadata of a specific type.
 *
 * @since 2.9.0
 * @since 5.5.0 Added the `$single` parameter.
 *
 * @param string     $meta_type  Type of metadata (post, comment, user, term, or any other).
 * @param int        $object_id  ID of the object metadata is for.
 * @param string     $meta_key   Meta key.
 * @param mixed      $meta_value Optional. Meta value. Must be serializable if non-scalar.
 * @param bool       $delete_all Optional, default is false. If true, delete matching metadata entries for all objects, ignore $object_id.
 * @return bool True on successful delete, false on failure.
 */
function delete_metadata( $meta_type, $object_id, $meta_key = '', $meta_value = '', $delete_all = false ) {
    global $wpdb;

    $table = _get_meta_table( $meta_type );

    if ( ! $table ) {
        return false;
    }

    $id_column = sanitize_key( $meta_type ) . '_id';

    $meta_key = wp_unslash( $meta_key );
    $meta_value = wp_unslash( $meta_value );

    $meta_ids = array();

    $args = array( 'fields' => 'ids', 'meta_key' => $meta_key, 'meta_value' => $meta_value, 'number' => 0 );

    if ( $delete_all ) {
        $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT {$id_column} FROM {$table}" ) );
        if ( ! empty( $object_ids ) ) {
            foreach ( $object_ids as $object_id ) {
                $args['object_ids'] = (array) $object_id;
                $metadata = get_metadata( $meta_type, $object_id, $meta_key, false ); // Use get_metadata to handle serialization
                foreach ( $metadata as $meta_value_single ) {
                    if ( empty( $meta_value ) || maybe_unserialize( $meta_value_single ) == $meta_value ) {
                        $meta_ids = array_merge( $meta_ids, get_metadata( $meta_type, $object_id, $meta_key, false, 'ids' ) );
                    }
                }
            }
        }
    } else {
        $args['object_ids'] = (array) $object_id;
        $metadata = get_metadata( $meta_type, $object_id, $meta_key, false ); // Use get_metadata to handle serialization
        foreach ( $metadata as $meta_value_single ) {
            if ( empty( $meta_value ) || maybe_unserialize( $meta_value_single ) == $meta_value ) {
                $meta_ids = array_merge( $meta_ids, get_metadata( $meta_type, $object_id, $meta_key, false, 'ids' ) );
            }
        }
    }

    if ( empty( $meta_ids ) ) {
        return false;
    }

    /**
     * Fires immediately before deleting metadata of a specific type.
     *
     * The dynamic portion of the hook name, `$meta_type`, refers to the metadata object type.
     *
     * @since 2.9.0
     *
     * @param array  $meta_ids   Array of meta IDs to delete.
     * @param string $meta_type  Type of metadata (post, comment, user, term, or any other).
     * @param int    $object_id  ID of the object metadata is for.
     * @param string $meta_key   Meta key.
     * @param mixed  $meta_value Meta value.
     */
    do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );

    $meta_ids = array_map( 'intval', $meta_ids );
    $meta_ids = implode( ',', $meta_ids );

    $query = "DELETE FROM {$table} WHERE meta_id IN ({$meta_ids})";

    $count = $wpdb->query( $query );

    if ( ! $count ) {
        return false;
    }

    wp_cache_delete_multiple( $object_id, $meta_type . '_meta' );

    /**
     * Fires immediately after deleting metadata of a specific type.
     *
     * The dynamic portion of the hook name, `$meta_type`, refers to the metadata object type.
     *
     * @since 2.9.0
     *
     * @param array  $meta_ids   Array of meta IDs to delete.
     * @param string $meta_type  Type of metadata (post, comment, user, term, or any other).
     * @param int    $object_id  ID of the object metadata is for.
     * @param string $meta_key   Meta key.
     * @param mixed  $meta_value Meta value.
     */
    do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );

    return true;
}

咱们来一步一步地解读这段代码：

  1. 获取 Meta Data 表名：

    $table = _get_meta_table( $meta_type );

    _get_meta_table() 函数根据 $meta_type（在本例中是 'post'）返回对应的 Meta Data 表名。对于 Post Meta Data，它会返回 wp_postmeta。

  2. 构建 ID 列名：

    $id_column = sanitize_key( $meta_type ) . '_id';

    这行代码构建了 ID 列名，用于在 SQL 查询中引用。对于 Post Meta Data，它会生成 post_id。

  3. 准备参数，用于获取需要删除的 meta_id：

    $args = array( 'fields' => 'ids', 'meta_key' => $meta_key, 'meta_value' => $meta_value, 'number' => 0 );

if ( $delete_all ) {
    $object_ids = $wpdb->get_col( $wpdb->prepare( "SELECT DISTINCT {$id_column} FROM {$table}" ) );
    if ( ! empty( $object_ids ) ) {
        foreach ( $object_ids as $object_id ) {
            $args['object_ids'] = (array) $object_id;
            $metadata = get_metadata( $meta_type, $object_id, $meta_key, false ); // Use get_metadata to handle serialization
            foreach ( $metadata as $meta_value_single ) {
                if ( empty( $meta_value ) || maybe_unserialize( $meta_value_single ) == $meta_value ) {
                    $meta_ids = array_merge( $meta_ids, get_metadata( $meta_type, $object_id, $meta_key, false, 'ids' ) );
                }
            }
        }
    }
} else {
    $args['object_ids'] = (array) $object_id;
    $metadata = get_metadata( $meta_type, $object_id, $meta_key, false ); // Use get_metadata to handle serialization
    foreach ( $metadata as $meta_value_single ) {
        if ( empty( $meta_value ) || maybe_unserialize( $meta_value_single ) == $meta_value ) {
            $meta_ids = array_merge( $meta_ids, get_metadata( $meta_type, $object_id, $meta_key, false, 'ids' ) );
        }
    }
}

    这段代码看起来比较复杂，其实主要的功能是根据传入的参数，获取需要删除的 meta_id 列表。它首先判断是否要删除所有匹配的 Meta Data（$delete_all 参数）。如果要删除所有匹配的 Meta Data，则会先查询出所有包含指定 meta_key 的 object_id，然后遍历这些 object_id，获取所有匹配的 meta_id。如果只需要删除指定 object_id 的 Meta Data，则直接获取所有匹配的 meta_id。

    这里用到了 get_metadata 函数，它负责从数据库中获取 Meta Data，并处理序列化和反序列化。get_metadata 函数的最后一个参数 'ids' 表示只返回 meta_id。

  4. 触发 delete_{$meta_type}_meta 钩子：

    do_action( "delete_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );

    这是一个 Action Hook，允许开发者在 Meta Data 删除之前执行自定义操作。你可以在这里进行一些额外的验证、日志记录或者其他处理。

  5. 构建并执行 SQL DELETE 语句：

    $meta_ids = array_map( 'intval', $meta_ids );
$meta_ids = implode( ',', $meta_ids );

$query = "DELETE FROM {$table} WHERE meta_id IN ({$meta_ids})";

$count = $wpdb->query( $query );

    这段代码首先将 meta_ids 数组转换为整数数组，然后用逗号连接成一个字符串，最后构建一个 SQL DELETE 语句，并使用 $wpdb->query() 执行该语句。

    这条 SQL 语句会从 wp_postmeta 表中删除 meta_id 存在于 $meta_ids 列表中的所有记录。

  6. 清理缓存：

    wp_cache_delete_multiple( $object_id, $meta_type . '_meta' );

    删除 Meta Data 后，需要清理缓存，以确保后续操作能够读取到最新的数据。

  7. 触发 deleted_{$meta_type}_meta 钩子：

    do_action( "deleted_{$meta_type}_meta", $meta_ids, $object_id, $meta_key, $meta_value );

    这是另一个 Action Hook，允许开发者在 Meta Data 删除之后执行自定义操作。

  8. 返回结果：

    return true;

    如果删除成功，则返回 true；否则返回 false。

四、使用示例：手把手教你删除 Meta Data

说了这么多理论，咱们来几个实际的例子，让你更好地理解 delete_post_meta() 函数的使用。

例 1：删除指定文章的指定 Meta Key 的 Meta Data

假设我们要删除文章 ID 为 123 的所有 _my_custom_field Meta Data，可以使用以下代码：

$post_id = 123;
$meta_key = '_my_custom_field';

$result = delete_post_meta( $post_id, $meta_key );

if ( $result ) {
    echo 'Meta Data 删除成功！';
} else {
    echo 'Meta Data 删除失败！';
}

例 2：删除指定文章的指定 Meta Key 和 Meta Value 的 Meta Data

假设我们要删除文章 ID 为 456 的 _my_custom_field Meta Data，并且其值为 'some_value'，可以使用以下代码：

$post_id = 456;
$meta_key = '_my_custom_field';
$meta_value = 'some_value';

$result = delete_post_meta( $post_id, $meta_key, $meta_value );

if ( $result ) {
    echo 'Meta Data 删除成功！';
} else {
    echo 'Meta Data 删除失败！';
}

例 3：删除所有文章的指定 Meta Key 的 Meta Data（慎用！）

虽然 delete_post_meta() 本身不支持删除所有文章的 Meta Data，但我们可以通过循环遍历所有文章，然后逐个删除。但是，这种方法非常危险，容易误删数据，请谨慎使用！

global $wpdb;

$meta_key = '_my_custom_field';

$post_ids = $wpdb->get_col( "SELECT ID FROM {$wpdb->posts}" );

foreach ( $post_ids as $post_id ) {
    delete_post_meta( $post_id, $meta_key );
}

echo '所有文章的 Meta Data 删除完成！';

更好的方式是使用 SQL DELETE 语句，并加上 meta_key 条件，直接删除所有文章的指定 Meta Data。 同样需要非常谨慎，做好备份！

global $wpdb;

$meta_key = '_my_custom_field';

$query = $wpdb->prepare( "DELETE FROM {$wpdb->postmeta} WHERE meta_key = %s", $meta_key );

$result = $wpdb->query( $query );

if ( $result !== false ) {
    echo '所有文章的 Meta Data 删除完成！ 删除条数：' . $result;
} else {
    echo 'Meta Data 删除失败！';
}

五、注意事项：别玩火自焚！

在使用 delete_post_meta() 函数时，一定要注意以下几点：

  • 备份数据： 在进行任何删除操作之前，一定要备份数据库，以防万一。
  • 谨慎操作： 确认你要删除的 Meta Data 是正确的，不要误删重要数据。
  • 了解 Meta Key： 确保你了解 Meta Key 的含义，不要删除 WordPress 核心或者插件使用的 Meta Data。
  • 避免循环删除： 尽量避免使用循环遍历文章并逐个删除 Meta Data，效率低且容易出错。如果需要删除大量 Meta Data，建议使用 SQL DELETE 语句。
  • 测试环境： 在正式环境操作之前，先在测试环境进行测试，确保没有问题。

六、总结：掌握删除的艺术

delete_post_meta() 函数是 WordPress 提供的一个强大的工具，可以帮助你清理数据库，优化性能。但是，它也是一把双刃剑，使用不当可能会导致数据丢失。因此，在使用 delete_post_meta() 函数时，一定要谨慎操作，做好备份，并在测试环境进行测试。

希望今天的讲座能让你对 delete_post_meta() 函数有更深入的了解。记住，掌握删除的艺术，才能更好地管理你的 WordPress 博客！

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注