| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Administration API: WP_Site_Icon class
| File Size: | 233 lines (6 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_Site_Icon:: (7 methods):
__construct()
create_attachment_object()
insert_attachment()
additional_sizes()
intermediate_image_sizes()
delete_attachment_data()
get_post_metadata()
Class: WP_Site_Icon - X-Ref
Core class used to implement site icon functionality.| __construct() X-Ref |
| Registers actions and filters. since: 4.3.0 |
| create_attachment_object( $cropped, $parent_attachment_id ) X-Ref |
| Creates an attachment 'object'. return: array An array with attachment object data. param: string $cropped Cropped image URL. param: int $parent_attachment_id Attachment ID of parent image. since: 4.3.0 |
| insert_attachment( $attachment, $file ) X-Ref |
| Inserts an attachment. return: int Attachment ID. param: array $attachment An array with attachment object data. param: string $file File path of the attached image. since: 4.3.0 |
| additional_sizes( $sizes = array() X-Ref |
| Adds additional sizes to be made when creating the site icon images. return: array[] Array of arrays containing additional image sizes. param: array[] $sizes Array of arrays containing information for additional sizes. since: 4.3.0 |
| intermediate_image_sizes( $sizes = array() X-Ref |
| Adds Site Icon sizes to the array of image sizes on demand. return: string[] Array of image size names. param: string[] $sizes Array of image size names. since: 4.3.0 |
| delete_attachment_data( $post_id ) X-Ref |
| Deletes the Site Icon when the image file is deleted. param: int $post_id Attachment ID. since: 4.3.0 |
| get_post_metadata( $value, $post_id, $meta_key, $single ) X-Ref |
| Adds custom image sizes when meta data for an image is requested, that happens to be used as Site Icon. return: array|null|string The attachment metadata value, array of values, or null. param: null|array|string $value The value get_metadata() should return a single metadata value, or an param: int $post_id Post ID. param: string $meta_key Meta key. param: bool $single Whether to return only the first value of the specified `$meta_key`. since: 4.3.0 |
| Generated: Sat Nov 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |