Complex classes like Kirki_Init often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Kirki_Init, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 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 | $this->set_url(); |
||
| 32 | add_action( 'after_setup_theme', array( $this, 'set_url' ) ); |
||
| 33 | add_action( 'wp_loaded', array( $this, 'add_to_customizer' ), 1 ); |
||
| 34 | add_filter( 'kirki/control_types', array( $this, 'default_control_types' ) ); |
||
| 35 | add_action( 'after_setup_theme', array( $this, 'acf_pro_compatibility' ) ); |
||
| 36 | |||
| 37 | new Kirki_Custom_Build(); |
||
| 38 | |||
| 39 | add_filter( 'http_request_args', array( $this, 'http_request' ), 10, 2 ); |
||
| 40 | add_filter( 'option_active_plugins', array( $this, 'is_plugin_active' ) ); |
||
| 41 | } |
||
| 42 | |||
| 43 | /** |
||
| 44 | * Properly set the Kirki URL for assets. |
||
| 45 | * Determines if Kirki is installed as a plugin, in a child theme, or a parent theme |
||
| 46 | * and then does some calculations to get the proper URL for its CSS & JS assets. |
||
| 47 | */ |
||
| 48 | public function set_url() { |
||
| 49 | |||
| 50 | Kirki::$path = wp_normalize_path( dirname( KIRKI_PLUGIN_FILE ) ); |
||
| 51 | |||
| 52 | // Works in most cases. |
||
| 53 | // Serves as a fallback in case all other checks fail. |
||
| 54 | if ( defined( 'WP_CONTENT_DIR' ) ) { |
||
| 55 | $content_dir = wp_normalize_path( WP_CONTENT_DIR ); |
||
| 56 | if ( false !== strpos( Kirki::$path, $content_dir ) ) { |
||
| 57 | $relative_path = str_replace( $content_dir, '', Kirki::$path ); |
||
| 58 | Kirki::$url = content_url( $relative_path ); |
||
| 59 | } |
||
| 60 | } |
||
| 61 | |||
| 62 | // If Kirki is installed as a plugin, use that for the URL. |
||
| 63 | if ( self::is_plugin() ) { |
||
| 64 | Kirki::$url = plugin_dir_url( KIRKI_PLUGIN_FILE ); |
||
| 65 | } |
||
| 66 | |||
| 67 | // Get the path to the theme. |
||
| 68 | $theme_path = wp_normalize_path( get_template_directory() ); |
||
| 69 | |||
| 70 | // Is Kirki included in the theme? |
||
| 71 | if ( false !== strpos( Kirki::$path, $theme_path ) ) { |
||
| 72 | Kirki::$url = get_template_directory_uri() . str_replace( $theme_path, '', Kirki::$path ); |
||
| 73 | } |
||
| 74 | |||
| 75 | // Is there a child-theme? |
||
| 76 | $child_theme_path = wp_normalize_path( get_stylesheet_directory_uri() ); |
||
| 77 | if ( $child_theme_path !== $theme_path ) { |
||
| 78 | // Is Kirki included in a child theme? |
||
| 79 | if ( false !== strpos( Kirki::$path, $child_theme_path ) ) { |
||
| 80 | Kirki::$url = get_template_directory_uri() . str_replace( $child_theme_path, '', Kirki::$path ); |
||
| 81 | } |
||
| 82 | } |
||
| 83 | |||
| 84 | // Apply the kirki/config filter. |
||
| 85 | $config = apply_filters( 'kirki/config', array() ); |
||
| 86 | if ( isset( $config['url_path'] ) ) { |
||
| 87 | Kirki::$url = $config['url_path']; |
||
| 88 | } |
||
| 89 | |||
| 90 | // Escapes the URL. |
||
| 91 | Kirki::$url = esc_url_raw( Kirki::$url ); |
||
| 92 | // Make sure the right protocol is used. |
||
| 93 | Kirki::$url = set_url_scheme( Kirki::$url ); |
||
| 94 | } |
||
| 95 | |||
| 96 | /** |
||
| 97 | * Add the default Kirki control types. |
||
| 98 | * |
||
| 99 | * @access public |
||
| 100 | * @since 3.0.0 |
||
| 101 | * @param array $control_types The control types array. |
||
| 102 | * @return array |
||
| 103 | */ |
||
| 104 | public function default_control_types( $control_types = array() ) { |
||
| 105 | |||
| 106 | $this->control_types = array( |
||
| 107 | 'checkbox' => 'WP_Customize_Control', |
||
| 108 | 'kirki-background' => 'Kirki_Control_Background', |
||
| 109 | 'kirki-code' => 'Kirki_Control_Code', |
||
| 110 | 'kirki-color' => 'Kirki_Control_Color', |
||
| 111 | 'kirki-color-palette' => 'Kirki_Control_Color_Palette', |
||
| 112 | 'kirki-custom' => 'Kirki_Control_Custom', |
||
| 113 | 'kirki-date' => 'Kirki_Control_Date', |
||
| 114 | 'kirki-dashicons' => 'Kirki_Control_Dashicons', |
||
| 115 | 'kirki-dimension' => 'Kirki_Control_Dimension', |
||
| 116 | 'kirki-dimensions' => 'Kirki_Control_Dimensions', |
||
| 117 | 'kirki-editor' => 'Kirki_Control_Editor', |
||
| 118 | 'kirki-fontawesome' => 'Kirki_Control_FontAwesome', |
||
| 119 | 'kirki-gradient' => 'Kirki_Control_Gradient', |
||
| 120 | 'kirki-image' => 'Kirki_Control_Image', |
||
| 121 | 'kirki-multicolor' => 'Kirki_Control_Multicolor', |
||
| 122 | 'kirki-multicheck' => 'Kirki_Control_MultiCheck', |
||
| 123 | 'kirki-number' => 'Kirki_Control_Number', |
||
| 124 | 'kirki-palette' => 'Kirki_Control_Palette', |
||
| 125 | 'kirki-preset' => 'Kirki_Control_Preset', |
||
| 126 | 'kirki-radio' => 'Kirki_Control_Radio', |
||
| 127 | 'kirki-radio-buttonset' => 'Kirki_Control_Radio_ButtonSet', |
||
| 128 | 'kirki-radio-image' => 'Kirki_Control_Radio_Image', |
||
| 129 | 'repeater' => 'Kirki_Control_Repeater', |
||
| 130 | 'kirki-select' => 'Kirki_Control_Select', |
||
| 131 | 'kirki-slider' => 'Kirki_Control_Slider', |
||
| 132 | 'kirki-sortable' => 'Kirki_Control_Sortable', |
||
| 133 | 'kirki-spacing' => 'Kirki_Control_Dimensions', |
||
| 134 | 'kirki-switch' => 'Kirki_Control_Switch', |
||
| 135 | 'kirki-generic' => 'Kirki_Control_Generic', |
||
| 136 | 'kirki-toggle' => 'Kirki_Control_Toggle', |
||
| 137 | 'kirki-typography' => 'Kirki_Control_Typography', |
||
| 138 | 'image' => 'Kirki_Control_Image', |
||
| 139 | 'cropped_image' => 'WP_Customize_Cropped_Image_Control', |
||
| 140 | 'upload' => 'WP_Customize_Upload_Control', |
||
| 141 | ); |
||
| 142 | return array_merge( $control_types, $this->control_types ); |
||
| 143 | |||
| 144 | } |
||
| 145 | |||
| 146 | /** |
||
| 147 | * Helper function that adds the fields, sections and panels to the customizer. |
||
| 148 | * |
||
| 149 | * @return void |
||
| 150 | */ |
||
| 151 | public function add_to_customizer() { |
||
| 152 | $this->fields_from_filters(); |
||
| 153 | add_action( 'customize_register', array( $this, 'register_control_types' ) ); |
||
| 154 | add_action( 'customize_register', array( $this, 'add_panels' ), 97 ); |
||
| 155 | add_action( 'customize_register', array( $this, 'add_sections' ), 98 ); |
||
| 156 | add_action( 'customize_register', array( $this, 'add_fields' ), 99 ); |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * Register control types |
||
| 161 | * |
||
| 162 | * @return void |
||
| 163 | */ |
||
| 164 | public function register_control_types() { |
||
| 183 | |||
| 184 | /** |
||
| 185 | * Register our panels to the WordPress Customizer. |
||
| 186 | * |
||
| 187 | * @access public |
||
| 188 | */ |
||
| 189 | public function add_panels() { |
||
| 204 | |||
| 205 | /** |
||
| 206 | * Register our sections to the WordPress Customizer. |
||
| 207 | * |
||
| 208 | * @var object The WordPress Customizer object |
||
| 209 | * @return void |
||
| 210 | */ |
||
| 211 | public function add_sections() { |
||
| 230 | |||
| 231 | /** |
||
| 232 | * Create the settings and controls from the $fields array and register them. |
||
| 233 | * |
||
| 234 | * @var object The WordPress Customizer object |
||
| 235 | * @return void |
||
| 236 | */ |
||
| 237 | public function add_fields() { |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Build the variables. |
||
| 259 | * |
||
| 260 | * @return array ('variable-name' => value) |
||
| 261 | */ |
||
| 262 | public static function get_variables() { |
||
| 301 | |||
| 302 | /** |
||
| 303 | * Process fields added using the 'kirki/fields' and 'kirki/controls' filter. |
||
| 304 | * These filters are no longer used, this is simply for backwards-compatibility. |
||
| 305 | * |
||
| 306 | * @access private |
||
| 307 | * @since 2.0.0 |
||
| 308 | */ |
||
| 309 | private function fields_from_filters() { |
||
| 320 | |||
| 321 | /** |
||
| 322 | * Changes select2 version in ACF. |
||
| 323 | * Fixes a plugin conflict that was causing select fields to crash |
||
| 324 | * because of a version mismatch between ACF's and Kirki's select2 scripts. |
||
| 325 | * Props @hellor0bot |
||
| 326 | * |
||
| 327 | * @see https://github.com/aristath/kirki/issues/1302 |
||
| 328 | * @access public |
||
| 329 | * @since 3.0.0 |
||
| 330 | */ |
||
| 331 | public function acf_pro_compatibility() { |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Determine if Kirki is installed as a plugin. |
||
| 339 | * |
||
| 340 | * @static |
||
| 341 | * @access public |
||
| 342 | * @since 3.0.0 |
||
| 343 | * @return bool |
||
| 344 | */ |
||
| 345 | public static function is_plugin() { |
||
| 378 | |||
| 379 | /** |
||
| 380 | * HTTP Request injection. |
||
| 381 | * |
||
| 382 | * @access public |
||
| 383 | * @since 3.0.0 |
||
| 384 | * @param array $r The request params. |
||
| 385 | * @param string $url The request URL. |
||
| 386 | * @return array |
||
| 387 | */ |
||
| 388 | public function http_request( $r = array(), $url = '' ) { |
||
| 418 | |||
| 419 | /** |
||
| 420 | * Plugin is active. |
||
| 421 | * |
||
| 422 | * @since 3.0.0 |
||
| 423 | * @access public |
||
| 424 | * @param array $plugins An array of active plugins. |
||
| 425 | * @return array Active plugins. |
||
| 426 | */ |
||
| 427 | public function is_plugin_active( $plugins ) { |
||
| 453 | } |
||
| 454 |
Short variable names may make your code harder to understand. Variable names should be self-descriptive. This check looks for variable names who are shorter than a configured minimum.