<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Widget API: WP_Widget_Factory class

[2] Fix | Delete

*

[3] Fix | Delete

* @package WordPress

[4] Fix | Delete

* @subpackage Widgets

[5] Fix | Delete

* @since 4.4.0

[6] Fix | Delete

*/

[7] Fix | Delete

[8] Fix | Delete

/**

[9] Fix | Delete

* Singleton that registers and instantiates WP_Widget classes.

[10] Fix | Delete

*

[11] Fix | Delete

* @since 2.8.0

[12] Fix | Delete

* @since 4.4.0 Moved to its own file from wp-includes/widgets.php

[13] Fix | Delete

*/

[14] Fix | Delete

#[AllowDynamicProperties]

[15] Fix | Delete

class WP_Widget_Factory {

[16] Fix | Delete

[17] Fix | Delete

/**

[18] Fix | Delete

* Widgets array.

[19] Fix | Delete

*

[20] Fix | Delete

* @since 2.8.0

[21] Fix | Delete

* @var array

[22] Fix | Delete

*/

[23] Fix | Delete

public $widgets = array();

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* PHP5 constructor.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 4.3.0

[29] Fix | Delete

*/

[30] Fix | Delete

public function __construct() {

[31] Fix | Delete

add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );

[32] Fix | Delete

}

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* PHP4 constructor.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 2.8.0

[38] Fix | Delete

* @deprecated 4.3.0 Use __construct() instead.

[39] Fix | Delete

*

[40] Fix | Delete

* @see WP_Widget_Factory::__construct()

[41] Fix | Delete

*/

[42] Fix | Delete

public function WP_Widget_Factory() {

[43] Fix | Delete

_deprecated_constructor( 'WP_Widget_Factory', '4.3.0' );

[44] Fix | Delete

self::__construct();

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Registers a widget subclass.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 2.8.0

[51] Fix | Delete

* @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object

[52] Fix | Delete

* instead of simply a `WP_Widget` subclass name.

[53] Fix | Delete

*

[54] Fix | Delete

* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.

[55] Fix | Delete

*/

[56] Fix | Delete

public function register( $widget ) {

[57] Fix | Delete

if ( $widget instanceof WP_Widget ) {

[58] Fix | Delete

$this->widgets[ spl_object_hash( $widget ) ] = $widget;

[59] Fix | Delete

} else {

[60] Fix | Delete

$this->widgets[ $widget ] = new $widget();

[61] Fix | Delete

}

[62] Fix | Delete

}

[63] Fix | Delete

[64] Fix | Delete

/**

[65] Fix | Delete

* Un-registers a widget subclass.

[66] Fix | Delete

*

[67] Fix | Delete

* @since 2.8.0

[68] Fix | Delete

* @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object

[69] Fix | Delete

* instead of simply a `WP_Widget` subclass name.

[70] Fix | Delete

*

[71] Fix | Delete

* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.

[72] Fix | Delete

*/

[73] Fix | Delete

public function unregister( $widget ) {

[74] Fix | Delete

if ( $widget instanceof WP_Widget ) {

[75] Fix | Delete

unset( $this->widgets[ spl_object_hash( $widget ) ] );

[76] Fix | Delete

} else {

[77] Fix | Delete

unset( $this->widgets[ $widget ] );

[78] Fix | Delete

}

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Serves as a utility method for adding widgets to the registered widgets global.

[83] Fix | Delete

*

[84] Fix | Delete

* @since 2.8.0

[85] Fix | Delete

*

[86] Fix | Delete

* @global array $wp_registered_widgets

[87] Fix | Delete

*/

[88] Fix | Delete

public function _register_widgets() {

[89] Fix | Delete

global $wp_registered_widgets;

[90] Fix | Delete

$keys = array_keys( $this->widgets );

[91] Fix | Delete

$registered = array_keys( $wp_registered_widgets );

[92] Fix | Delete

$registered = array_map( '_get_widget_id_base', $registered );

[93] Fix | Delete

[94] Fix | Delete

foreach ( $keys as $key ) {

[95] Fix | Delete

// Don't register new widget if old widget with the same id is already registered.

[96] Fix | Delete

if ( in_array( $this->widgets[ $key ]->id_base, $registered, true ) ) {

[97] Fix | Delete

unset( $this->widgets[ $key ] );

[98] Fix | Delete

continue;

[99] Fix | Delete

}

[100] Fix | Delete

[101] Fix | Delete

$this->widgets[ $key ]->_register();

[102] Fix | Delete

}

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Returns the registered WP_Widget object for the given widget type.

[107] Fix | Delete

*

[108] Fix | Delete

* @since 5.8.0

[109] Fix | Delete

*

[110] Fix | Delete

* @param string $id_base Widget type ID.

[111] Fix | Delete

* @return WP_Widget|null

[112] Fix | Delete

*/

[113] Fix | Delete

public function get_widget_object( $id_base ) {

[114] Fix | Delete

$key = $this->get_widget_key( $id_base );

[115] Fix | Delete

if ( '' === $key ) {

[116] Fix | Delete

return null;

[117] Fix | Delete

}

[118] Fix | Delete

[119] Fix | Delete

return $this->widgets[ $key ];

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

/**

[123] Fix | Delete

* Returns the registered key for the given widget type.

[124] Fix | Delete

*

[125] Fix | Delete

* @since 5.8.0

[126] Fix | Delete

*

[127] Fix | Delete

* @param string $id_base Widget type ID.

[128] Fix | Delete

* @return string

[129] Fix | Delete

*/

[130] Fix | Delete

public function get_widget_key( $id_base ) {

[131] Fix | Delete

foreach ( $this->widgets as $key => $widget_object ) {

[132] Fix | Delete

if ( $widget_object->id_base === $id_base ) {

[133] Fix | Delete

return $key;

[134] Fix | Delete

}

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

return '';

[138] Fix | Delete

}

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete