WP_Site_Icon::insert_attachment( array $attachment, string $file ): int

Inserts an attachment.


Parameters

$attachment array Required
An array with attachment object data.
$file string Required
File path of the attached image.

Top ↑

Return

int Attachment ID.


Top ↑

Source

File: wp-admin/includes/class-wp-site-icon.php. View all references

public function insert_attachment( $attachment, $file ) {
	$attachment_id = wp_insert_attachment( $attachment, $file );
	$metadata      = wp_generate_attachment_metadata( $attachment_id, $file );

	/**
	 * Filters the site icon attachment metadata.
	 *
	 * @since 4.3.0
	 *
	 * @see wp_generate_attachment_metadata()
	 *
	 * @param array $metadata Attachment metadata.
	 */
	$metadata = apply_filters( 'site_icon_attachment_metadata', $metadata );
	wp_update_attachment_metadata( $attachment_id, $metadata );

	return $attachment_id;
}

Top ↑

Hooks



Top ↑

Changelog

Changelog
Version Description
4.3.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.