阐述 `get_attachment_id_from_url()` 函数的源码，它如何通过图片 URL 反向查询其附件 ID？

各位朋友们，今天咱们来聊聊一个挺有意思的话题：如何通过图片的 URL 反向查找它对应的附件 ID。这个需求在 WordPress 开发中挺常见的，比如你想知道某个页面上的图片是哪个附件，或者想批量处理某个分类下的所有图片附件。

准备好咖啡，咱们开始吧！

1. 问题定义：URL 到 ID 的迷宫

假设你有一张图片的 URL，比如 https://example.com/wp-content/uploads/2023/10/my-image.jpg。你的目标是找到这张图片在 WordPress 媒体库里对应的附件 ID。这就像在一个巨大的迷宫里找出口，URL 是入口，ID 是出口。

2. get_attachment_id_from_url() 函数：寻宝地图

WordPress 并没有直接提供一个叫 get_attachment_id_from_url() 的内置函数，所以我们需要自己造一个轮子。这个轮子就是我们的寻宝地图，它可以帮助我们穿越 URL 的迷宫，找到隐藏的 ID。

3. 寻宝地图的构建材料：代码片段

下面是一个 get_attachment_id_from_url() 函数的 PHP 实现：

<?php

/**
 * 从 URL 获取附件 ID
 *
 * @param string $attachment_url 附件 URL.
 * @return int|false 附件 ID，如果未找到则返回 false.
 */
function get_attachment_id_from_url( $attachment_url = '' ) {

    global $wpdb;
    $attachment_id = false;

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

    // 清理 URL：移除查询字符串和锚点
    $attachment_url = preg_replace( '/#.*$/', '', $attachment_url );
    $attachment_url = preg_replace( '/?.*$/', '', $attachment_url );

    // 尝试使用 `attachment_url_to_postid()` 函数
    $attachment_id = attachment_url_to_postid( $attachment_url );

    if ( $attachment_id ) {
        return $attachment_id;
    }

    // 如果 `attachment_url_to_postid()` 失败，则进行更复杂的搜索

    // 获取上传目录的 URL
    $upload_dir = wp_upload_dir();
    $baseurl = $upload_dir['baseurl'];

    // 如果附件 URL 不是上传目录的子目录，则返回 false
    if ( false === strpos( $attachment_url, $baseurl ) ) {
        return false;
    }

    // 移除上传目录 URL，只保留相对路径
    $attachment_url = str_replace( $baseurl . '/', '', $attachment_url );

    // 构建 SQL 查询
    $sql = $wpdb->prepare(
        "SELECT post_id FROM {$wpdb->postmeta}
        WHERE meta_key = '_wp_attached_file'
        AND meta_value = %s",
        $attachment_url
    );

    // 执行查询
    $attachment_id = $wpdb->get_var( $sql );

    // 返回结果
    return $attachment_id;
}

4. 代码解读：一步一个脚印

让我们一行一行地解读这段代码，就像考古学家解读古老的象形文字一样：

• 函数定义：

  function get_attachment_id_from_url( $attachment_url = '' ) {

  定义了一个名为 get_attachment_id_from_url 的函数，它接受一个可选的参数 $attachment_url，表示附件的 URL。如果未提供 URL，则默认为空字符串。

• 空 URL 检查：

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

  如果传入的 URL 为空，则直接返回 false，因为没有 URL 就无法查找 ID。

• URL 清理：

  $attachment_url = preg_replace( '/#.*$/', '', $attachment_url );
  $attachment_url = preg_replace( '/?.*$/', '', $attachment_url );

  这两行代码使用正则表达式从 URL 中移除查询字符串（?key=value）和锚点（#anchor）。这是为了确保 URL 的精确匹配，因为查询字符串和锚点与附件 ID 无关。

• 尝试使用 attachment_url_to_postid() 函数：

  $attachment_id = attachment_url_to_postid( $attachment_url );
  
  if ( $attachment_id ) {
      return $attachment_id;
  }

  WordPress 提供了一个内置函数 attachment_url_to_postid()，它可以直接通过 URL 获取附件 ID。 我们先尝试使用这个函数，如果成功了，就直接返回 ID。 这样效率更高。

• 获取上传目录的 URL：

  $upload_dir = wp_upload_dir();
  $baseurl = $upload_dir['baseurl'];

  wp_upload_dir() 函数返回一个包含上传目录信息的数组，其中包括上传目录的 URL (baseurl)。我们需要这个 URL 来判断附件 URL 是否是上传目录的子目录。

• 检查 URL 是否是上传目录的子目录：

  if ( false === strpos( $attachment_url, $baseurl ) ) {
      return false;
  }

  strpos() 函数查找 $attachment_url 中是否包含 $baseurl。如果未找到，则说明该 URL 不是上传目录的子目录，因此返回 false。

• 移除上传目录 URL：

  $attachment_url = str_replace( $baseurl . '/', '', $attachment_url );

  str_replace() 函数从 $attachment_url 中移除 $baseurl，只保留相对路径。例如，如果 $attachment_url 是 https://example.com/wp-content/uploads/2023/10/my-image.jpg，而 $baseurl 是 https://example.com/wp-content/uploads，那么 $attachment_url 将变为 2023/10/my-image.jpg。

• 构建 SQL 查询：

  $sql = $wpdb->prepare(
      "SELECT post_id FROM {$wpdb->postmeta}
      WHERE meta_key = '_wp_attached_file'
      AND meta_value = %s",
      $attachment_url
  );

  这部分是整个函数的核心。它构建了一个 SQL 查询，用于在 wp_postmeta 表中查找附件 ID。wp_postmeta 表存储了文章的元数据，包括附件的文件名。

  • SELECT post_id: 选择 post_id 列，它存储了附件的 ID。
  • FROM {$wpdb->postmeta}: 从 wp_postmeta 表中查询。$wpdb->postmeta 是 WordPress 数据库中 wp_postmeta 表的名称。
  • WHERE meta_key = '_wp_attached_file': 筛选 meta_key 列的值为 _wp_attached_file 的行。_wp_attached_file 是一个特殊的元键，用于存储附件的文件名。
  • AND meta_value = %s: 筛选 meta_value 列的值与 $attachment_url 相等的行。%s 是一个占位符，用于防止 SQL 注入。$wpdb->prepare() 函数会将 $attachment_url 的值安全地插入到 SQL 查询中。

• 执行查询：

  $attachment_id = $wpdb->get_var( $sql );

  $wpdb->get_var() 函数执行 SQL 查询，并返回查询结果的第一行第一列的值，也就是附件 ID。

• 返回结果：

  return $attachment_id;

  返回附件 ID。如果未找到附件，则返回 false。

5. 使用方法：让寻宝地图发挥作用

要使用 get_attachment_id_from_url() 函数，只需将它添加到你的 WordPress 主题的 functions.php 文件中，或者添加到你的自定义插件中。然后，你就可以像这样调用它：

<?php
$attachment_url = 'https://example.com/wp-content/uploads/2023/10/my-image.jpg';
$attachment_id = get_attachment_id_from_url( $attachment_url );

if ( $attachment_id ) {
    echo '附件 ID: ' . $attachment_id;
} else {
    echo '未找到附件';
}

这段代码首先定义了附件的 URL，然后调用 get_attachment_id_from_url() 函数来获取附件 ID。如果找到了附件，则输出附件 ID；否则，输出“未找到附件”。

6. 高级用法：批量寻宝

get_attachment_id_from_url() 函数可以用于批量处理图片附件。例如，你可以遍历某个分类下的所有文章，然后找到每篇文章中的所有图片，并获取它们的附件 ID。

<?php
// 获取指定分类下的所有文章
$args = array(
    'category_name' => 'my-category',
    'posts_per_page' => -1, // 获取所有文章
);
$posts = get_posts( $args );

// 遍历所有文章
foreach ( $posts as $post ) {
    // 获取文章内容
    $content = $post->post_content;

    // 使用正则表达式查找文章中的所有图片 URL
    preg_match_all( '/<img[^>]+src="([^"]+)"/i', $content, $matches );

    // 遍历所有图片 URL
    foreach ( $matches[1] as $image_url ) {
        // 获取附件 ID
        $attachment_id = get_attachment_id_from_url( $image_url );

        if ( $attachment_id ) {
            echo '文章 ID: ' . $post->ID . ', 图片 URL: ' . $image_url . ', 附件 ID: ' . $attachment_id . '<br>';
        } else {
            echo '文章 ID: ' . $post->ID . ', 图片 URL: ' . $image_url . ', 未找到附件<br>';
        }
    }
}

这段代码首先获取了 my-category 分类下的所有文章，然后遍历每篇文章的内容，使用正则表达式查找文章中的所有图片 URL。最后，它调用 get_attachment_id_from_url() 函数来获取每个图片 URL 对应的附件 ID。

7. 性能优化：让寻宝之旅更高效

虽然 get_attachment_id_from_url() 函数可以帮助我们找到附件 ID，但它可能会影响网站的性能，特别是当需要处理大量图片时。为了优化性能，我们可以采取以下措施：

• 缓存结果： 将附件 ID 和 URL 之间的对应关系缓存在内存中，这样下次需要查找同一个 URL 的附件 ID 时，就可以直接从缓存中获取，而无需再次执行 SQL 查询。可以使用 WordPress 的 Transient API 来实现缓存。

  <?php
  function get_attachment_id_from_url_cached( $attachment_url = '' ) {
      // 构建缓存键
      $cache_key = 'attachment_id_' . md5( $attachment_url );
  
      // 尝试从缓存中获取附件 ID
      $attachment_id = get_transient( $cache_key );
  
      // 如果缓存中存在附件 ID，则直接返回
      if ( false !== $attachment_id ) {
          return $attachment_id;
      }
  
      // 如果缓存中不存在附件 ID，则调用 `get_attachment_id_from_url()` 函数来获取
      $attachment_id = get_attachment_id_from_url( $attachment_url );
  
      // 将附件 ID 缓存起来
      set_transient( $cache_key, $attachment_id, DAY_IN_SECONDS );
  
      // 返回附件 ID
      return $attachment_id;
  }

• 批量查询： 如果需要查找多个 URL 的附件 ID，可以构建一个包含所有 URL 的 SQL 查询，一次性获取所有附件 ID，而不是为每个 URL 都执行一次 SQL 查询。

8. 替代方案：利用 WordPress 内置函数

WordPress 提供了 attachment_url_to_postid() 函数，这个函数专门用于通过 URL 获取附件 ID。在我们的 get_attachment_id_from_url 函数中，我们首先尝试使用这个函数，如果它能直接找到 ID，就省去了后续复杂的SQL查询。

9. 常见问题与解决方案：排除寻宝过程中的障碍

• 问题： get_attachment_id_from_url() 函数返回 false。

  解决方案：

  • 检查 URL 是否正确，包括协议（http 或 https）、域名和路径。
  • 确保该 URL 对应的图片确实存在于 WordPress 媒体库中。
  • 检查上传目录的 URL 是否正确配置。
  • 确认数据库连接是否正常。

• 问题： 网站性能下降。

  解决方案：

  • 使用缓存机制，例如 WordPress 的 Transient API。
  • 避免在循环中调用 get_attachment_id_from_url() 函数，尽量使用批量查询。
  • 检查数据库查询是否优化。

10. 总结：寻宝的艺术

get_attachment_id_from_url() 函数是一个非常有用的工具，可以帮助我们通过图片 URL 反向查找附件 ID。通过理解其源码，我们可以更好地使用它，并根据实际需求进行定制和优化。记住，寻宝的艺术在于细致的观察、耐心的分析和灵活的应变。

希望今天的讲座对大家有所帮助！ 祝大家寻宝愉快！