{html_image} is a custom function that generates an HTML <img> tag. The height and width are automatically calculated from the image file if they are not supplied.
Attribute Name | Type | Required | Default | Description |
---|---|---|---|---|
file | string | Yes | n/a | name/path to image |
height | string | No | actual image height | Height to display image |
width | string | No | actual image width | Width to display image |
basedir | string | no | web server doc root | Directory to base relative paths from |
alt | string | no | "" | Alternative description of the image |
href | string | no | n/a | href value to link the image to |
path_prefix | string | no | n/a | Prefix for output path |
basedir is the base directory that relative image paths are based from. If not given, the web server's document root $_ENV['DOCUMENT_ROOT'] is used as the base. If $security is enabled, the path to the image must be within a secure directory.
href is the href value to link the image to. If link is supplied, an <a href="LINKVALUE"><a> tag is placed around the image tag.
path_prefix is an optional prefix string you can give the output path. This is useful if you want to supply a different server name for the image.
All parameters that are not in the list above are printed as name/value-pairs inside the created <img> tag.
Technical Note: {html_image} requires a hit to the disk to read the image and calculate the height and width. If you don't use template caching, it is generally better to avoid {html_image} and leave image tags static for optimal performance.