Kirki_Init::get_variables() - Code Metrics - Inspection of "3.0.9" - aristath/kirki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1451)

by Aristeides

created 2017-07-08 09:33 UTC

Kirki_Init::get_variables() A

↳ Parent: Kirki_Init

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Initializes Kirki
 *
 * @package     Kirki
 * @category    Core
 * @author      Aristeides Stathopoulos
 * @copyright   Copyright (c) 2017, Aristeides Stathopoulos
 * @license     http://opensource.org/licenses/https://opensource.org/licenses/MIT
 * @since       1.0
 */

/**
 * Initialize Kirki
 */
class Kirki_Init {

	/**
	 * Control types.
	 *
	 * @access private
	 * @since 3.0.0
	 * @var array
	 */
	private $control_types = array();

	/**
	 * The class constructor.
	 */
	public function __construct() {

		$this->set_url();
		add_action( 'after_setup_theme', array( $this, 'set_url' ) );
		add_action( 'wp_loaded', array( $this, 'add_to_customizer' ), 1 );
		add_filter( 'kirki/control_types', array( $this, 'default_control_types' ) );
	}

	/**
	 * Properly set the Kirki URL for assets.
	 * Determines if Kirki is installed as a plugin, in a child theme, or a parent theme
	 * and then does some calculations to get the proper URL for its CSS & JS assets.
	 */
	public function set_url() {

		Kirki::$path = wp_normalize_path( dirname( KIRKI_PLUGIN_FILE ) );

		// Works in most cases.
		// Serves as a fallback in case all other checks fail.
		if ( defined( 'WP_CONTENT_DIR' ) ) {
			$content_dir = wp_normalize_path( WP_CONTENT_DIR );
			if ( false !== strpos( Kirki::$path, $content_dir ) ) {
				$relative_path = str_replace( $content_dir, '', Kirki::$path );
				Kirki::$url = content_url( $relative_path );
			}
		}

		// If Kirki is installed as a plugin, use that for the URL.
		if ( Kirki_Util::is_plugin() ) {
			Kirki::$url = plugin_dir_url( KIRKI_PLUGIN_FILE );
		}

		// Get the path to the theme.
		$theme_path = wp_normalize_path( get_template_directory() );

		// Is Kirki included in the theme?
		if ( false !== strpos( Kirki::$path, $theme_path ) ) {
			Kirki::$url = get_template_directory_uri() . str_replace( $theme_path, '', Kirki::$path );
		}

		// Is there a child-theme?
		$child_theme_path = wp_normalize_path( get_stylesheet_directory_uri() );
		if ( $child_theme_path !== $theme_path ) {
			// Is Kirki included in a child theme?
			if ( false !== strpos( Kirki::$path, $child_theme_path ) ) {
				Kirki::$url = get_template_directory_uri() . str_replace( $child_theme_path, '', Kirki::$path );
			}
		}

		// Apply the kirki/config filter.
		$config = apply_filters( 'kirki/config', array() );
		if ( isset( $config['url_path'] ) ) {
			Kirki::$url = $config['url_path'];
		}

		// Escapes the URL.
		Kirki::$url = esc_url_raw( Kirki::$url );
		// Make sure the right protocol is used.
		Kirki::$url = set_url_scheme( Kirki::$url );
	}

	/**
	 * Add the default Kirki control types.
	 *
	 * @access public
	 * @since 3.0.0
	 * @param array $control_types The control types array.
	 * @return array
	 */
	public function default_control_types( $control_types = array() ) {

		$this->control_types = array(
			'checkbox'              => 'WP_Customize_Control',
			'kirki-background'      => 'Kirki_Control_Background',
			'kirki-code'            => 'Kirki_Control_Code',
			'kirki-color'           => 'Kirki_Control_Color',
			'kirki-color-palette'   => 'Kirki_Control_Color_Palette',
			'kirki-custom'          => 'Kirki_Control_Custom',
			'kirki-date'            => 'Kirki_Control_Date',
			'kirki-dashicons'       => 'Kirki_Control_Dashicons',
			'kirki-dimension'       => 'Kirki_Control_Dimension',
			'kirki-dimensions'      => 'Kirki_Control_Dimensions',
			'kirki-editor'          => 'Kirki_Control_Editor',
			'kirki-fontawesome'     => 'Kirki_Control_FontAwesome',
			'kirki-gradient'        => 'Kirki_Control_Gradient',
			'kirki-image'           => 'Kirki_Control_Image',
			'kirki-multicolor'      => 'Kirki_Control_Multicolor',
			'kirki-multicheck'      => 'Kirki_Control_MultiCheck',
			'kirki-number'          => 'Kirki_Control_Number',
			'kirki-palette'         => 'Kirki_Control_Palette',
			'kirki-preset'          => 'Kirki_Control_Preset',
			'kirki-radio'           => 'Kirki_Control_Radio',
			'kirki-radio-buttonset' => 'Kirki_Control_Radio_ButtonSet',
			'kirki-radio-image'     => 'Kirki_Control_Radio_Image',
			'repeater'              => 'Kirki_Control_Repeater',
			'kirki-select'          => 'Kirki_Control_Select',
			'kirki-slider'          => 'Kirki_Control_Slider',
			'kirki-sortable'        => 'Kirki_Control_Sortable',
			'kirki-spacing'         => 'Kirki_Control_Dimensions',
			'kirki-switch'          => 'Kirki_Control_Switch',
			'kirki-generic'         => 'Kirki_Control_Generic',
			'kirki-toggle'          => 'Kirki_Control_Toggle',
			'kirki-typography'      => 'Kirki_Control_Typography',
			'image'                 => 'Kirki_Control_Image',
			'cropped_image'         => 'WP_Customize_Cropped_Image_Control',
			'upload'                => 'WP_Customize_Upload_Control',
		);
		return array_merge( $control_types, $this->control_types );

	}

	/**
	 * Helper function that adds the fields, sections and panels to the customizer.
	 *
	 * @return void
	 */
	public function add_to_customizer() {
		$this->fields_from_filters();
		add_action( 'customize_register', array( $this, 'register_control_types' ) );
		add_action( 'customize_register', array( $this, 'add_panels' ), 97 );
		add_action( 'customize_register', array( $this, 'add_sections' ), 98 );
		add_action( 'customize_register', array( $this, 'add_fields' ), 99 );
	}

	/**
	 * Register control types
	 *
	 * @return  void
	 */
	public function register_control_types() {
		global $wp_customize;

		$section_types = apply_filters( 'kirki/section_types', array() );
		foreach ( $section_types as $section_type ) {
			$wp_customize->register_section_type( $section_type );
		}
		if ( empty( $this->control_types ) ) {
			$this->control_types = $this->default_control_types();
		}
		$do_not_register_control_types = apply_filters( 'kirki/control_types/exclude', array(
			'Kirki_Control_Repeater',
		) );
		foreach ( $this->control_types as $control_type ) {
			if ( 0 === strpos( $control_type, 'Kirki' ) && ! in_array( $control_type, $do_not_register_control_types, true ) && class_exists( $control_type ) ) {
				$wp_customize->register_control_type( $control_type );
			}
		}
	}

	/**
	 * Register our panels to the WordPress Customizer.
	 *
	 * @access public
	 */
	public function add_panels() {
		if ( ! empty( Kirki::$panels ) ) {
			foreach ( Kirki::$panels as $panel_args ) {
				// Extra checks for nested panels.
				if ( isset( $panel_args['panel'] ) ) {
					if ( isset( Kirki::$panels[ $panel_args['panel'] ] ) ) {
						// Set the type to nested.
						$panel_args['type'] = 'kirki-nested';
					}
				}

				new Kirki_Panel( $panel_args );
			}
		}
	}

	/**
	 * Register our sections to the WordPress Customizer.
	 *
	 * @var	object	The WordPress Customizer object
	 * @return  void
	 */
	public function add_sections() {
		if ( ! empty( Kirki::$sections ) ) {
			foreach ( Kirki::$sections as $section_args ) {
				// Extra checks for nested sections.
				if ( isset( $section_args['section'] ) ) {
					if ( isset( Kirki::$sections[ $section_args['section'] ] ) ) {
						// Set the type to nested.
						$section_args['type'] = 'kirki-nested';
						// We need to check if the parent section is nested inside a panel.
						$parent_section = Kirki::$sections[ $section_args['section'] ];
						if ( isset( $parent_section['panel'] ) ) {
							$section_args['panel'] = $parent_section['panel'];
						}
					}
				}
				new Kirki_Section( $section_args );
			}
		}
	}

	/**
	 * Create the settings and controls from the $fields array and register them.
	 *
	 * @var	object	The WordPress Customizer object
	 * @return  void
	 */
	public function add_fields() {

		global $wp_customize;
		foreach ( Kirki::$fields as $args ) {

			// Create the settings.
			new Kirki_Settings( $args );

			// Check if we're on the customizer.
			// If we are, then we will create the controls, add the scripts needed for the customizer
			// and any other tweaks that this field may require.
			if ( $wp_customize ) {

				// Create the control.
				new Kirki_Control( $args );

			}
		}
	}

	/**
	 * Process fields added using the 'kirki/fields' and 'kirki/controls' filter.
	 * These filters are no longer used, this is simply for backwards-compatibility.
	 *
	 * @access private
	 * @since 2.0.0
	 */
	private function fields_from_filters() {

		$fields = apply_filters( 'kirki/controls', array() );
		$fields = apply_filters( 'kirki/fields', $fields );

		if ( ! empty( $fields ) ) {
			foreach ( $fields as $field ) {
				Kirki::add_field( 'global', $field );
			}
		}
	}

	/**
	 * Alias for the is_plugin static method in the Kirki_Util class.
	 * This is here for backwards-compatibility purposes.
	 *
	 * @static
	 * @access public
	 * @since 3.0.0
	 * @return bool
	 */
	public static function is_plugin() {
		// Log error for developers.
		// @codingStandardsIgnoreLine
		error_log( 'We detected you\'re using Kirki_Init::is_plugin(). Please use Kirki_Util::is_plugin() instead. This message was added in Kirki 3.0.9.' );
		// Return result using the Kirki_Util class.
		return Kirki_Util::is_plugin();
	}

	/**
	 * Alias for the get_variables static method in the Kirki_Util class.
	 * This is here for backwards-compatibility purposes.
	 *
	 * @static
	 * @access public
	 * @since 2.0.0
	 * @return array Formatted as array( 'variable-name' => value ).
	 */
	public static function get_variables() {
		// Log error for developers.
		// @codingStandardsIgnoreLine
		error_log( 'We detected you\'re using Kirki_Init::get_variables(). Please use Kirki_Util::get_variables() instead. This message was added in Kirki 3.0.9.' );
		// Return result using the Kirki_Util class.
		return Kirki_Util::get_variables();
	}

}


1			<?php
2			/**
3			* Initializes Kirki
4			*
5			* @package Kirki
6			* @category Core
7			* @author Aristeides Stathopoulos
8			* @copyright Copyright (c) 2017, Aristeides Stathopoulos
9			* @license http://opensource.org/licenses/https://opensource.org/licenses/MIT
10			* @since 1.0
11			*/
12
13			/**
14			* Initialize Kirki
15			*/
16			class Kirki_Init {
17
18			/**
19			* Control types.
20			*
21			* @access private
22			* @since 3.0.0
23			* @var array
24			*/
25			private $control_types = array();
26
27			/**
28			* The class constructor.
29			*/
30			public function __construct() {
31
32			$this->set_url();
33			add_action( 'after_setup_theme', array( $this, 'set_url' ) );
34			add_action( 'wp_loaded', array( $this, 'add_to_customizer' ), 1 );
35			add_filter( 'kirki/control_types', array( $this, 'default_control_types' ) );
36			}
37
38			/**
39			* Properly set the Kirki URL for assets.
40			* Determines if Kirki is installed as a plugin, in a child theme, or a parent theme
41			* and then does some calculations to get the proper URL for its CSS & JS assets.
42			*/
43			public function set_url() {
44
45			Kirki::$path = wp_normalize_path( dirname( KIRKI_PLUGIN_FILE ) );
46
47			// Works in most cases.
48			// Serves as a fallback in case all other checks fail.
49			if ( defined( 'WP_CONTENT_DIR' ) ) {
50			$content_dir = wp_normalize_path( WP_CONTENT_DIR );
51			if ( false !== strpos( Kirki::$path, $content_dir ) ) {
52			$relative_path = str_replace( $content_dir, '', Kirki::$path );
53			Kirki::$url = content_url( $relative_path );
54			}
55			}
56
57			// If Kirki is installed as a plugin, use that for the URL.
58			if ( Kirki_Util::is_plugin() ) {
59			Kirki::$url = plugin_dir_url( KIRKI_PLUGIN_FILE );
60			}
61
62			// Get the path to the theme.
63			$theme_path = wp_normalize_path( get_template_directory() );
64
65			// Is Kirki included in the theme?
66			if ( false !== strpos( Kirki::$path, $theme_path ) ) {
67			Kirki::$url = get_template_directory_uri() . str_replace( $theme_path, '', Kirki::$path );
68			}
69
70			// Is there a child-theme?
71			$child_theme_path = wp_normalize_path( get_stylesheet_directory_uri() );
72			if ( $child_theme_path !== $theme_path ) {
73			// Is Kirki included in a child theme?
74			if ( false !== strpos( Kirki::$path, $child_theme_path ) ) {
75			Kirki::$url = get_template_directory_uri() . str_replace( $child_theme_path, '', Kirki::$path );
76			}
77			}
78
79			// Apply the kirki/config filter.
80			$config = apply_filters( 'kirki/config', array() );
81			if ( isset( $config['url_path'] ) ) {
82			Kirki::$url = $config['url_path'];
83			}
84
85			// Escapes the URL.
86			Kirki::$url = esc_url_raw( Kirki::$url );
87			// Make sure the right protocol is used.
88			Kirki::$url = set_url_scheme( Kirki::$url );
89			}
90
91			/**
92			* Add the default Kirki control types.
93			*
94			* @access public
95			* @since 3.0.0
96			* @param array $control_types The control types array.
97			* @return array
98			*/
99			public function default_control_types( $control_types = array() ) {
100
101			$this->control_types = array(
102			'checkbox' => 'WP_Customize_Control',
103			'kirki-background' => 'Kirki_Control_Background',
104			'kirki-code' => 'Kirki_Control_Code',
105			'kirki-color' => 'Kirki_Control_Color',
106			'kirki-color-palette' => 'Kirki_Control_Color_Palette',
107			'kirki-custom' => 'Kirki_Control_Custom',
108			'kirki-date' => 'Kirki_Control_Date',
109			'kirki-dashicons' => 'Kirki_Control_Dashicons',
110			'kirki-dimension' => 'Kirki_Control_Dimension',
111			'kirki-dimensions' => 'Kirki_Control_Dimensions',
112			'kirki-editor' => 'Kirki_Control_Editor',
113			'kirki-fontawesome' => 'Kirki_Control_FontAwesome',
114			'kirki-gradient' => 'Kirki_Control_Gradient',
115			'kirki-image' => 'Kirki_Control_Image',
116			'kirki-multicolor' => 'Kirki_Control_Multicolor',
117			'kirki-multicheck' => 'Kirki_Control_MultiCheck',
118			'kirki-number' => 'Kirki_Control_Number',
119			'kirki-palette' => 'Kirki_Control_Palette',
120			'kirki-preset' => 'Kirki_Control_Preset',
121			'kirki-radio' => 'Kirki_Control_Radio',
122			'kirki-radio-buttonset' => 'Kirki_Control_Radio_ButtonSet',
123			'kirki-radio-image' => 'Kirki_Control_Radio_Image',
124			'repeater' => 'Kirki_Control_Repeater',
125			'kirki-select' => 'Kirki_Control_Select',
126			'kirki-slider' => 'Kirki_Control_Slider',
127			'kirki-sortable' => 'Kirki_Control_Sortable',
128			'kirki-spacing' => 'Kirki_Control_Dimensions',
129			'kirki-switch' => 'Kirki_Control_Switch',
130			'kirki-generic' => 'Kirki_Control_Generic',
131			'kirki-toggle' => 'Kirki_Control_Toggle',
132			'kirki-typography' => 'Kirki_Control_Typography',
133			'image' => 'Kirki_Control_Image',
134			'cropped_image' => 'WP_Customize_Cropped_Image_Control',
135			'upload' => 'WP_Customize_Upload_Control',
136			);
137			return array_merge( $control_types, $this->control_types );
138
139			}
140
141			/**
142			* Helper function that adds the fields, sections and panels to the customizer.
143			*
144			* @return void
145			*/
146			public function add_to_customizer() {
147			$this->fields_from_filters();
148			add_action( 'customize_register', array( $this, 'register_control_types' ) );
149			add_action( 'customize_register', array( $this, 'add_panels' ), 97 );
150			add_action( 'customize_register', array( $this, 'add_sections' ), 98 );
151			add_action( 'customize_register', array( $this, 'add_fields' ), 99 );
152			}
153
154			/**
155			* Register control types
156			*
157			* @return void
158			*/
159			public function register_control_types() {
160			global $wp_customize;
161
162			$section_types = apply_filters( 'kirki/section_types', array() );
163			foreach ( $section_types as $section_type ) {
164			$wp_customize->register_section_type( $section_type );
165			}
166			if ( empty( $this->control_types ) ) {
167			$this->control_types = $this->default_control_types();
168			}
169			$do_not_register_control_types = apply_filters( 'kirki/control_types/exclude', array(
170			'Kirki_Control_Repeater',
171			) );
172			foreach ( $this->control_types as $control_type ) {
173			if ( 0 === strpos( $control_type, 'Kirki' ) && ! in_array( $control_type, $do_not_register_control_types, true ) && class_exists( $control_type ) ) {
174			$wp_customize->register_control_type( $control_type );
175			}
176			}
177			}
178
179			/**
180			* Register our panels to the WordPress Customizer.
181			*
182			* @access public
183			*/
184			public function add_panels() {
185			if ( ! empty( Kirki::$panels ) ) {
186			foreach ( Kirki::$panels as $panel_args ) {
187			// Extra checks for nested panels.
188			if ( isset( $panel_args['panel'] ) ) {
189			if ( isset( Kirki::$panels[ $panel_args['panel'] ] ) ) {
190			// Set the type to nested.
191			$panel_args['type'] = 'kirki-nested';
192			}
193			}
194
195			new Kirki_Panel( $panel_args );
196			}
197			}
198			}
199
200			/**
201			* Register our sections to the WordPress Customizer.
202			*
203			* @var object The WordPress Customizer object
204			* @return void
205			*/
206			public function add_sections() {
207			if ( ! empty( Kirki::$sections ) ) {
208			foreach ( Kirki::$sections as $section_args ) {
209			// Extra checks for nested sections.
210			if ( isset( $section_args['section'] ) ) {
211			if ( isset( Kirki::$sections[ $section_args['section'] ] ) ) {
212			// Set the type to nested.
213			$section_args['type'] = 'kirki-nested';
214			// We need to check if the parent section is nested inside a panel.
215			$parent_section = Kirki::$sections[ $section_args['section'] ];
216			if ( isset( $parent_section['panel'] ) ) {
217			$section_args['panel'] = $parent_section['panel'];
218			}
219			}
220			}
221			new Kirki_Section( $section_args );
222			}
223			}
224			}
225
226			/**
227			* Create the settings and controls from the $fields array and register them.
228			*
229			* @var object The WordPress Customizer object
230			* @return void
231			*/
232			public function add_fields() {
233
234			global $wp_customize;
235			foreach ( Kirki::$fields as $args ) {
236
237			// Create the settings.
238			new Kirki_Settings( $args );
239
240			// Check if we're on the customizer.
241			// If we are, then we will create the controls, add the scripts needed for the customizer
242			// and any other tweaks that this field may require.
243			if ( $wp_customize ) {
244
245			// Create the control.
246			new Kirki_Control( $args );
247
248			}
249			}
250			}
251
252			/**
253			* Process fields added using the 'kirki/fields' and 'kirki/controls' filter.
254			* These filters are no longer used, this is simply for backwards-compatibility.
255			*
256			* @access private
257			* @since 2.0.0
258			*/
259			private function fields_from_filters() {
260
261			$fields = apply_filters( 'kirki/controls', array() );
262			$fields = apply_filters( 'kirki/fields', $fields );
263
264			if ( ! empty( $fields ) ) {
265			foreach ( $fields as $field ) {
266			Kirki::add_field( 'global', $field );
267			}
268			}
269			}
270
271			/**
272			* Alias for the is_plugin static method in the Kirki_Util class.
273			* This is here for backwards-compatibility purposes.
274			*
275			* @static
276			* @access public
277			* @since 3.0.0
278			* @return bool
279			*/
280			public static function is_plugin() {
281			// Log error for developers.
282			// @codingStandardsIgnoreLine
283			error_log( 'We detected you\'re using Kirki_Init::is_plugin(). Please use Kirki_Util::is_plugin() instead. This message was added in Kirki 3.0.9.' );
284			// Return result using the Kirki_Util class.
285			return Kirki_Util::is_plugin();
286			}
287
288			/**
289			* Alias for the get_variables static method in the Kirki_Util class.
290			* This is here for backwards-compatibility purposes.
291			*
292			* @static
293			* @access public
294			* @since 2.0.0
295			* @return array Formatted as array( 'variable-name' => value ).
296			*/
297			public static function get_variables() {
298			// Log error for developers.
299			// @codingStandardsIgnoreLine
300			error_log( 'We detected you\'re using Kirki_Init::get_variables(). Please use Kirki_Util::get_variables() instead. This message was added in Kirki 3.0.9.' );
301			// Return result using the Kirki_Util class.
302			return Kirki_Util::get_variables();
303			}
304
305			}
306

aristath / kirki

Pull Request — master (#1451)

Kirki_Init::get_variables() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like