Files
Filename | Hook Type | Line Number | PHP Doc |
---|---|---|---|
wp-includes/post-template.php | apply_filters | 1680 | /** * Filters a retrieved attachment page link. * * @since 2.7.0 * @since 5.1.0 Added the `$attr` parameter. * * @param string $link_html The page link HTML output. * @param int|WP_Post $post Post ID or object. Can be 0 for the current global post. * @param string|int[] $size Requested image size. Can be any registered image size name, or * an array of width and height values in pixels (in that order). * @param bool $permalink Whether to add permalink to image. Default false. * @param bool $icon Whether to include an icon. * @param string|false $text If string, will be link text. * @param array|string $attr Array or string of attributes. */ |
Hook Parameters
Parameter Type | Name | Description |
---|---|---|
string | $link_html | The page link HTML output. |
int|WP_Post | $post | Post ID or object. Can be 0 for the current global post. |
string|int[] | $size | Requested image size. Can be any registered image size name, or |
bool | $permalink | Whether to add permalink to image. Default false. |
bool | $icon | Whether to include an icon. |
string|false | $text | If string, will be link text. |
array|string | $attr | Array or string of attributes. |