class.jetpack-photon-image-sizes.php — Jetpack – WP Security, Backup, Speed, & Growth 12.1.3

jetpack / _inc / lib / class.jetpack-photon-image-sizes.php

jetpack / _inc / lib Last commit date

class.jetpack-photon-image-sizes.php

192 lines

1	<?php // phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2	/**
3	* The Image Sizes library.
4	*
5	* @package automattic/jetpack
6	*/
7
8	require_once JETPACK__PLUGIN_DIR . '_inc/lib/class.jetpack-photon-image.php';
9
10	/**
11	* Class Jetpack_Photon_ImageSizes
12	*
13	* Manages image resizing via Jetpack CDN Service.
14	*/
15	class Jetpack_Photon_ImageSizes {
16
17	/**
18	* Attachment metadata.
19	*
20	* @var array
21	*/
22	public $data;
23
24	/**
25	* Image to be resized.
26	*
27	* @var Image
28	*/
29	public $image;
30
31	/**
32	* Intermediate sizes.
33	*
34	* @var null\|array
35	*/
36	public static $sizes = null;
37
38	/**
39	* Construct new sizes meta
40	*
41	* @param int $attachment_id Attachment ID.
42	* @param array $data Attachment metadata.
43	*/
44	public function __construct( $attachment_id, $data ) {
45	$this->data = $data;
46	$this->image = new Jetpack_Photon_Image( $data, get_post_mime_type( $attachment_id ) );
47	$this->generate_sizes();
48	}
49
50	/**
51	* Generate sizes for attachment.
52	*
53	* @return array Array of sizes; empty array as failure fallback.
54	*/
55	protected function generate_sizes() {
56
57	// There is no need to generate the sizes a new for every single image.
58	if ( null !== self::$sizes ) {
59	return self::$sizes;
60	}
61
62	/*
63	* The following logic is copied over from wp_generate_attachment_metadata
64	*/
65	$_wp_additional_image_sizes = wp_get_additional_image_sizes();
66
67	$sizes = array();
68
69	$intermediate_image_sizes = get_intermediate_image_sizes();
70
71	foreach ( $intermediate_image_sizes as $s ) {
72	$sizes[ $s ] = array(
73	'width' => '',
74	'height' => '',
75	'crop' => false,
76	);
77	if ( isset( $_wp_additional_image_sizes[ $s ]['width'] ) ) {
78	// For theme-added sizes.
79	$sizes[ $s ]['width'] = (int) $_wp_additional_image_sizes[ $s ]['width'];
80	} else {
81	// For default sizes set in options.
82	$sizes[ $s ]['width'] = get_option( "{$s}_size_w" );
83	}
84
85	if ( isset( $_wp_additional_image_sizes[ $s ]['height'] ) ) {
86	// For theme-added sizes.
87	$sizes[ $s ]['height'] = (int) $_wp_additional_image_sizes[ $s ]['height'];
88	} else {
89	// For default sizes set in options.
90	$sizes[ $s ]['height'] = get_option( "{$s}_size_h" );
91	}
92
93	if ( isset( $_wp_additional_image_sizes[ $s ]['crop'] ) ) {
94	// For theme-added sizes.
95	$sizes[ $s ]['crop'] = $_wp_additional_image_sizes[ $s ]['crop'];
96	} else {
97	// For default sizes set in options.
98	$sizes[ $s ]['crop'] = get_option( "{$s}_crop" );
99	}
100	}
101
102	self::$sizes = $sizes;
103
104	return $sizes;
105	}
106
107	/**
108	* Add filtered sizes.
109	*
110	* @return array
111	*/
112	public function filtered_sizes() {
113	// Remove filter preventing the creation of advanced sizes.
114	remove_filter(
115	'intermediate_image_sizes_advanced',
116	array( 'Jetpack_Photon', 'filter_photon_noresize_intermediate_sizes' )
117	);
118
119	/** This filter is documented in wp-admin/includes/image.php */
120	$sizes = apply_filters( 'intermediate_image_sizes_advanced', self::$sizes, $this->data );
121
122	// Re-add the filter removed above.
123	add_filter(
124	'intermediate_image_sizes_advanced',
125	array( 'Jetpack_Photon', 'filter_photon_noresize_intermediate_sizes' )
126	);
127
128	return (array) $sizes;
129	}
130
131	/**
132	* Standardises and validates the size_data array.
133	*
134	* @param array $size_data Size data array - at least containing height or width key. Can contain crop as well.
135	*
136	* @return array Array with populated width, height and crop keys; empty array if no width and height are provided.
137	*/
138	public function standardize_size_data( $size_data ) {
139	$has_at_least_width_or_height = ( isset( $size_data['width'] ) \|\| isset( $size_data['height'] ) );
140	if ( ! $has_at_least_width_or_height ) {
141	return array();
142	}
143
144	$defaults = array(
145	'width' => null,
146	'height' => null,
147	'crop' => false,
148	);
149
150	return array_merge( $defaults, $size_data );
151	}
152
153	/**
154	* Get sizes for attachment post meta.
155	*
156	* @return array ImageSizes for attachment postmeta.
157	*/
158	public function generate_sizes_meta() {
159
160	$metadata = array();
161
162	foreach ( $this->filtered_sizes() as $size => $size_data ) {
163
164	$size_data = $this->standardize_size_data( $size_data );
165
166	if ( true === empty( $size_data ) ) {
167	continue;
168	}
169
170	$resized_image = $this->resize( $size_data );
171
172	if ( true === is_array( $resized_image ) ) {
173	$metadata[ $size ] = $resized_image;
174	}
175	}
176
177	return $metadata;
178	}
179
180	/**
181	* Resize image.
182	*
183	* @param array $size_data Resize parameters.
184	*
185	* @return array\|\WP_Error Array for usage in $metadata['sizes']; WP_Error on failure.
186	*/
187	protected function resize( $size_data ) {
188
189	return $this->image->get_size( $size_data );
190	}
191	}
192