Issues (377)

core/class-kirki-helper.php (4 issues)

Checks if used constants are declared or listed as dependencies.

Bug Major
1
<?php
2
/**
3
 * Helper methods
4
 *
5
 * @package     Kirki
6
 * @category    Core
7
 * @author      Aristeides Stathopoulos
8
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
9
 * @license    https://opensource.org/licenses/MIT
10
 * @since       1.0
11
 */
12
13
// Exit if accessed directly.
14
if ( ! defined( 'ABSPATH' ) ) {
15
	exit;
16
}
17
18
/**
19
 * A simple object containing static methods.
20
 */
21
class Kirki_Helper {
22
23
	/**
24
	 * Recursive replace in arrays.
25
	 *
26
	 * @static
27
	 * @access public
28
	 * @param array $array The first array.
29
	 * @param array $array1 The second array.
30
	 * @return mixed
31
	 */
32
	public static function array_replace_recursive( $array, $array1 ) {
33
		if ( function_exists( 'array_replace_recursive' ) ) {
34
			return array_replace_recursive( $array, $array1 );
35
		}
36
37
		// Handle the arguments, merge one by one.
38
		$args  = func_get_args();
39
		$array = $args[0];
40
		if ( ! is_array( $array ) ) {
41
			return $array;
42
		}
43
		$count = count( $args );
44
		for ( $i = 1; $i < $count; $i++ ) {
45
			if ( is_array( $args[ $i ] ) ) {
46
				$array = self::recurse( $array, $args[ $i ] );
47
			}
48
		}
49
		return $array;
50
	}
51
52
	/**
53
	 * Helper method to be used from the array_replace_recursive method.
54
	 *
55
	 * @static
56
	 * @access public
57
	 * @param array $array The first array.
58
	 * @param array $array1 The second array.
59
	 * @return array
60
	 */
61
	public static function recurse( $array, $array1 ) {
62
		foreach ( $array1 as $key => $value ) {
63
64
			// Create new key in $array, if it is empty or not an array.
65
			if ( ! isset( $array[ $key ] ) || ( isset( $array[ $key ] ) && ! is_array( $array[ $key ] ) ) ) {
66
				$array[ $key ] = array();
67
			}
68
69
			// Overwrite the value in the base array.
70
			if ( is_array( $value ) ) {
71
				$value = self::recurse( $array[ $key ], $value );
72
			}
73
			$array[ $key ] = $value;
74
		}
75
		return $array;
76
	}
77
78
	/**
79
	 * Initialize the WP_Filesystem
80
	 *
81
	 * @static
82
	 * @access public
83
	 * @return object WP_Filesystem
84
	 */
85
	public static function init_filesystem() {
86
		$credentials = array();
87
88
		if ( ! defined( 'FS_METHOD' ) ) {
89
			define( 'FS_METHOD', 'direct' );
90
		}
91
92
		$method = defined( 'FS_METHOD' ) ? FS_METHOD : false;
93
94
		if ( 'ftpext' === $method ) {
95
			// If defined, set it to that, Else, set to NULL.
96
			$credentials['hostname'] = defined( 'FTP_HOST' ) ? preg_replace( '|\w+://|', '', FTP_HOST ) : null;
0 ignored issues
show
The constant FTP_HOST was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
97
			$credentials['username'] = defined( 'FTP_USER' ) ? FTP_USER : null;
0 ignored issues
show
The constant FTP_USER was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
98
			$credentials['password'] = defined( 'FTP_PASS' ) ? FTP_PASS : null;
0 ignored issues
show
The constant FTP_PASS was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
99
100
			// Set FTP port.
101
			if ( strpos( $credentials['hostname'], ':' ) && null !== $credentials['hostname'] ) {
102
				list( $credentials['hostname'], $credentials['port'] ) = explode( ':', $credentials['hostname'], 2 );
103
				if ( ! is_numeric( $credentials['port'] ) ) {
104
					unset( $credentials['port'] );
105
				}
106
			} else {
107
				unset( $credentials['port'] );
108
			}
109
110
			// Set connection type.
111
			if ( ( defined( 'FTP_SSL' ) && FTP_SSL ) && 'ftpext' === $method ) {
0 ignored issues
show
The constant FTP_SSL was not found. Maybe you did not declare it correctly or list all dependencies?
Loading history...
112
				$credentials['connection_type'] = 'ftps';
113
			} elseif ( ! array_filter( $credentials ) ) {
114
				$credentials['connection_type'] = null;
115
			} else {
116
				$credentials['connection_type'] = 'ftp';
117
			}
118
		}
119
120
		// The WordPress filesystem.
121
		global $wp_filesystem;
122
123
		if ( empty( $wp_filesystem ) ) {
124
			require_once wp_normalize_path( ABSPATH . '/wp-admin/includes/file.php' );
125
			WP_Filesystem( $credentials );
126
		}
127
128
		return $wp_filesystem;
129
	}
130
131
	/**
132
	 * Returns the attachment object
133
	 *
134
	 * @static
135
	 * @access public
136
	 * @see https://pippinsplugins.com/retrieve-attachment-id-from-image-url/
137
	 * @param string $url URL to the image.
138
	 * @return int|string Numeric ID of the attachement.
139
	 */
140
	public static function get_image_id( $url ) {
141
		global $wpdb;
142
		if ( empty( $url ) ) {
143
			return 0;
144
		}
145
146
		$attachment = wp_cache_get( 'kirki_image_id_' . md5( $url ), null );
147
		if ( false === $attachment ) {
148
			$attachment = $wpdb->get_col( $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE guid = %s;", $url ) ); // phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery
149
			wp_cache_add( 'kirki_image_id_' . md5( $url ), $attachment, null );
150
		}
151
152
		if ( ! empty( $attachment ) ) {
153
			return $attachment[0];
154
		}
155
		return 0;
156
	}
157
158
	/**
159
	 * Returns an array of the attachment's properties.
160
	 *
161
	 * @param string $url URL to the image.
162
	 * @return array
163
	 */
164
	public static function get_image_from_url( $url ) {
165
		$image_id = self::get_image_id( $url );
166
		$image    = wp_get_attachment_image_src( $image_id, 'full' );
167
168
		return array(
169
			'url'       => $image[0],
170
			'width'     => $image[1],
171
			'height'    => $image[2],
172
			'thumbnail' => $image[3],
173
		);
174
	}
175
176
	/**
177
	 * Get an array of posts.
178
	 *
179
	 * @static
180
	 * @access public
181
	 * @param array $args Define arguments for the get_posts function.
182
	 * @return array
183
	 */
184
	public static function get_posts( $args ) {
185
		if ( is_string( $args ) ) {
186
			$args = add_query_arg(
187
				array(
188
					'suppress_filters' => false,
189
				)
190
			);
191
		} elseif ( is_array( $args ) && ! isset( $args['suppress_filters'] ) ) {
192
			$args['suppress_filters'] = false;
193
		}
194
195
		// Get the posts.
196
		// TODO: WordPress.VIP.RestrictedFunctions.get_posts_get_posts.
197
		$posts = get_posts( $args );
198
199
		// Properly format the array.
200
		$items = array();
201
		foreach ( $posts as $post ) {
202
			$items[ $post->ID ] = $post->post_title;
203
		}
204
		wp_reset_postdata();
205
206
		return $items;
207
	}
208
209
	/**
210
	 * Get an array of publicly-querable taxonomies.
211
	 *
212
	 * @static
213
	 * @access public
214
	 * @return array
215
	 */
216
	public static function get_taxonomies() {
217
		$items = array();
218
219
		// Get the taxonomies.
220
		$taxonomies = get_taxonomies(
221
			array(
222
				'public' => true,
223
			)
224
		);
225
226
		// Build the array.
227
		foreach ( $taxonomies as $taxonomy ) {
228
			$id           = $taxonomy;
229
			$taxonomy     = get_taxonomy( $taxonomy );
230
			$items[ $id ] = $taxonomy->labels->name;
231
		}
232
233
		return $items;
234
	}
235
236
	/**
237
	 * Get an array of publicly-querable post-types.
238
	 *
239
	 * @static
240
	 * @access public
241
	 * @return array
242
	 */
243
	public static function get_post_types() {
244
		$items = array();
245
246
		// Get the post types.
247
		$post_types = get_post_types(
248
			array(
249
				'public' => true,
250
			), 'objects'
251
		);
252
253
		// Build the array.
254
		foreach ( $post_types as $post_type ) {
255
			$items[ $post_type->name ] = $post_type->labels->name;
256
		}
257
258
		return $items;
259
	}
260
261
	/**
262
	 * Get an array of terms from a taxonomy
263
	 *
264
	 * @static
265
	 * @access public
266
	 * @param string|array $taxonomies See https://developer.wordpress.org/reference/functions/get_terms/ for details.
267
	 * @return array
268
	 */
269
	public static function get_terms( $taxonomies ) {
270
		$items = array();
271
272
		// Get the post types.
273
		$terms = get_terms( $taxonomies );
274
275
		// Build the array.
276
		foreach ( $terms as $term ) {
277
			$items[ $term->term_id ] = $term->name;
278
		}
279
280
		return $items;
281
	}
282
283
	/**
284
	 * Gets an array of material-design colors.
285
	 *
286
	 * @static
287
	 * @access public
288
	 * @param string $context Allows us to get subsets of the palette.
289
	 * @return array
290
	 */
291
	public static function get_material_design_colors( $context = 'primary' ) {
292
		$colors = array(
293
			'primary'     => array( '#FFFFFF', '#000000', '#F44336', '#E91E63', '#9C27B0', '#673AB7', '#3F51B5', '#2196F3', '#03A9F4', '#00BCD4', '#009688', '#4CAF50', '#8BC34A', '#CDDC39', '#FFEB3B', '#FFC107', '#FF9800', '#FF5722', '#795548', '#9E9E9E', '#607D8B' ),
294
			'red'         => array( '#FFEBEE', '#FFCDD2', '#EF9A9A', '#E57373', '#EF5350', '#F44336', '#E53935', '#D32F2F', '#C62828', '#B71C1C', '#FF8A80', '#FF5252', '#FF1744', '#D50000' ),
295
			'pink'        => array( '#FCE4EC', '#F8BBD0', '#F48FB1', '#F06292', '#EC407A', '#E91E63', '#D81B60', '#C2185B', '#AD1457', '#880E4F', '#FF80AB', '#FF4081', '#F50057', '#C51162' ),
296
			'purple'      => array( '#F3E5F5', '#E1BEE7', '#CE93D8', '#BA68C8', '#AB47BC', '#9C27B0', '#8E24AA', '#7B1FA2', '#6A1B9A', '#4A148C', '#EA80FC', '#E040FB', '#D500F9', '#AA00FF' ),
297
			'deep-purple' => array( '#EDE7F6', '#D1C4E9', '#B39DDB', '#9575CD', '#7E57C2', '#673AB7', '#5E35B1', '#512DA8', '#4527A0', '#311B92', '#B388FF', '#7C4DFF', '#651FFF', '#6200EA' ),
298
			'indigo'      => array( '#E8EAF6', '#C5CAE9', '#9FA8DA', '#7986CB', '#5C6BC0', '#3F51B5', '#3949AB', '#303F9F', '#283593', '#1A237E', '#8C9EFF', '#536DFE', '#3D5AFE', '#304FFE' ),
299
			'blue'        => array( '#E3F2FD', '#BBDEFB', '#90CAF9', '#64B5F6', '#42A5F5', '#2196F3', '#1E88E5', '#1976D2', '#1565C0', '#0D47A1', '#82B1FF', '#448AFF', '#2979FF', '#2962FF' ),
300
			'light-blue'  => array( '#E1F5FE', '#B3E5FC', '#81D4fA', '#4fC3F7', '#29B6FC', '#03A9F4', '#039BE5', '#0288D1', '#0277BD', '#01579B', '#80D8FF', '#40C4FF', '#00B0FF', '#0091EA' ),
301
			'cyan'        => array( '#E0F7FA', '#B2EBF2', '#80DEEA', '#4DD0E1', '#26C6DA', '#00BCD4', '#00ACC1', '#0097A7', '#00838F', '#006064', '#84FFFF', '#18FFFF', '#00E5FF', '#00B8D4' ),
302
			'teal'        => array( '#E0F2F1', '#B2DFDB', '#80CBC4', '#4DB6AC', '#26A69A', '#009688', '#00897B', '#00796B', '#00695C', '#004D40', '#A7FFEB', '#64FFDA', '#1DE9B6', '#00BFA5' ),
303
			'green'       => array( '#E8F5E9', '#C8E6C9', '#A5D6A7', '#81C784', '#66BB6A', '#4CAF50', '#43A047', '#388E3C', '#2E7D32', '#1B5E20', '#B9F6CA', '#69F0AE', '#00E676', '#00C853' ),
304
			'light-green' => array( '#F1F8E9', '#DCEDC8', '#C5E1A5', '#AED581', '#9CCC65', '#8BC34A', '#7CB342', '#689F38', '#558B2F', '#33691E', '#CCFF90', '#B2FF59', '#76FF03', '#64DD17' ),
305
			'lime'        => array( '#F9FBE7', '#F0F4C3', '#E6EE9C', '#DCE775', '#D4E157', '#CDDC39', '#C0CA33', '#A4B42B', '#9E9D24', '#827717', '#F4FF81', '#EEFF41', '#C6FF00', '#AEEA00' ),
306
			'yellow'      => array( '#FFFDE7', '#FFF9C4', '#FFF590', '#FFF176', '#FFEE58', '#FFEB3B', '#FDD835', '#FBC02D', '#F9A825', '#F57F17', '#FFFF82', '#FFFF00', '#FFEA00', '#FFD600' ),
307
			'amber'       => array( '#FFF8E1', '#FFECB3', '#FFE082', '#FFD54F', '#FFCA28', '#FFC107', '#FFB300', '#FFA000', '#FF8F00', '#FF6F00', '#FFE57F', '#FFD740', '#FFC400', '#FFAB00' ),
308
			'orange'      => array( '#FFF3E0', '#FFE0B2', '#FFCC80', '#FFB74D', '#FFA726', '#FF9800', '#FB8C00', '#F57C00', '#EF6C00', '#E65100', '#FFD180', '#FFAB40', '#FF9100', '#FF6D00' ),
309
			'deep-orange' => array( '#FBE9A7', '#FFCCBC', '#FFAB91', '#FF8A65', '#FF7043', '#FF5722', '#F4511E', '#E64A19', '#D84315', '#BF360C', '#FF9E80', '#FF6E40', '#FF3D00', '#DD2600' ),
310
			'brown'       => array( '#EFEBE9', '#D7CCC8', '#BCAAA4', '#A1887F', '#8D6E63', '#795548', '#6D4C41', '#5D4037', '#4E342E', '#3E2723' ),
311
			'grey'        => array( '#FAFAFA', '#F5F5F5', '#EEEEEE', '#E0E0E0', '#BDBDBD', '#9E9E9E', '#757575', '#616161', '#424242', '#212121', '#000000', '#ffffff' ),
312
			'blue-grey'   => array( '#ECEFF1', '#CFD8DC', '#B0BBC5', '#90A4AE', '#78909C', '#607D8B', '#546E7A', '#455A64', '#37474F', '#263238' ),
313
		);
314
315
		switch ( $context ) {
316
			case '50':
317
			case '100':
318
			case '200':
319
			case '300':
320
			case '400':
321
			case '500':
322
			case '600':
323
			case '700':
324
			case '800':
325
			case '900':
326
			case 'A100':
327
			case 'A200':
328
			case 'A400':
329
			case 'A700':
330
				$key = absint( $context ) / 100;
331
				if ( 'A100' === $context ) {
332
					$key = 10;
333
					unset( $colors['grey'] );
334
				} elseif ( 'A200' === $context ) {
335
					$key = 11;
336
					unset( $colors['grey'] );
337
				} elseif ( 'A400' === $context ) {
338
					$key = 12;
339
					unset( $colors['grey'] );
340
				} elseif ( 'A700' === $context ) {
341
					$key = 13;
342
					unset( $colors['grey'] );
343
				}
344
				unset( $colors['primary'] );
345
				$position_colors = array();
346
				foreach ( $colors as $color_family ) {
347
					if ( isset( $color_family[ $key ] ) ) {
348
						$position_colors[] = $color_family[ $key ];
349
					}
350
				}
351
				return $position_colors;
352
			case 'all':
353
				unset( $colors['primary'] );
354
				$all_colors = array();
355
				foreach ( $colors as $color_family ) {
356
					foreach ( $color_family as $color ) {
357
						$all_colors[] = $color;
358
					}
359
				}
360
				return $all_colors;
361
			case 'primary':
362
				return $colors['primary'];
363
			default:
364
				if ( isset( $colors[ $context ] ) ) {
365
					return $colors[ $context ];
366
				}
367
				return $colors['primary'];
368
		}
369
	}
370
371
	/**
372
	 * Get an array of all available dashicons.
373
	 *
374
	 * @static
375
	 * @access public
376
	 * @return array
377
	 */
378
	public static function get_dashicons() {
379
		return array(
380
			'admin-menu'     => array( 'menu', 'admin-site', 'dashboard', 'admin-post', 'admin-media', 'admin-links', 'admin-page', 'admin-comments', 'admin-appearance', 'admin-plugins', 'admin-users', 'admin-tools', 'admin-settings', 'admin-network', 'admin-home', 'admin-generic', 'admin-collapse', 'filter', 'admin-customizer', 'admin-multisite' ),
381
			'welcome-screen' => array( 'welcome-write-blog', 'welcome-add-page', 'welcome-view-site', 'welcome-widgets-menus', 'welcome-comments', 'welcome-learn-more' ),
382
			'post-formats'   => array( 'format-aside', 'format-image', 'format-gallery', 'format-video', 'format-status', 'format-quote', 'format-chat', 'format-audio', 'camera', 'images-alt', 'images-alt2', 'video-alt', 'video-alt2', 'video-alt3' ),
383
			'media'          => array( 'media-archive', 'media-audio', 'media-code', 'media-default', 'media-document', 'media-interactive', 'media-spreadsheet', 'media-text', 'media-video', 'playlist-audio', 'playlist-video', 'controls-play', 'controls-pause', 'controls-forward', 'controls-skipforward', 'controls-back', 'controls-skipback', 'controls-repeat', 'controls-volumeon', 'controls-volumeoff' ),
384
			'image-editing'  => array( 'image-crop', 'image-rotate', 'image-rotate-left', 'image-rotate-right', 'image-flip-vertical', 'image-flip-horizontal', 'image-filter', 'undo', 'redo' ),
385
			'tinymce'        => array( 'editor-bold', 'editor-italic', 'editor-ul', 'editor-ol', 'editor-quote', 'editor-alignleft', 'editor-aligncenter', 'editor-alignright', 'editor-insertmore', 'editor-spellcheck', 'editor-expand', 'editor-contract', 'editor-kitchensink', 'editor-underline', 'editor-justify', 'editor-textcolor', 'editor-paste-word', 'editor-paste-text', 'editor-removeformatting', 'editor-video', 'editor-customchar', 'editor-outdent', 'editor-indent', 'editor-help', 'editor-strikethrough', 'editor-unlink', 'editor-rtl', 'editor-break', 'editor-code', 'editor-paragraph', 'editor-table' ),
386
			'posts'          => array( 'align-left', 'align-right', 'align-center', 'align-none', 'lock', 'unlock', 'calendar', 'calendar-alt', 'visibility', 'hidden', 'post-status', 'edit', 'trash', 'sticky' ),
387
			'sorting'        => array( 'external', 'arrow-up', 'arrow-down', 'arrow-right', 'arrow-left', 'arrow-up-alt', 'arrow-down-alt', 'arrow-right-alt', 'arrow-left-alt', 'arrow-up-alt2', 'arrow-down-alt2', 'arrow-right-alt2', 'arrow-left-alt2', 'sort', 'leftright', 'randomize', 'list-view', 'exerpt-view', 'grid-view' ),
388
			'social'         => array( 'share', 'share-alt', 'share-alt2', 'twitter', 'rss', 'email', 'email-alt', 'facebook', 'facebook-alt', 'googleplus', 'networking' ),
389
			'wordpress_org'  => array( 'hammer', 'art', 'migrate', 'performance', 'universal-access', 'universal-access-alt', 'tickets', 'nametag', 'clipboard', 'heart', 'megaphone', 'schedule' ),
390
			'products'       => array( 'wordpress', 'wordpress-alt', 'pressthis', 'update', 'screenoptions', 'info', 'cart', 'feedback', 'cloud', 'translation' ),
391
			'taxonomies'     => array( 'tag', 'category' ),
392
			'widgets'        => array( 'archive', 'tagcloud', 'text' ),
393
			'notifications'  => array( 'yes', 'no', 'no-alt', 'plus', 'plus-alt', 'minus', 'dismiss', 'marker', 'star-filled', 'star-half', 'star-empty', 'flag', 'warning' ),
394
			'misc'           => array( 'location', 'location-alt', 'vault', 'shield', 'shield-alt', 'sos', 'search', 'slides', 'analytics', 'chart-pie', 'chart-bar', 'chart-line', 'chart-area', 'groups', 'businessman', 'id', 'id-alt', 'products', 'awards', 'forms', 'testimonial', 'portfolio', 'book', 'book-alt', 'download', 'upload', 'backup', 'clock', 'lightbulb', 'microphone', 'desktop', 'tablet', 'smartphone', 'phone', 'index-card', 'carrot', 'building', 'store', 'album', 'palmtree', 'tickets-alt', 'money', 'smiley', 'thumbs-up', 'thumbs-down', 'layout' ),
395
		);
396
	}
397
398
	/**
399
	 * Compares the 2 values given the condition
400
	 *
401
	 * @param mixed  $value1   The 1st value in the comparison.
402
	 * @param mixed  $value2   The 2nd value in the comparison.
403
	 * @param string $operator The operator we'll use for the comparison.
404
	 * @return boolean whether The comparison has succeded (true) or failed (false).
405
	 */
406
	public static function compare_values( $value1, $value2, $operator ) {
407
		if ( '===' === $operator ) {
408
			return $value1 === $value2;
409
		}
410
		if ( '!==' === $operator ) {
411
			return $value1 !== $value2;
412
		}
413
		if ( ( '!=' === $operator || 'not equal' === $operator ) ) {
414
			return $value1 != $value2; // WPCS: loose comparison ok.
415
		}
416
		if ( ( '>=' === $operator || 'greater or equal' === $operator || 'equal or greater' === $operator ) ) {
417
			return $value2 >= $value1;
418
		}
419
		if ( ( '<=' === $operator || 'smaller or equal' === $operator || 'equal or smaller' === $operator ) ) {
420
			return $value2 <= $value1;
421
		}
422
		if ( ( '>' === $operator || 'greater' === $operator ) ) {
423
			return $value2 > $value1;
424
		}
425
		if ( ( '<' === $operator || 'smaller' === $operator ) ) {
426
			return $value2 < $value1;
427
		}
428
		if ( 'contains' === $operator || 'in' === $operator ) {
429
			if ( is_array( $value1 ) && is_array( $value2 ) ) {
430
				foreach ( $value2 as $val ) {
431
					if ( in_array( $val, $value1 ) ) { // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
432
						return true;
433
					}
434
				}
435
				return false;
436
			}
437
			if ( is_array( $value1 ) && ! is_array( $value2 ) ) {
438
				return in_array( $value2, $value1 ); // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
439
			}
440
			if ( is_array( $value2 ) && ! is_array( $value1 ) ) {
441
				return in_array( $value1, $value2 ); // phpcs:ignore WordPress.PHP.StrictInArray.MissingTrueStrict
442
			}
443
			return ( false !== strrpos( $value1, $value2 ) || false !== strpos( $value2, $value1 ) );
444
		}
445
		return $value1 == $value2; // WPCS: loose comparison ok.
446
	}
447
}
448