函数文档

get_attachment_innerHTML()

💡 云策文档标注

概述

get_attachment_innerHTML() 是一个已弃用的 WordPress 函数,用于获取图像元素的 HTML 内容。自 WordPress 2.5.0 起,建议使用 wp_get_attachment_image() 替代。

关键要点

  • 函数已弃用:自 WordPress 2.5.0 起,使用 wp_get_attachment_image() 替代。
  • 功能:根据附件 ID 生成图像 HTML 内容,支持全尺寸和最大尺寸参数。
  • 返回值:成功时返回 HTML 字符串,失败时返回 false。
  • 相关函数:涉及 get_attachment_icon()、esc_attr()、apply_filters() 等。

代码示例

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

    if ( $innerHTML = get_attachment_icon($post->ID, $fullsize, $max_dims))
        return $innerHTML;

    $innerHTML = esc_attr($post->post_title);

    return apply_filters('attachment_innerHTML', $innerHTML, $post->ID);
}

注意事项

  • 此函数已弃用,新代码应避免使用,改用 wp_get_attachment_image()。
  • 参数 $id 为可选附件 ID,$fullsize 控制是否使用全尺寸图像,$max_dims 指定图像最大尺寸。
  • 函数内部调用 _deprecated_function() 标记弃用,并可能触发相关警告。

📄 原文内容

Retrieve HTML content of image element.

Description

See also

Parameters

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

Default:false

$max_dimsarrayoptional
Dimensions of image.

Default:false

Return

string|false

Source

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

	if ( $innerHTML = get_attachment_icon($post->ID, $fullsize, $max_dims))
		return $innerHTML;

	$innerHTML = esc_attr($post->post_title);

	return apply_filters('attachment_innerHTML', $innerHTML, $post->ID);
}

Changelog

Version Description
2.5.0 Deprecated. Use wp_get_attachment_image()
2.0.0 Introduced.