Kirki_Init::add_fields() - 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-05 22:22 UTC

Kirki_Init::add_fields() A

↳ Parent: Kirki_Init

Complexity

Conditions	3
Paths	3

Size

Total Lines	19
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	19
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' ) );

		new Kirki_Custom_Build();
	}

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

aristath / kirki

Pull Request — master (#1451)

Kirki_Init::add_fields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like