On this page
get_attachment_icon( int $id, bool $fullsize = false, array $max_dims = false ): string|false
This function has been deprecated. Use wp_get_attachment_image() instead.
Retrieve HTML content of icon attachment image element.
Description
See also
Parameters
$idint Optional-
Post ID.
$fullsizebool Optional-
Whether to have full size image.
Default:
false $max_dimsarray Optional-
Dimensions of image.
Default:
false
Return
string|false HTML content.
Source
File: wp-includes/deprecated.php. View all references
function get_attachment_icon( $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 ( !$src = get_attachment_icon_src( $post->ID, $fullsize ) )
return false;
list($src, $src_file) = $src;
// Do we need to constrain the image?
if ( ($max_dims = apply_filters('attachment_max_dims', $max_dims)) && file_exists($src_file) ) {
$imagesize = wp_getimagesize($src_file);
if (($imagesize[0] > $max_dims[0]) || $imagesize[1] > $max_dims[1] ) {
$actual_aspect = $imagesize[0] / $imagesize[1];
$desired_aspect = $max_dims[0] / $max_dims[1];
if ( $actual_aspect >= $desired_aspect ) {
$height = $actual_aspect * $max_dims[0];
$constraint = "width='{$max_dims[0]}' ";
$post->iconsize = array($max_dims[0], $height);
} else {
$width = $max_dims[1] / $actual_aspect;
$constraint = "height='{$max_dims[1]}' ";
$post->iconsize = array($width, $max_dims[1]);
}
} else {
$post->iconsize = array($imagesize[0], $imagesize[1]);
$constraint = '';
}
} else {
$constraint = '';
}
$post_title = esc_attr($post->post_title);
$icon = "<img src='$src' title='$post_title' alt='$post_title' $constraint/>";
return apply_filters( 'attachment_icon', $icon, $post->ID );
}
Related
Uses
| Uses | Description |
|---|---|
| wp_getimagesize() wp-includes/media.php | Allows PHP’s getimagesize() to be debuggable when necessary. |
| get_attachment_icon_src() wp-includes/deprecated.php | Retrieve icon URL and Path. |
| esc_attr() wp-includes/formatting.php | Escaping for HTML attributes. |
| _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. |
Used By
| Used By | Description |
|---|---|
| get_attachment_innerHTML() wp-includes/deprecated.php | Retrieve HTML content of image element. |
Changelog
| Version | Description |
|---|---|
| 2.5.0 | Use wp_get_attachment_image() |
| 2.0.0 | Introduced. |
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_attachment_icon