WordPress附件函数总结

最后更新于 2022 年 1 月 21 日

WordPress附件可以是图片、视频、文本文件等类型，但大部分WordPress附件函数都是针对图片的，本文总结了常用的附件函数使用方法。

WordPress附件函数

简单列举9个和附件相关的函数。

wp_get_attachment_image_src()

当你需要获取一张图片的不同尺寸版本的URL时，用这个函数。

wp_get_attachment_image_src( $attachment_id, $size, $icon );

用于图片类附件时，根据附件id和指定的尺寸（$size,默认是thumbnail）获取图片的url、width、height，以数组形式返回结果，数组形式如下

Array
(
    [0] => 图片url
    [1] => 图片宽度width
    [2] => 图片高度 height
    [3] =>  $is_intermediate的值 //true表示返回了缩放后的图片，false表示返回了原始图片
)

关于$is_intermediate参考image_downsize。

关于第三个参数$icon

如果要获取的附件不是一张图片，而是，比如说视频，让$icon为真可以返回代表视频（mime type：video）的图标，否则只能返回空值。这些代表不同mime type的图片在wordpress wp-includes/images/crystal目录下，如下图所示

wp_get_attachment_image()

wp_get_attachment_image( $attachment_id, $size, $icon, $attr );

用于图片类附件时，根据附件ID和指定的尺寸（$size,默认是thumbnail）返回完整的img标签，属性包括宽度、高度、alt等。如果是非图片类附件，$icon为true时返回代表该附件类型的图片，具体参考上面图片的说明。

关于第四个参数$attr

这个参数可以给图片标签增加更多的属性，属性用数组来指定，例如给图片增加一个title属性

wp_get_attachment_image(
    $attachment_id,
    'thumbnail',
    false,
    array('title'=>'图片标题')
 );

wp_get_attachment_url()

当你要获取原始图片的地址时，使用该函数。经剪裁产生的图片地址无法通过此函数获取，要使用 wp_get_attachment_image_src() 。

wp_get_attachment_url( $attachment_id );

//返回 https://www.solagirl.net/wp-content/uploads/2012/12/image.jpg

wp_get_attachment_link()

wp_get_attachment_link( $id, $size, $permalink, $icon, $text );

以超链接形式返回附件，链接包括：

• 如果是图片，以img标签形式返回某个尺寸的图片
• 如果不是图片，且$icon为true，以img标签形式返回代表该类型文件的图标
• 如果不是图片，且$icon为false，返回附件标题
• 由$text指定的文字

例如：

echo wp_get_attachment_link( 1 );

/*输出
<a title="图片标题" href="https://www.solagirl.net/wp-content/uploads/2012/12/image.jpg">
    <img width="150" height="150" alt="misuzu-air" class="attachment-thumbnail"
    src="https://www.solagirl.net/wp-content/uploads/2012/12/image.jpg">
</a>
*/

如果指定了$text参数，则图片将被替换成文字。

the_attachment_link()

the_attachment_link( $id, $fullsize, $deprecated, $permalink );

以超链接形式打印附件，与wp_get_attachment_link()基本类似，前者直接输出结果，后者返回结果。第二个参数不太一样，$fullsize是布尔值，只能选择true or false，表示是使用原始图片（true）还是使用WordPress产生的缩略图（false）。

get_attachment_link()

$attachment_page = get_attachment_link($attachment_id);

以字符串形式返回专门用于显示该附件的页面的url，这个页面的模版通常是attachment.php。与wp_get_attachment_url()的区别，后者以超链接形式返回附件的真实路径。

wp_get_attachment_metadata()

wp_get_attachment_metadata( $attachment_id, $unfiltered );

获取图片类附件的meta信息，附件与post一样存储在wp_posts表中，只是类型不同。attachment meta与post meta类似，存储了有关该附件的全部信息。attachment meta可以告诉我们：

• 图片的宽度、高度、原始文件路径，
• 图片会根据多媒体设定生成其它尺寸，这些不同尺寸的宽高等信息
• 包括图片本身的信息，例如copyright、iso等

wp_get_attachment_thumb_url()

wp_get_attachment_thumb_url( $attachment_id );

获取附件图像的缩略图url，缩略图尺寸在多媒体中设置（缩略图大小一项），上传图片时会自动产生缩略图。

wp_get_attachment_thumb_file()

wp_get_attachment_thumb_file( $attachment_id );

此函数和上面那位很像，唯一的区别是它返回的是附件缩略图的绝对路径，例如

/home/user/www/wp-content/uploads/2012/12/image-150x150.jpg

在使用这个函数时，发现无法正常返回结果，修复的方法是找到这个函数，修改成下面这样，函数位于wp-includes/post.php line 4234

将

if ( !empty($imagedata['thumb']) && ($thumbfile = str_replace(basename($file), $imagedata['thumb'], $file)) && file_exists($thumbfile) )
        return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );

替换成

if ( !empty($imagedata['sizes']['thumbnail']['file']) && ($thumbfile = str_replace(basename($file), $imagedata['sizes']['thumbnail']['file'], $file)) && file_exists($thumbfile) )
        return apply_filters( 'wp_get_attachment_thumb_file', $thumbfile, $post->ID );

如何获取WordPress所有可用的image sizes

WordPress允许创建自定义的image sizes，上传的图片会根据尺寸数量创建出很多版本，除了WordPress内置的尺寸，主题和插件都可以创建尺寸，使用下面的代码可以获取所有注册的尺寸。

add_action( 'wp_footer', function(){
    echo '<pre> ', var_dump( wp_get_registered_image_subsizes() ) ,'</pre>';
});

WordPress默认的图片的尺寸有：

• thumbnail
• medium
• medium_large
• large
• post-thumbnail
• 1536×1536
• 2048×2048

WooCommerce默认的尺寸有：

• woocommerce_thumbnail
• woocommerce_single
• woocommerce_gallery_thumbnail
• shop_catalog
• shop_single
• shop_thumbnail