[ Index ]

PHP Cross Reference of WordPress Trunk (Updated Daily)

Search

title

Body

[close]

/wp-admin/includes/ -> class-wp-site-icon.php (summary)

Administration API: WP_Site_Icon class

File Size: 237 lines (6 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

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.


create_attachment_object( $cropped, $parent_attachment_id )   X-Ref
Creates an attachment 'object'.

param: string $cropped              Cropped image URL.
param: int    $parent_attachment_id Attachment ID of parent image.
return: array An array with attachment object data.

insert_attachment( $attachment, $file )   X-Ref
Inserts an attachment.

param: array  $attachment An array with attachment object data.
param: string $file       File path of the attached image.
return: int               Attachment ID.

additional_sizes( $sizes = array()   X-Ref
Adds additional sizes to be made when creating the site icon images.

param: array[] $sizes Array of arrays containing information for additional sizes.
return: array[] Array of arrays containing additional image sizes.

intermediate_image_sizes( $sizes = array()   X-Ref
Adds Site Icon sizes to the array of image sizes on demand.

param: string[] $sizes Array of image size names.
return: string[] Array of image size names.

delete_attachment_data( $post_id )   X-Ref
Deletes the Site Icon when the image file is deleted.

param: int $post_id Attachment ID.

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.

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`.
return: array|null|string The attachment metadata value, array of values, or null.



Generated : Tue Dec 24 08:20:01 2024 Cross-referenced by PHPXref