深入理解 WordPress `get_attachment_id_from_url()` 函数源码：如何通过 URL 反向查询附件 ID。 - 智猿学院-前后端，数据库，人工智能，云计算等领域前沿技术讲座

各位观众老爷们，晚上好！今天咱不聊风花雪月，专啃硬骨头，来扒一扒 WordPress 源码里一个不起眼，但关键时刻能救命的小函数： get_attachment_id_from_url()。顾名思义，它的作用就是通过一个 URL，找到对应的附件 ID。看起来简单，但实现起来却有不少门道。咱们今天就把它拆开了揉碎了，彻底搞明白。

一、为什么我们需要这个函数？

在开始之前，先来聊聊应用场景。想象一下，你遇到了以下几种情况：

从数据库中获取的图片 URL: 你可能直接从数据库中取出了图片 URL，但需要在代码中操作这个图片，比如调整大小、添加水印等等。 WordPress 很多函数都需要附件 ID 作为参数，这时你就需要 get_attachment_id_from_url() 来救场。
用户提交的图片 URL: 用户在后台编辑文章时，可能会粘贴一个外部图片的 URL。你想把这个图片保存到 WordPress 媒体库，并将其设置为特色图片，同样需要先获取到附件 ID。
主题或插件需要处理已存在的图片 URL: 有些主题或插件会自定义图片处理逻辑，它们可能需要根据 URL 查找对应的附件 ID，以便进行进一步的操作。

总而言之，只要你需要根据图片 URL 找到它在 WordPress 媒体库中的身份，get_attachment_id_from_url() 就能派上用场。

二、 get_attachment_id_from_url() 源码解读

好了，废话不多说，直接上代码！这是 WordPress 核心代码中 get_attachment_id_from_url() 函数的简化版（去掉了部分缓存和错误处理逻辑，保留了核心功能）：

function get_attachment_id_from_url( $url ) {
    global $wpdb;

    // 如果 URL 为空，直接返回 0
    if ( empty( $url ) ) {
        return 0;
    }

    // 首先，尝试从完全匹配的 URL 查找附件 ID
    $attachment_id = $wpdb->get_var( $wpdb->prepare(
        "SELECT wposts.ID
        FROM {$wpdb->posts} wposts, {$wpdb->postmeta} wpostmeta
        WHERE wposts.ID = wpostmeta.post_id
        AND wpostmeta.meta_key = '_wp_attached_file'
        AND wpostmeta.meta_value = %s
        AND wposts.post_type = 'attachment'",
        $url
    ) );

    if ( $attachment_id ) {
        return $attachment_id;
    }

    // 如果没有找到完全匹配的 URL，尝试匹配 URL 的文件名部分
    $parsed_url  = wp_parse_url( $url );
    $file        = isset( $parsed_url['path'] ) ? ltrim( $parsed_url['path'], '/' ) : '';
    $file_name   = wp_basename( $file );

    if ( ( $uploads = wp_upload_dir() ) && false === $uploads['error'] ) {
        // 构建附件在上传目录中的完整路径
        $search_path = $uploads['basedir'] . '/' . $file_name;

        $attachment_id = $wpdb->get_var( $wpdb->prepare(
            "SELECT wposts.ID
            FROM {$wpdb->posts} wposts, {$wpdb->postmeta} wpostmeta
            WHERE wposts.ID = wpostmeta.post_id
            AND wpostmeta.meta_key = '_wp_attached_file'
            AND wpostmeta.meta_value LIKE %s
            AND wposts.post_type = 'attachment'",
            '%' . $file_name
        ) );

        if ( $attachment_id ) {
            return $attachment_id;
        }
    }

    return 0;
}

这段代码看起来有点长，但其实逻辑非常清晰，咱们一步一步来分析：

参数校验: 首先，函数会检查传入的 URL 是否为空，如果为空，直接返回 0。这是一个良好的编程习惯，可以避免后续的错误。
完全匹配查询: 这是最直接的方式，它会尝试在数据库中找到与传入 URL 完全匹配的附件。它通过以下 SQL 查询实现：
```
SELECT wposts.ID
FROM {$wpdb->posts} wposts, {$wpdb->postmeta} wpostmeta
WHERE wposts.ID = wpostmeta.post_id
AND wpostmeta.meta_key = '_wp_attached_file'
AND wpostmeta.meta_value = %s
AND wposts.post_type = 'attachment'
```
这个 SQL 查询连接了 wp_posts 和 wp_postmeta 表，查找 post_type 为 attachment，且 _wp_attached_file 元数据的值与传入 URL 完全匹配的附件 ID。 _wp_attached_file 这个元数据存储了附件的完整 URL，包括上传目录和文件名。
文件名匹配查询: 如果完全匹配没有找到，函数会尝试只匹配 URL 的文件名部分。这种情况通常发生在以下几种情况：
- URL 中包含查询参数: 例如，http://example.com/wp-content/uploads/2023/10/image.jpg?v=123。完全匹配会失败，但文件名 image.jpg 仍然可以匹配。
- 附件存储在不同的子目录: 虽然 _wp_attached_file 存储了完整的 URL，但文件可能被移动到其他子目录。只匹配文件名可以增加匹配的成功率。
文件名匹配的 SQL 查询如下：
```
SELECT wposts.ID
FROM {$wpdb->posts} wposts, {$wpdb->postmeta} wpostmeta
WHERE wposts.ID = wpostmeta.post_id
AND wpostmeta.meta_key = '_wp_attached_file'
AND wpostmeta.meta_value LIKE %s
AND wposts.post_type = 'attachment'
```
注意，这里使用了 LIKE 操作符，并且在文件名前后添加了 % 通配符，表示匹配包含该文件名的任何字符串。
返回结果: 如果找到了匹配的附件 ID，函数会立即返回该 ID。如果没有找到，则返回 0。

三、源码细节剖析

现在，让我们更深入地了解一下源码中的一些关键细节：

$wpdb->prepare(): 这个函数用于预处理 SQL 查询，可以有效地防止 SQL 注入攻击。它会将占位符（例如 %s）替换为实际的值，并对值进行转义，确保其安全性。
wp_parse_url(): 这个函数用于解析 URL，将其分解为不同的组成部分，例如协议、主机名、路径等等。在这里，我们使用它来获取 URL 的路径部分。
wp_basename(): 这个函数用于从路径中提取文件名。例如，wp_basename('/wp-content/uploads/2023/10/image.jpg') 将返回 image.jpg。
wp_upload_dir(): 这个函数返回 WordPress 上传目录的信息，包括基本目录、基本 URL 等等。我们需要使用它来构建附件在上传目录中的完整路径，以便进行文件名匹配。
_wp_attached_file 元数据: 这个元数据存储了附件的完整 URL，是 get_attachment_id_from_url() 函数的核心依赖。在上传附件时，WordPress 会自动创建这个元数据，并将其值设置为附件的 URL。

四、性能优化考量

虽然 get_attachment_id_from_url() 函数的功能很强大，但它也存在一些性能问题。每次调用该函数，都需要执行 SQL 查询，这会消耗一定的数据库资源。如果频繁调用该函数，可能会对网站的性能产生影响。

为了优化性能，可以考虑以下几种方法：

使用缓存: 可以将已经查询过的 URL 和附件 ID 存储在缓存中。下次再次查询相同的 URL 时，直接从缓存中获取结果，避免重复执行 SQL 查询。 WordPress 本身也提供了一些缓存机制，例如对象缓存，可以用来存储这些数据。
减少不必要的调用: 在代码中，尽量避免不必要的 get_attachment_id_from_url() 函数调用。例如，如果已经知道附件 ID，就不要再使用 URL 来查找 ID。
索引优化: 如果经常需要根据 URL 查找附件 ID，可以考虑在 wp_postmeta 表的 meta_value 列上创建索引。这可以加快 SQL 查询的速度。

五、实际应用案例

为了更好地理解 get_attachment_id_from_url() 函数的应用，我们来看几个实际的例子：

根据 URL 设置特色图片:

$image_url = 'http://example.com/wp-content/uploads/2023/10/image.jpg';
$attachment_id = get_attachment_id_from_url( $image_url );

if ( $attachment_id ) {
    set_post_thumbnail( get_the_ID(), $attachment_id );
} else {
    // 处理未找到附件的情况
    echo '未找到对应的附件';
}

这段代码首先使用 get_attachment_id_from_url() 函数根据 URL 查找附件 ID，然后使用 set_post_thumbnail() 函数将该附件设置为当前文章的特色图片。

根据 URL 获取附件的元数据:

$image_url = 'http://example.com/wp-content/uploads/2023/10/image.jpg';
$attachment_id = get_attachment_id_from_url( $image_url );

if ( $attachment_id ) {
    $image_meta = wp_get_attachment_metadata( $attachment_id );
    // 输出图片的宽度和高度
    echo '宽度：' . $image_meta['width'] . '<br>';
    echo '高度：' . $image_meta['height'];
} else {
    // 处理未找到附件的情况
    echo '未找到对应的附件';
}

这段代码首先使用 get_attachment_id_from_url() 函数根据 URL 查找附件 ID，然后使用 wp_get_attachment_metadata() 函数获取附件的元数据，例如宽度、高度、文件大小等等。

六、总结

get_attachment_id_from_url() 函数是 WordPress 中一个非常实用的工具函数，它可以根据 URL 查找对应的附件 ID。虽然它的实现逻辑比较简单，但却在很多场景下都非常有用。通过深入了解该函数的源码，我们可以更好地理解 WordPress 的内部机制，并能够更有效地使用它来解决实际问题。

为了方便大家理解，我把今天的内容整理成了一个表格：

功能	说明
函数名称	`get_attachment_id_from_url()`
功能描述	根据 URL 查找附件 ID
主要步骤	1. 参数校验 2. 完全匹配查询 3. 文件名匹配查询 4. 返回结果
关键函数	`wp_parse_url()`, `wp_basename()`, `wp_upload_dir()`
性能优化	1. 使用缓存 2. 减少不必要的调用 3. 索引优化
应用场景	1. 从数据库中获取的图片 URL 2. 用户提交的图片 URL 3. 主题或插件需要处理已存在的图片 URL
依赖元数据	`_wp_attached_file`

希望今天的讲解对大家有所帮助！如果大家还有什么问题，欢迎随时提问。咱们下期再见！

发表回复 取消回复

发表回复取消回复