2015-08-25 22:40:23 -04:00
|
|
|
<?php
|
|
|
|
/**
|
2015-09-22 08:28:27 -04:00
|
|
|
* Widget API: WP_Widget_Factory class
|
2015-08-25 22:40:23 -04:00
|
|
|
*
|
|
|
|
* @package WordPress
|
2015-09-22 09:48:25 -04:00
|
|
|
* @subpackage Widgets
|
2015-08-26 03:53:21 -04:00
|
|
|
* @since 4.4.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Singleton that registers and instantiates WP_Widget classes.
|
|
|
|
*
|
2015-08-25 22:40:23 -04:00
|
|
|
* @since 2.8.0
|
2015-08-26 03:53:21 -04:00
|
|
|
* @since 4.4.0 Moved to its own file from wp-includes/widgets.php
|
2015-08-25 22:40:23 -04:00
|
|
|
*/
|
|
|
|
class WP_Widget_Factory {
|
2016-03-23 00:11:28 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Widgets array.
|
|
|
|
*
|
|
|
|
* @since 2.8.0
|
|
|
|
* @access public
|
|
|
|
* @var array
|
|
|
|
*/
|
2015-08-25 22:40:23 -04:00
|
|
|
public $widgets = array();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* PHP5 constructor.
|
2016-03-23 00:19:27 -04:00
|
|
|
*
|
|
|
|
* @since 4.3.0
|
|
|
|
* @access public
|
2015-08-25 22:40:23 -04:00
|
|
|
*/
|
|
|
|
public function __construct() {
|
|
|
|
add_action( 'widgets_init', array( $this, '_register_widgets' ), 100 );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* PHP4 constructor.
|
2016-03-23 00:19:27 -04:00
|
|
|
*
|
|
|
|
* @since 2.8.0
|
|
|
|
* @access public
|
2015-08-25 22:40:23 -04:00
|
|
|
*/
|
|
|
|
public function WP_Widget_Factory() {
|
|
|
|
_deprecated_constructor( 'WP_Widget_Factory', '4.2.0' );
|
|
|
|
self::__construct();
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-03-23 00:51:26 -04:00
|
|
|
* Registers a widget subclass.
|
2015-08-25 22:40:23 -04:00
|
|
|
*
|
|
|
|
* @since 2.8.0
|
2016-04-29 14:49:26 -04:00
|
|
|
* @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
|
2015-08-25 22:40:23 -04:00
|
|
|
* @access public
|
|
|
|
*
|
2016-04-29 14:49:26 -04:00
|
|
|
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
|
2015-08-25 22:40:23 -04:00
|
|
|
*/
|
2016-04-29 14:49:26 -04:00
|
|
|
public function register( $widget ) {
|
|
|
|
if ( $widget instanceof WP_Widget ) {
|
|
|
|
$this->widgets[ spl_object_hash( $widget ) ] = $widget;
|
|
|
|
} else {
|
|
|
|
$this->widgets[ $widget ] = new $widget();
|
|
|
|
}
|
2015-08-25 22:40:23 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-03-23 00:51:26 -04:00
|
|
|
* Un-registers a widget subclass.
|
2015-08-25 22:40:23 -04:00
|
|
|
*
|
|
|
|
* @since 2.8.0
|
2016-04-29 14:49:26 -04:00
|
|
|
* @since 4.6.0 The `$widget` param can also be an instance object of `WP_Widget` instead of just a `WP_Widget` subclass name.
|
2015-08-25 22:40:23 -04:00
|
|
|
* @access public
|
|
|
|
*
|
2016-04-29 14:49:26 -04:00
|
|
|
* @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass.
|
2015-08-25 22:40:23 -04:00
|
|
|
*/
|
2016-04-29 14:49:26 -04:00
|
|
|
public function unregister( $widget ) {
|
|
|
|
if ( $widget instanceof WP_Widget ) {
|
|
|
|
unset( $this->widgets[ spl_object_hash( $widget ) ] );
|
|
|
|
} else {
|
|
|
|
unset( $this->widgets[ $widget ] );
|
|
|
|
}
|
2015-08-25 22:40:23 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2016-03-23 00:51:26 -04:00
|
|
|
* Serves as a utility method for adding widgets to the registered widgets global.
|
2015-08-25 22:40:23 -04:00
|
|
|
*
|
|
|
|
* @since 2.8.0
|
|
|
|
* @access public
|
|
|
|
*
|
|
|
|
* @global array $wp_registered_widgets
|
|
|
|
*/
|
|
|
|
public function _register_widgets() {
|
|
|
|
global $wp_registered_widgets;
|
|
|
|
$keys = array_keys($this->widgets);
|
|
|
|
$registered = array_keys($wp_registered_widgets);
|
|
|
|
$registered = array_map('_get_widget_id_base', $registered);
|
|
|
|
|
|
|
|
foreach ( $keys as $key ) {
|
|
|
|
// don't register new widget if old widget with the same id is already registered
|
|
|
|
if ( in_array($this->widgets[$key]->id_base, $registered, true) ) {
|
|
|
|
unset($this->widgets[$key]);
|
|
|
|
continue;
|
|
|
|
}
|
|
|
|
|
|
|
|
$this->widgets[$key]->_register();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|