elementor / includes / controls / media.php

media.php in Elementor Website Builder – more than just a page builder 4.1.5, at includes/controls/media.php

525 lines 14.9 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	use Elementor\Core\Utils\Hints;
5	use Elementor\Modules\DynamicTags\Module as TagsModule;
6
7	if ( ! defined( 'ABSPATH' ) ) {
8	exit; // Exit if accessed directly.
9	}
10
11	/**
12	* Elementor media control.
13	*
14	* A base control for creating a media chooser control. Based on the WordPress
15	* media library. Used to select an image from the WordPress media library.
16	*
17	* @since 1.0.0
18	*/
19	class Control_Media extends Control_Base_Multiple {
20
21	/**
22	* Get media control type.
23	*
24	* Retrieve the control type, in this case `media`.
25	*
26	* @since 1.0.0
27	* @access public
28	*
29	* @return string Control type.
30	*/
31	public function get_type() {
32	return 'media';
33	}
34
35	/**
36	* Get media control default values.
37	*
38	* Retrieve the default value of the media control. Used to return the default
39	* values while initializing the media control.
40	*
41	* @since 1.0.0
42	* @access public
43	*
44	* @return array Control default value.
45	*/
46	public function get_default_value() {
47	return [
48	'url' => '',
49	'id' => '',
50	'size' => '',
51	];
52	}
53
54	public function on_export( $settings ) {
55	if ( ! empty( $settings['url'] ) ) {
56	do_action( 'elementor/templates/collect_media_url', $settings['url'], $settings );
57	}
58
59	return $settings;
60	}
61
62	/**
63	* Import media images.
64	*
65	* Used to import media control files from external sites while importing
66	* Elementor template JSON file, and replacing the old data.
67	*
68	* @since 1.0.0
69	* @access public
70	*
71	* @param array $settings Control settings.
72	*
73	* @return array Control settings.
74	*/
75	public function on_import( $settings ) {
76	if ( empty( $settings['url'] ) ) {
77	return $settings;
78	}
79
80	$local_file_path = \Elementor\TemplateLibrary\Classes\Media_Mapper::get_local_file_path( $settings['url'] );
81	$imported_attachment = false;
82
83	if ( $local_file_path !== $settings['url'] && file_exists( $local_file_path ) ) {
84	$imported_attachment = Plugin::$instance->templates_manager->get_import_images_instance()->import_local_file( $local_file_path );
85	}
86
87	if ( $imported_attachment ) {
88	return $imported_attachment;
89	}
90
91	$settings = Plugin::$instance->templates_manager->get_import_images_instance()->import( $settings );
92
93	if ( ! $settings ) {
94	$settings = [
95	'id' => '',
96	'url' => Utils::get_placeholder_image_src(),
97	];
98	}
99
100	return $settings;
101	}
102
103	/**
104	* Support SVG and JSON Import
105	*
106	* Called by the 'upload_mimes' filter. Adds SVG and JSON mime types to the list of WordPress' allowed mime types.
107	*
108	* @since 3.4.6
109	* @deprecated 3.5.0
110	*
111	* @param mixed $mimes
112	* @return mixed
113	*/
114	public function support_svg_and_json_import( $mimes ) {
115	Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function( __METHOD__, '3.5.0' );
116
117	return $mimes;
118	}
119
120	/**
121	* Enqueue media control scripts and styles.
122	*
123	* Used to register and enqueue custom scripts and styles used by the media
124	* control.
125	*
126	* @since 1.0.0
127	* @access public
128	*/
129	public function enqueue() {
130	global $wp_version;
131
132	$suffix = Utils::is_script_debug() ? '' : '.min';
133	wp_enqueue_media();
134
135	wp_enqueue_style(
136	'media',
137	admin_url( '/css/media' . $suffix . '.css' ),
138	[],
139	$wp_version
140	);
141
142	wp_register_script(
143	'image-edit',
144	'/wp-admin/js/image-edit' . $suffix . '.js',
145	[
146	'jquery',
147	'json2',
148	'imgareaselect',
149	],
150	$wp_version,
151	true
152	);
153
154	wp_enqueue_script( 'image-edit' );
155	}
156
157	/**
158	* Render media control output in the editor.
159	*
160	* Used to generate the control HTML in the editor using Underscore JS
161	* template. The variables for the class are available using `data` JS
162	* object.
163	*
164	* @since 1.0.0
165	* @access public
166	*/
167	public function content_template() {
168	?>
169	<#
170	// For BC.
171	if ( data.media_type ) {
172	data.media_types = [ data.media_type ];
173	}
174
175	if ( data.should_include_svg_inline_option ) {
176	data.media_types.push( 'svg' );
177	}
178
179	// Determine if the current media type is viewable.
180	const isViewable = () => {
181	const viewable = [
182	'image',
183	'video',
184	'svg',
185	];
186
187	// Make sure that all media types are viewable.
188	return data.media_types.every( ( type ) => viewable.includes( type ) );
189	};
190
191	// Get the preview type for the current media type.
192	const getPreviewType = () => {
193	if ( data.media_types.includes( 'video' ) ) {
194	return 'video';
195	}
196
197	if ( data.media_types.includes( 'image' ) \|\| data.media_types.includes( 'svg' ) ) {
198	return 'image';
199	}
200
201	return 'none';
202	}
203
204	// Retrieve a button label by media type.
205	const getButtonLabel = ( mediaType ) => {
206	switch( mediaType ) {
207	case 'image':
208	return '<?php esc_html_e( 'Choose Image', 'elementor' ); ?>';
209
210	case 'video':
211	return '<?php esc_html_e( 'Choose Video', 'elementor' ); ?>';
212
213	case 'svg':
214	return '<?php esc_html_e( 'Choose SVG', 'elementor' ); ?>';
215
216	default:
217	return '<?php esc_html_e( 'Choose File', 'elementor' ); ?>';
218	}
219	}
220	#>
221	<div class="elementor-control-field elementor-control-media">
222	<label class="elementor-control-title">{{{ data.label }}}</label>
223	<#
224	if ( isViewable() ) {
225	let inputWrapperClasses = 'elementor-control-input-wrapper';
226
227	if ( ! data.label_block ) {
228	inputWrapperClasses += ' elementor-control-unit-5';
229	}
230	#>
231	<div class="{{{ inputWrapperClasses }}}">
232	<div class="elementor-control-media__content elementor-control-tag-area elementor-control-preview-area">
233	<div class="elementor-control-media-area">
234	<div class="elementor-control-media__remove elementor-control-media__content__remove" data-tooltip="<?php echo esc_attr__( 'Remove', 'elementor' ); ?>">
235	<i class="eicon-trash-o" aria-hidden="true"></i>
236	<span class="elementor-screen-only"><?php echo esc_html__( 'Remove', 'elementor' ); ?></span>
237	</div>
238	<#
239	switch( getPreviewType() ) {
240	case 'image':
241	#>
242	<div class="elementor-control-media__preview"></div>
243	<#
244	break;
245
246	case 'video':
247	#>
248	<video class="elementor-control-media-video" preload="metadata"></video>
249	<i class="eicon-video-camera" aria-hidden="true"></i>
250	<#
251	break;
252	}
253	#>
254	</div>
255	<div class="elementor-control-media-upload-button elementor-control-media__content__upload-button">
256	<i class="eicon-plus-circle" aria-hidden="true"></i>
257	<span class="elementor-screen-only"><?php echo esc_html__( 'Add', 'elementor' ); ?></span>
258	</div>
259	<div class="elementor-control-media__tools elementor-control-dynamic-switcher-wrapper">
260	<#
261	data.media_types.forEach( ( type ) => {
262	#>
263	<div class="elementor-control-media__tool elementor-control-media__replace" data-media-type="{{{ type }}}">{{{ getButtonLabel( type ) }}}</div>
264	<#
265	} );
266	#>
267	</div>
268	</div>
269
270	<?php
271	/*
272	?>
273	<div class="elementor-control-media__warnings" role="alert" style="display: none;">
274	<?php
275	Hints::get_notice_template( [
276	'type' => 'warning',
277	'content' => esc_html__( 'This image doesn’t contain ALT text - which is necessary for accessibility and SEO.', 'elementor' ),
278	'icon' => true,
279	] );
280	?>
281	</div>
282	<?php
283	*/ ?>
284	<?php $this->maybe_display_io_hints(); ?>
285	</div>
286	<# } /* endif isViewable() */ else { #>
287	<div class="elementor-control-media__file elementor-control-preview-area">
288	<div class="elementor-control-media__file__content">
289	<div class="elementor-control-media__file__content__label"><?php echo esc_html__( 'Click the media icon to upload file', 'elementor' ); ?></div>
290	<div class="elementor-control-media__file__content__info">
291	<div class="elementor-control-media__file__content__info__icon">
292	<i class="eicon-document-file"></i>
293	</div>
294	<div class="elementor-control-media__file__content__info__name"></div>
295	</div>
296	</div>
297	<div class="elementor-control-media__file__controls">
298	<div class="elementor-control-media__remove elementor-control-media__file__controls__remove" data-tooltip="<?php echo esc_attr__( 'Remove', 'elementor' ); ?>">
299	<i class="eicon-trash-o" aria-hidden="true"></i>
300	<span class="elementor-screen-only"><?php echo esc_html__( 'Remove', 'elementor' ); ?></span>
301	</div>
302	<div class="elementor-control-media__file__controls__upload-button elementor-control-media-upload-button" data-tooltip="<?php echo esc_attr__( 'Upload', 'elementor' ); ?>">
303	<i class="eicon-upload" aria-hidden="true"></i>
304	<span class="elementor-screen-only"><?php echo esc_html__( 'Upload', 'elementor' ); ?></span>
305	</div>
306	</div>
307	</div>
308	<# } #>
309	<# if ( data.description ) { #>
310	<div class="elementor-control-field-description">{{{ data.description }}}</div>
311	<# } #>
312
313	<# if ( data.has_sizes ) { #>
314	<div class="elementor-control-type-select e-control-image-size">
315	<div class="elementor-control-field">
316	<label class="elementor-control-title" data-e-responsive-switcher-sibling="false" for="<?php $this->print_control_uid( 'size' ); ?>"><?php echo esc_html__( 'Image Resolution', 'elementor' ); ?></label>
317	<div class="elementor-control-input-wrapper elementor-control-unit-5">
318	<select class="e-image-size-select" id="<?php $this->print_control_uid( 'size' ); ?>" data-setting="size">
319	<?php foreach ( $this->get_image_sizes() as $size_key => $size_title ) : ?>
320	<option value="<?php echo esc_attr( $size_key ); ?>"><?php echo esc_html( $size_title ); ?></option>
321	<?php endforeach; ?>
322	</select>
323	</div>
324	</div>
325
326	<div class="elementor-control-field-description"><?php echo esc_html__( 'Image size settings don’t apply to Dynamic Images.', 'elementor' ); ?></div>
327	</div>
328	<# } #>
329
330	<input type="hidden" data-setting="{{ data.name }}"/>
331	</div>
332	<?php
333	}
334
335	private function maybe_display_io_hints() {
336	$plugin_slug = 'image-optimization';
337
338	if ( ! Hints::should_display_hint( $plugin_slug ) ) {
339	return;
340	}
341
342	$one_subscription = Hints::is_plugin_connected_to_one_subscription();
343	$is_installed = Hints::is_plugin_installed( $plugin_slug );
344	$is_active = Hints::is_plugin_active( $plugin_slug );
345
346	if ( $is_active ) {
347	return;
348	}
349
350	if ( $one_subscription ) {
351	if ( ! $is_installed ) {
352	$content = esc_html__( 'Optimize your images to improve site speed and performance. Image Optimizer is included in your ONE subscription.', 'elementor' );
353	$button_text = esc_html__( 'Install now', 'elementor' );
354	$button_url = Hints::get_plugin_install_url( $plugin_slug );
355	$source = 'io-editor-image-one-install';
356	} elseif ( ! $is_active ) {
357	$content = esc_html__( 'Your ONE subscription includes Image Optimizer. Activate it to optimize images and improve site performance.', 'elementor' );
358	$button_text = esc_html__( 'Activate now', 'elementor' );
359	$button_url = Hints::get_plugin_activate_url( $plugin_slug );
360	$source = 'io-editor-image-one-activate';
361	}
362	} else {
363	$content = esc_html__( 'Optimize your images to enhance site performance by using Image Optimizer.', 'elementor' );
364	if ( ! $is_installed ) {
365	$button_text = esc_html__( 'Install now', 'elementor' );
366	$button_url = Hints::get_plugin_install_url( $plugin_slug );
367	$source = 'io-editor-image-install';
368	} elseif ( ! $is_active ) {
369	$button_text = esc_html__( 'Activate now', 'elementor' );
370	$button_url = Hints::get_plugin_activate_url( $plugin_slug );
371	$source = 'io-editor-image-activate';
372	}
373	}
374	?>
375	<div class="elementor-control-media__promotions" role="alert">
376	<?php
377	Hints::get_notice_template( [
378	'display' => ! Hints::is_dismissed( $plugin_slug ),
379	'type' => 'info',
380	'icon' => true,
381	'heading' => '',
382	'content' => $content,
383	'dismissible' => 'image_optimizer_hint',
384	'button_text' => $button_text,
385	'button_event' => 'image_optimizer_hint',
386	'button_data' => [
387	'action_url' => $button_url,
388	'source' => $source,
389	],
390	] );
391	?>
392	</div>
393	<?php
394	}
395
396	private function get_image_sizes(): array {
397	$wp_image_sizes = Group_Control_Image_Size::get_all_image_sizes();
398
399	$image_sizes = [];
400
401	foreach ( $wp_image_sizes as $size_key => $size_attributes ) {
402	$control_title = ucwords( str_replace( '_', ' ', $size_key ) );
403	if ( is_array( $size_attributes ) ) {
404	$control_title .= sprintf( ' - %d x %d', $size_attributes['width'], $size_attributes['height'] );
405	}
406
407	$image_sizes[ $size_key ] = $control_title;
408	}
409
410	$image_sizes[''] = esc_html_x( 'Full', 'Image Size Control', 'elementor' );
411
412	return $image_sizes;
413	}
414
415	/**
416	* Get media control default settings.
417	*
418	* Retrieve the default settings of the media control. Used to return the default
419	* settings while initializing the media control.
420	*
421	* @since 1.0.0
422	* @access protected
423	*
424	* @return array Control default settings.
425	*/
426	protected function get_default_settings() {
427	return [
428	'label_block' => true,
429	'has_sizes' => false,
430	'ai' => [
431	'active' => true,
432	'type' => 'media',
433	'category' => 'photographic',
434	],
435	'media_types' => [
436	'image',
437	],
438	'dynamic' => [
439	'categories' => [ TagsModule::IMAGE_CATEGORY ],
440	'returnType' => 'object',
441	],
442	];
443	}
444
445	/**
446	* Get media control image title.
447	*
448	* Retrieve the `title` of the image selected by the media control.
449	*
450	* @since 1.0.0
451	* @access public
452	* @static
453	*
454	* @param array $attachment Media attachment.
455	*
456	* @return string Image title.
457	*/
458	public static function get_image_title( $attachment ) {
459	if ( empty( $attachment['id'] ) ) {
460	return '';
461	}
462
463	return get_the_title( $attachment['id'] );
464	}
465
466	/**
467	* Get media control image alt.
468	*
469	* Retrieve the `alt` value of the image selected by the media control.
470	*
471	* @since 1.0.0
472	* @access public
473	* @static
474	*
475	* @param array $instance Media attachment.
476	*
477	* @return string Image alt.
478	*/
479	public static function get_image_alt( $instance ) {
480	if ( empty( $instance['id'] ) ) {
481	// For `Insert From URL` images.
482	return isset( $instance['alt'] ) ? trim( self::sanitise_text( $instance['alt'] ) ) : '';
483	}
484
485	$attachment_id = $instance['id'];
486	if ( ! $attachment_id ) {
487	return '';
488	}
489
490	$attachment = get_post( $attachment_id );
491	if ( ! $attachment ) {
492	return '';
493	}
494
495	$alt = get_post_meta( $attachment_id, '_wp_attachment_image_alt', true );
496	if ( ! $alt ) {
497	if ( Utils::has_invalid_post_permissions( $attachment ) ) {
498	return '';
499	}
500
501	$alt = $attachment->post_excerpt;
502	if ( ! $alt ) {
503	$alt = $attachment->post_title;
504	}
505	}
506	return trim( self::sanitise_text( $alt ) );
507	}
508
509	public function get_style_value( $css_property, $control_value, array $control_data ) {
510	if ( 'URL' !== $css_property \|\| empty( $control_value['id'] ) ) {
511	return parent::get_style_value( $css_property, $control_value, $control_data );
512	}
513
514	if ( empty( $control_value['size'] ) ) {
515	$control_value['size'] = 'full';
516	}
517
518	return wp_get_attachment_image_url( $control_value['id'], $control_value['size'] );
519	}
520
521	public static function sanitise_text( $text ) {
522	return esc_attr( strip_tags( $text ) );
523	}
524	}
525