Automattic /
jetpack
Complex classes like Jetpack_Widgets 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 Jetpack_Widgets, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 13 | class Jetpack_Widgets { |
||
| 14 | |||
| 15 | /** |
||
| 16 | * Returns the `sidebars_widgets` option with the `array_version` element removed. |
||
| 17 | * |
||
| 18 | * @return array The current value of sidebars_widgets |
||
| 19 | */ |
||
| 20 | public static function get_sidebars_widgets() { |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Format widget data for output and for use by other widget functions. |
||
| 30 | * |
||
| 31 | * The output looks like: |
||
| 32 | * |
||
| 33 | * array( |
||
| 34 | * 'id' => 'text-3', |
||
| 35 | * 'sidebar' => 'sidebar-1', |
||
| 36 | * 'position' => '0', |
||
| 37 | * 'settings' => array( |
||
| 38 | * 'title' => 'hello world' |
||
| 39 | * ) |
||
| 40 | * ) |
||
| 41 | * |
||
| 42 | * |
||
| 43 | * @param string|integer $position The position of the widget in its sidebar. |
||
| 44 | * @param string $widget_id The widget's id (eg: 'text-3'). |
||
| 45 | * @param string $sidebar The widget's sidebar id (eg: 'sidebar-1'). |
||
| 46 | * @param array (Optional) $settings The settings for the widget. |
||
| 47 | * |
||
| 48 | * @return array A normalized array representing this widget. |
||
| 49 | */ |
||
| 50 | public static function format_widget( $position, $widget_id, $sidebar, $settings = null ) { |
||
| 66 | |||
| 67 | /** |
||
| 68 | * Return a widget's id_base from its id. |
||
| 69 | * |
||
| 70 | * @param string $widget_id The id of a widget. (eg: 'text-3') |
||
| 71 | * |
||
| 72 | * @return string The id_base of a widget (eg: 'text'). |
||
| 73 | */ |
||
| 74 | public static function get_widget_id_base( $widget_id ) { |
||
| 78 | |||
| 79 | /** |
||
| 80 | * Determine a widget's option name (the WP option where the widget's settings |
||
| 81 | * are stored - generally `widget_` + the widget's id_base). |
||
| 82 | * |
||
| 83 | * @param string $widget_id The id of a widget. (eg: 'text-3') |
||
| 84 | * |
||
| 85 | * @return string The option name of the widget's settings. (eg: 'widget_text') |
||
| 86 | */ |
||
| 87 | public static function get_widget_option_name( $widget_id ) { |
||
| 90 | |||
| 91 | /** |
||
| 92 | * Determine a widget instance key from its ID. (eg: 'text-3' becomes '3'). |
||
| 93 | * Used to access the widget's settings. |
||
| 94 | * |
||
| 95 | * @param string $widget_id The id of a widget. |
||
| 96 | * |
||
| 97 | * @return integer The instance key of that widget. |
||
| 98 | */ |
||
| 99 | public static function get_widget_instance_key( $widget_id ) { |
||
| 105 | |||
| 106 | /** |
||
| 107 | * Return a widget by ID (formatted for output) or null if nothing is found. |
||
| 108 | * |
||
| 109 | * @param string $widget_id The id of a widget to look for. |
||
| 110 | * |
||
| 111 | * @return array|null The matching formatted widget (see format_widget). |
||
| 112 | */ |
||
| 113 | public static function get_widget_by_id( $widget_id ) { |
||
| 122 | |||
| 123 | /** |
||
| 124 | * Return an array of all widgets (active and inactive) formatted for output. |
||
| 125 | * |
||
| 126 | * @return array An array of all widgets (see format_widget). |
||
| 127 | */ |
||
| 128 | public static function get_all_widgets() { |
||
| 143 | |||
| 144 | /** |
||
| 145 | * Return an array of all active widgets formatted for output. |
||
| 146 | * |
||
| 147 | * @return array An array of all active widgets (see format_widget). |
||
| 148 | */ |
||
| 149 | public static function get_active_widgets() { |
||
| 160 | |||
| 161 | /** |
||
| 162 | * Return an array of all widget IDs (active and inactive) |
||
| 163 | * |
||
| 164 | * @return array An array of all widget IDs. |
||
| 165 | */ |
||
| 166 | public static function get_all_widget_ids() { |
||
| 179 | |||
| 180 | /** |
||
| 181 | * Return an array of widgets with a specific id_base (eg: `text`). |
||
| 182 | * |
||
| 183 | * @param string $id_base The id_base of a widget type. |
||
| 184 | * |
||
| 185 | * @return array All the formatted widgets matching that widget type (see format_widget). |
||
| 186 | */ |
||
| 187 | public static function get_widgets_with_id_base( $id_base ) { |
||
| 196 | |||
| 197 | /** |
||
| 198 | * Return the array of widget IDs in a sidebar or null if that sidebar does |
||
| 199 | * not exist. Will return an empty array for an existing empty sidebar. |
||
| 200 | * |
||
| 201 | * @param string $sidebar The id of a sidebar. |
||
| 202 | * |
||
| 203 | * @return array|null The array of widget IDs in the sidebar. |
||
| 204 | */ |
||
| 205 | public static function get_widgets_in_sidebar( $sidebar ) { |
||
| 217 | |||
| 218 | /** |
||
| 219 | * Return an associative array of all registered sidebars for this theme, |
||
| 220 | * active and inactive, including the hidden disabled widgets sidebar (keyed |
||
| 221 | * by `wp_inactive_widgets`). Each sidebar is keyed by the ID of the sidebar |
||
| 222 | * and its value is an array of widget IDs for that sidebar. |
||
| 223 | * |
||
| 224 | * @return array An associative array of all sidebars and their widget IDs. |
||
| 225 | */ |
||
| 226 | public static function get_all_sidebars() { |
||
| 234 | |||
| 235 | /** |
||
| 236 | * Return an associative array of all active sidebars for this theme, Each |
||
| 237 | * sidebar is keyed by the ID of the sidebar and its value is an array of |
||
| 238 | * widget IDs for that sidebar. |
||
| 239 | * |
||
| 240 | * @return array An associative array of all active sidebars and their widget IDs. |
||
| 241 | */ |
||
| 242 | public static function get_active_sidebars() { |
||
| 252 | |||
| 253 | /** |
||
| 254 | * Activates a widget in a sidebar. Does not validate that the sidebar exists, |
||
| 255 | * so please do that first. Also does not save the widget's settings. Please |
||
| 256 | * do that with `set_widget_settings`. |
||
| 257 | * |
||
| 258 | * If position is not set, it will be set to the next available position. |
||
| 259 | * |
||
| 260 | * @param string $widget_id The newly-formed id of the widget to be added. |
||
| 261 | * @param string $sidebar The id of the sidebar where the widget will be added. |
||
| 262 | * @param string|integer $position (Optional) The position within the sidebar where the widget will be added. |
||
| 263 | * |
||
| 264 | * @return bool |
||
| 265 | */ |
||
| 266 | public static function add_widget_to_sidebar( $widget_id, $sidebar, $position ) { |
||
| 269 | |||
| 270 | /** |
||
| 271 | * Removes a widget from a sidebar. Does not validate that the sidebar exists |
||
| 272 | * or remove any settings from the widget, so please do that separately. |
||
| 273 | * |
||
| 274 | * @param array $widget The widget to be removed. |
||
| 275 | */ |
||
| 276 | public static function remove_widget_from_sidebar( $widget ) { |
||
| 283 | |||
| 284 | /** |
||
| 285 | * Moves a widget to a sidebar. Does not validate that the sidebar exists, |
||
| 286 | * so please do that first. Also does not save the widget's settings. Please |
||
| 287 | * do that with `set_widget_settings`. The first argument should be a |
||
| 288 | * widget as returned by `format_widget` including `id`, `sidebar`, and |
||
| 289 | * `position`. |
||
| 290 | * |
||
| 291 | * If $position is not set, it will be set to the next available position. |
||
| 292 | * |
||
| 293 | * Can be used to add a new widget to a sidebar if |
||
| 294 | * $widget['sidebar'] === NULL |
||
| 295 | * |
||
| 296 | * Can be used to move a widget within a sidebar as well if |
||
| 297 | * $widget['sidebar'] === $sidebar. |
||
| 298 | * |
||
| 299 | * @param array $widget The widget to be moved (see format_widget). |
||
| 300 | * @param string $sidebar The sidebar where this widget will be moved. |
||
| 301 | * @param string|integer $position (Optional) The position where this widget will be moved in the sidebar. |
||
| 302 | * |
||
| 303 | * @return bool |
||
| 304 | */ |
||
| 305 | public static function move_widget_to_sidebar( $widget, $sidebar, $position ) { |
||
| 338 | |||
| 339 | /** |
||
| 340 | * Return an integer containing the largest position number in a sidebar or |
||
| 341 | * null if there are no widgets in that sidebar. |
||
| 342 | * |
||
| 343 | * @param string $sidebar The id of a sidebar. |
||
| 344 | * |
||
| 345 | * @return integer|null The last index position of a widget in that sidebar. |
||
| 346 | */ |
||
| 347 | public static function get_last_position_in_sidebar( $sidebar ) { |
||
| 361 | |||
| 362 | /** |
||
| 363 | * Saves settings for a widget. Does not add that widget to a sidebar. Please |
||
| 364 | * do that with `move_widget_to_sidebar` first. Will merge the settings of |
||
| 365 | * any existing widget with the same `$widget_id`. |
||
| 366 | * |
||
| 367 | * @param string $widget_id The id of a widget. |
||
| 368 | * @param array $settings An associative array of settings to merge with any existing settings on this widget. |
||
| 369 | * |
||
| 370 | * @return boolean|WP_Error True if update was successful. |
||
| 371 | */ |
||
| 372 | public static function set_widget_settings( $widget_id, $settings ) { |
||
| 390 | |||
| 391 | /** |
||
| 392 | * Sanitize an associative array for saving. |
||
| 393 | * |
||
| 394 | * @param string $widget_id The id of a widget. |
||
| 395 | * @param array $settings A widget settings array. |
||
| 396 | * @param array $old_settings The existing widget settings array. |
||
| 397 | * |
||
| 398 | * @return array|false The settings array sanitized by `WP_Widget::update` or false if sanitization failed. |
||
| 399 | */ |
||
| 400 | private static function sanitize_widget_settings( $widget_id, $settings, $old_settings ) { |
||
| 410 | |||
| 411 | /** |
||
| 412 | * Deletes settings for a widget. Does not remove that widget to a sidebar. Please |
||
| 413 | * do that with `remove_widget_from_sidebar` first. |
||
| 414 | * |
||
| 415 | * @param array $widget The widget which will have its settings removed (see format_widget). |
||
| 416 | */ |
||
| 417 | public static function remove_widget_settings( $widget ) { |
||
| 423 | |||
| 424 | /** |
||
| 425 | * Update a widget's settings, sidebar, and position. Returns the (updated) |
||
| 426 | * formatted widget if successful or a WP_Error if it fails. |
||
| 427 | * |
||
| 428 | * @param string $widget_id The id of a widget to update. |
||
| 429 | * @param string $sidebar (Optional) A sidebar to which this widget will be moved. |
||
| 430 | * @param string|integer (Optional) A new position to which this widget will be moved within its new or existing sidebar. |
||
| 431 | * @param array|object|string $settings Settings to merge with the existing settings of the widget (will be passed through `decode_settings`). |
||
| 432 | * |
||
| 433 | * @return array|WP_Error The newly added widget as an associative array with all the above properties. |
||
| 434 | */ |
||
| 435 | public static function update_widget( $widget_id, $sidebar, $position, $settings ) { |
||
| 468 | |||
| 469 | /** |
||
| 470 | * Deletes a widget entirely including all its settings. Returns a WP_Error if |
||
| 471 | * the widget could not be found. Otherwise returns an empty array. |
||
| 472 | * |
||
| 473 | * @param string $widget_id The id of a widget to delete. (eg: 'text-2') |
||
| 474 | * |
||
| 475 | * @return array|WP_Error An empty array if successful. |
||
| 476 | */ |
||
| 477 | public static function delete_widget( $widget_id ) { |
||
| 486 | |||
| 487 | /** |
||
| 488 | * Return an array of settings. The input can be either an object, a JSON |
||
| 489 | * string, or an array. |
||
| 490 | * |
||
| 491 | * @param array|string|object $settings The settings of a widget as passed into the API. |
||
| 492 | * |
||
| 493 | * @return array Decoded associative array of settings. |
||
| 494 | */ |
||
| 495 | public static function decode_settings( $settings ) { |
||
| 509 | |||
| 510 | /** |
||
| 511 | * Activate a new widget. |
||
| 512 | * |
||
| 513 | * @param string $id_base The id_base of the new widget (eg: 'text') |
||
| 514 | * @param string $sidebar The id of the sidebar where this widget will go. Dependent on theme. (eg: 'sidebar-1') |
||
| 515 | * @param string|integer $position (Optional) The position of the widget in the sidebar. Defaults to the last position. |
||
| 516 | * @param array|object|string $settings (Optional) An associative array of settings for this widget (will be passed through `decode_settings`). Varies by widget. |
||
| 517 | * |
||
| 518 | * @return array|WP_Error The newly added widget as an associative array with all the above properties except 'id_base' replaced with the generated 'id'. |
||
| 519 | */ |
||
| 520 | public static function activate_widget( $id_base, $sidebar, $position, $settings ) { |
||
| 569 | |||
| 570 | /** |
||
| 571 | * Activate an array of new widgets. Like calling `activate_widget` multiple times. |
||
| 572 | * |
||
| 573 | * @param array $widgets An array of widget arrays. Each sub-array must be of the format required by `activate_widget`. |
||
| 574 | * |
||
| 575 | * @return array|WP_Error The newly added widgets in the form returned by `get_all_widgets`. |
||
| 576 | */ |
||
| 577 | public static function activate_widgets( $widgets ) { |
||
| 590 | |||
| 591 | /** |
||
| 592 | * Return the last instance key (integer) of an existing widget matching |
||
| 593 | * `$id_base`. So if you pass in `text`, and there is a widget with the id |
||
| 594 | * `text-2`, this function will return `2`. |
||
| 595 | * |
||
| 596 | * @param string $id_base The id_base of a type of widget. (eg: 'rss') |
||
| 597 | * |
||
| 598 | * @return integer The last instance key of that type of widget. |
||
| 599 | */ |
||
| 600 | public static function get_last_widget_instance_key_with_id_base( $id_base ) { |
||
| 615 | |||
| 616 | /** |
||
| 617 | * Method used to sort widgets |
||
| 618 | * |
||
| 619 | * @since 5.4 |
||
| 620 | * |
||
| 621 | * @param array $a |
||
| 622 | * @param array $b |
||
| 623 | * |
||
| 624 | * @return int |
||
| 625 | */ |
||
| 626 | public static function sort_widgets( $a, $b ) { |
||
| 637 | |||
| 638 | /** |
||
| 639 | * Retrieve a given widget object instance by ID base (eg. 'text' or 'archives'). |
||
| 640 | * |
||
| 641 | * @param string $id_base The id_base of a type of widget. |
||
| 642 | * |
||
| 643 | * @return WP_Widget|false The found widget object or false if the id_base was not found. |
||
| 644 | */ |
||
| 645 | public static function get_registered_widget_object( $id_base ) { |
||
| 668 | |||
| 669 | /** |
||
| 670 | * Validate a given widget ID base (eg. 'text' or 'archives'). |
||
| 671 | * |
||
| 672 | * @param string $id_base The id_base of a type of widget. |
||
| 673 | * |
||
| 674 | * @return boolean True if the widget is of a known type. |
||
| 675 | */ |
||
| 676 | public static function validate_id_base( $id_base ) { |
||
| 679 | } |
||
| 680 |
This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent.
Consider making the comparison explicit by using
empty(..)or! empty(...)instead.