class-shortcode-creator.php — Advanced Ads – Ad Manager & AdSense 2.0.21

advanced-ads / includes / admin / class-shortcode-creator.php

advanced-ads / includes / admin Last commit date

class-shortcode-creator.php

203 lines

1	<?php
2	/**
3	* Admin Shortcode Creator.
4	*
5	* @package AdvancedAds
6	* @author Advanced Ads <info@wpadvancedads.com>
7	* @since 1.50.0
8	*/
9
10	namespace AdvancedAds\Admin;
11
12	use _WP_Editors;
13	use AdvancedAds\Utilities\Data;
14	use AdvancedAds\Utilities\Conditional;
15	use AdvancedAds\Framework\Interfaces\Integration_Interface;
16
17	defined( 'ABSPATH' ) \|\| exit;
18
19	/**
20	* Admin Shortcode Creator.
21	*/
22	class Shortcode_Creator implements Integration_Interface {
23
24	/**
25	* Contains ids of the editors that contains the Advanced Ads button.
26	*
27	* @var array
28	*/
29	private $editors = [];
30
31	/**
32	* Hook into WordPress.
33	*
34	* @return void
35	*/
36	public function hooks(): void {
37	if (
38	true !== boolval( get_user_option( 'rich_editing' ) ) \|\|
39	! Conditional::user_can( 'advanced_ads_place_ads' ) \|\|
40	defined( 'ADVANCED_ADS_DISABLE_SHORTCODE_BUTTON' ) \|\|
41	apply_filters( 'advanced-ads-disable-shortcode-button', false )
42	) {
43	return;
44	}
45
46	add_filter( 'mce_buttons', [ $this, 'register_buttons' ], 10, 2 );
47	add_filter( 'tiny_mce_plugins', [ $this, 'register_plugin' ] );
48	add_filter( 'tiny_mce_before_init', [ $this, 'tiny_mce_before_init' ], 10, 2 );
49
50	add_action( 'wp_tiny_mce_init', [ $this, 'print_shortcode_plugin' ] );
51	add_action( 'print_default_editor_scripts', [ $this, 'print_shortcode_plugin' ] );
52
53	add_action( 'wp_ajax_advads_content_for_shortcode_creator', [ $this, 'get_content_for_shortcode_creator' ] );
54	}
55
56	/**
57	* Add button to tinyMCE window
58	*
59	* @param array $buttons Array with existing buttons.
60	* @param string $editor_id Unique editor identifier.
61	*
62	* @return array
63	*/
64	public function register_buttons( $buttons, $editor_id ): array {
65	if ( ! $this->hooks_exist() ) {
66	return $buttons;
67	}
68
69	if ( ! is_array( $buttons ) ) {
70	$buttons = [];
71	}
72
73	$this->editors[] = $editor_id;
74	$buttons[] = 'advads_shortcode_button';
75
76	return $buttons;
77	}
78
79	/**
80	* Add the plugin to the array of default TinyMCE plugins.
81	*
82	* @param array $plugins An array of default TinyMCE plugins.
83	*
84	* @return array
85	*/
86	public function register_plugin( $plugins ): array {
87	if ( ! $this->hooks_exist() ) {
88	return $plugins;
89	}
90
91	$plugins[] = 'advads_shortcode';
92
93	return $plugins;
94	}
95
96	/**
97	* Delete the plugin added by the {@see `tiny_mce_plugins`} method when necessary hooks do not exist.
98	*
99	* @param array $mce_init An array with TinyMCE config.
100	* @param string $editor_id Unique editor identifier.
101	*
102	* @return array
103	*/
104	public function tiny_mce_before_init( $mce_init, $editor_id = '' ): array {
105	// Early bail!!
106	if ( ! isset( $mce_init['plugins'] ) \|\| ! is_string( $mce_init['plugins'] ) ) {
107	return $mce_init;
108	}
109
110	$plugins = explode( ',', $mce_init['plugins'] );
111	$found = array_search( 'advads_shortcode', $plugins, true );
112
113	if ( ! $found \|\| ( '' !== $editor_id && in_array( $editor_id, $this->editors, true ) ) ) {
114	return $mce_init;
115	}
116
117	unset( $plugins[ $found ] );
118	$mce_init['plugins'] = implode( ',', $plugins );
119
120	return $mce_init;
121	}
122
123	/**
124	* Print shortcode plugin inline.
125	*
126	* @param array\|null $mce_settings TinyMCE settings array.
127	*
128	* @return void
129	*/
130	public function print_shortcode_plugin( $mce_settings = [] ): void {
131	static $printed = null;
132
133	if ( null !== $printed ) {
134	return;
135	}
136
137	$printed = true;
138
139	// The `tinymce` argument of the `wp_editor()` function is set to `false`.
140	if ( empty( $mce_settings ) && ! ( doing_action( 'print_default_editor_scripts' ) && user_can_richedit() ) ) {
141	return;
142	}
143
144	if ( empty( $this->editors ) ) {
145	return;
146	}
147
148	?>
149	<script type="text/javascript">
150	<?php echo $this->get_l10n(); // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
151	<?php echo file_get_contents( ADVADS_ABSPATH . 'assets/js/admin/shortcode.js' ); // phpcs:ignore ?>
152	</script>
153	<?php
154	}
155
156	/**
157	* Prints html select field for shortcode creator
158	*
159	* @return void
160	*/
161	public function get_content_for_shortcode_creator(): void {
162	if ( ! ( current_user_can( 'edit_posts' ) \|\| current_user_can( 'edit_pages' ) ) ) {
163	return;
164	}
165
166	Data::items_dropdown( [ 'id' => 'advads-select-for-shortcode' ] );
167	exit();
168	}
169
170	/**
171	* Check if needed actions have not been removed by a plugin.
172	*
173	* @return array
174	*/
175	private function hooks_exist() {
176	if (
177	has_action( 'wp_tiny_mce_init', [ $this, 'print_shortcode_plugin' ] ) \|\|
178	has_action( 'print_default_editor_scripts', [ $this, 'print_shortcode_plugin' ] )
179	) {
180	return true;
181	}
182
183	return false;
184	}
185
186	/**
187	* Get localization strings.
188	*
189	* @return string
190	*/
191	private function get_l10n() {
192	$strings = [
193	'title' => esc_html_x( 'Add an ad', 'shortcode creator', 'advanced-ads' ),
194	'ok' => esc_html_x( 'Add shortcode', 'shortcode creator', 'advanced-ads' ),
195	'cancel' => esc_html_x( 'Cancel', 'shortcode creator', 'advanced-ads' ),
196	'image' => ADVADS_BASE_URL . 'assets/img/icons/tinymce-icon.png',
197	];
198	$locale = _WP_Editors::get_mce_locale();
199
200	return 'tinyMCE.addI18n("' . $locale . '.advads_shortcode", ' . wp_json_encode( $strings ) . ");\n";
201	}
202	}
203