get_attachment_icon_src()

💡 云策文档标注

概述

get_attachment_icon_src() 是一个已弃用的 WordPress 函数，用于根据附件 ID 检索图标的 URL 和文件路径。该函数自 WordPress 2.5.0 起被弃用，建议使用 wp_get_attachment_image_src() 替代。

关键要点

函数已弃用：自 WordPress 2.5.0 起，应使用 wp_get_attachment_image_src() 替代。
参数：接受 $id（附件 ID，可选，默认 0）和 $fullsize（是否返回完整尺寸图像，可选，默认 false）。
返回值：返回一个数组，包含图标的 URL 和完整文件路径；若失败则返回 false。
功能逻辑：根据附件类型（缩略图、图像或 MIME 类型图标）动态确定图标源。
相关 Hook：apply_filters('icon_dir', string $path) 用于过滤图标目录路径。

代码示例

function get_attachment_icon_src( $id = 0, $fullsize = false ) {
    _deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image_src()' );
    $id = (int) $id;
    if ( !$post = get_post($id) )
        return false;

    $file = get_attached_file( $post->ID );

    if ( !$fullsize && $src = wp_get_attachment_thumb_url( $post->ID ) ) {
        $src_file = wp_basename($src);
    } elseif ( wp_attachment_is_image( $post->ID ) ) {
        $src = wp_get_attachment_url( $post->ID );
        $src_file = & $file;
    } elseif ( $src = wp_mime_type_icon( $post->ID, '.svg' ) ) {
        $icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' );
        $src_file = $icon_dir . '/' . wp_basename($src);
    }

    if ( !isset($src) || !$src )
        return false;

    return array($src, $src_file);
}

注意事项

此函数已弃用，新代码中应避免使用，以免影响兼容性。
函数内部调用了多个 WordPress 核心函数，如 wp_get_attachment_thumb_url() 和 wp_mime_type_icon()，需确保这些函数可用。
返回值可能因附件类型而异，开发时需处理 false 返回值情况。

📄 原文内容

Retrieve icon URL and Path.

Description

Parameters

$idintoptional: Post ID.
$fullsizebooloptional: Whether to have full image.

Default:false

Return

array Icon URL and full path to file, respectively.

Source

function get_attachment_icon_src( $id = 0, $fullsize = false ) {
	_deprecated_function( __FUNCTION__, '2.5.0', 'wp_get_attachment_image_src()' );
	$id = (int) $id;
	if ( !$post = get_post($id) )
		return false;

	$file = get_attached_file( $post->ID );

	if ( !$fullsize && $src = wp_get_attachment_thumb_url( $post->ID ) ) {
		// We have a thumbnail desired, specified and existing.

		$src_file = wp_basename($src);
	} elseif ( wp_attachment_is_image( $post->ID ) ) {
		// We have an image without a thumbnail.

		$src = wp_get_attachment_url( $post->ID );
		$src_file = & $file;
	} elseif ( $src = wp_mime_type_icon( $post->ID, '.svg' ) ) {
		// No thumb, no image. We'll look for a mime-related icon instead.

		/** This filter is documented in wp-includes/post.php */
		$icon_dir = apply_filters( 'icon_dir', get_template_directory() . '/images' );
		$src_file = $icon_dir . '/' . wp_basename($src);
	}

	if ( !isset($src) || !$src )
		return false;

	return array($src, $src_file);
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘icon_dir’, string $path ): Filters the icon directory path.

Uses	Description
get_template_directory()`wp-includes/theme.php`	Retrieves template directory path for the active theme.
wp_attachment_is_image()`wp-includes/post.php`	Determines whether an attachment is an image.
wp_mime_type_icon()`wp-includes/post.php`	Retrieves the icon for a MIME type or attachment.
wp_get_attachment_thumb_url()`wp-includes/post.php`	Retrieves URL for an attachment thumbnail.
wp_get_attachment_url()`wp-includes/post.php`	Retrieves the URL for an attachment.
get_attached_file()`wp-includes/post.php`	Retrieves attached file path based on attachment ID.
wp_basename()`wp-includes/formatting.php`	i18n-friendly version of basename().
_deprecated_function()`wp-includes/functions.php`	Marks a function as deprecated and inform when it has been used.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 5 more Show less

Used by	Description
get_attachment_icon()`wp-includes/deprecated.php`	Retrieve HTML content of icon attachment image element.

Changelog

Version	Description
2.5.0	Deprecated. Use wp_get_attachment_image_src()
2.1.0	Introduced.

云策 WordPress 开发者社区

函数文档