class-jetpack-gallery-settings.php — Jetpack – WP Security, Backup, Speed, & Growth 14.9.2

jetpack / class-jetpack-gallery-settings.php

jetpack Last commit date

class-jetpack-gallery-settings.php

122 lines

1	<?php
2	/**
3	* Adding extra functions for the gallery.
4	*
5	* @package automattic/jetpack
6	*/
7
8	use Automattic\Jetpack\Assets;
9
10	/**
11	* Renders extra controls in the Gallery Settings section of the new media UI.
12	*
13	* @phan-constructor-used-for-side-effects
14	*/
15	class Jetpack_Gallery_Settings {
16	/**
17	* Available gallery types.
18	*
19	* @var array
20	*/
21	public $gallery_types;
22
23	/**
24	* The constructor.
25	*/
26	public function __construct() {
27	add_action( 'admin_init', array( $this, 'admin_init' ) );
28	}
29
30	/**
31	* Initialize the admin resources.
32	*/
33	public function admin_init() {
34	/**
35	* Filter the available gallery types.
36	*
37	* @module shortcodes, tiled-gallery
38	*
39	* @since 2.5.1
40	*
41	* @param array $value Array of the default thumbnail grid gallery type. Default array contains one key, ‘default’.
42	*/
43	$this->gallery_types = apply_filters( 'jetpack_gallery_types', array( 'default' => __( 'Thumbnail Grid', 'jetpack' ) ) );
44
45	// Enqueue the media UI only if needed.
46	if ( is_countable( $this->gallery_types ) && count( $this->gallery_types ) > 1 ) {
47	add_action( 'wp_enqueue_media', array( $this, 'wp_enqueue_media' ) );
48	add_action( 'print_media_templates', array( $this, 'print_media_templates' ) );
49	}
50	// Add Slideshow and Galleries functionality to core's media gallery widget.
51	add_filter( 'widget_media_gallery_instance_schema', array( $this, 'core_media_widget_compat' ) );
52	}
53
54	/**
55	* Updates the schema of the core gallery widget so we can save the
56	* fields that we add to Gallery Widgets, like `type` and `conditions`
57	*
58	* @param array $schema The current schema for the core gallery widget.
59	* @return array the updated schema
60	*/
61	public function core_media_widget_compat( $schema ) {
62	$schema['type'] = array(
63	'type' => 'string',
64	'enum' => array_keys( $this->gallery_types ),
65	'description' => __( 'Type of gallery.', 'jetpack' ),
66	'default' => 'default',
67	);
68	return $schema;
69	}
70
71	/**
72	* Registers/enqueues the gallery settings admin js.
73	*/
74	public function wp_enqueue_media() {
75	if ( ! wp_script_is( 'jetpack-gallery-settings', 'registered' ) ) {
76	/**
77	* This only happens if we're not in Jetpack, but on WPCOM instead.
78	* This is the correct path for WPCOM.
79	*/
80	wp_register_script(
81	'jetpack-gallery-settings',
82	Assets::get_file_url_for_environment( '_inc/build/gallery-settings.min.js', '_inc/gallery-settings.js' ),
83	array( 'jquery', 'media-views' ),
84	'20121225',
85	false
86	);
87	}
88
89	wp_enqueue_script( 'jetpack-gallery-settings' );
90	}
91
92	/**
93	* Outputs a view template which can be used with wp.media.template
94	*/
95	public function print_media_templates() {
96	/**
97	* Filter the default gallery type.
98	*
99	* @module tiled-gallery
100	*
101	* @since 2.5.1
102	*
103	* @param string $value A string of the gallery type. Default is ‘default’.
104	*/
105	$default_gallery_type = apply_filters( 'jetpack_default_gallery_type', 'default' );
106
107	?>
108	<script type="text/html" id="tmpl-jetpack-gallery-settings">
109	<label class="setting">
110	<span><?php esc_html_e( 'Type', 'jetpack' ); ?></span>
111	<select class="type" name="type" data-setting="type">
112	<?php foreach ( $this->gallery_types as $value => $caption ) : ?>
113	<option value="<?php echo esc_attr( $value ); ?>" <?php selected( $value, $default_gallery_type ); ?>><?php echo esc_html( $caption ); ?></option>
114	<?php endforeach; ?>
115	</select>
116	</label>
117	</script>
118	<?php
119	}
120	}
121	new Jetpack_Gallery_Settings();
122