File "Manager.php"

Full Path: /home/romayxjt/public_html/wp-content/plugins/the-events-calendar/common/src/Tribe/Widget/Manager.php
File size: 2.21 KB
MIME-type: text/x-php
Charset: utf-8

<?php
/**
 * Widgets manager for Tribe plugins.
 *
 * @since   4.12.12
 *
 * @package Tribe\Widget
 */

namespace Tribe\Widget;

/**
 * Class Widget Manager.
 *
 * @since  4.12.12
 *
 * @package Tribe\Widget
 */
class Manager {

	/**
	 * Get the list of widgets available for handling.
	 *
	 * @since  4.12.12
	 *
	 * @return array An associative array of widgets in the shape `[ <slug> => <class> ]`.
	 */
	public function get_registered_widgets() {
		$widgets = [];

		/**
		 * Allow the registering of widgets from other plugins.
		 *
		 * @since  4.12.12
		 *
		 * @var array<string,string> An associative array of widgets in the shape `[ <slug> => <class> ]`.
		 */
		$widgets = apply_filters( 'tribe_widgets', $widgets );

		return $widgets;
	}

	/**
	 * Verifies if a given widget slug is registered for handling.
	 *
	 * @since  4.12.12
	 *
	 * @param  string $slug The widget slug we are checking for registration.
	 *
	 * @return bool Whether the widget is registered or not.
	 */
	public function is_widget_registered( $slug ) {
		$registered_widgets = $this->get_registered_widgets();

		return isset( $registered_widgets[ $slug ] );
	}

	/**
	 * Verifies if a given widget class name is registered for handling.
	 *
	 * @since  4.12.12
	 *
	 * @param  string $class_name The widget class name we are checking for registration.
	 *
	 * @return bool Whether the widget is registered, by class.
	 */
	public function is_widget_registered_by_class( $class_name ) {
		$registered_widgets = $this->get_registered_widgets();

		return in_array( $class_name, $registered_widgets, true );
	}

	/**
	 * Add new widgets handler to ensure our list of widget slugs is registered by class name.
	 *
	 * @since  4.12.12
	 */
	public function register_widgets_with_wp() {
		$registered_widgets = $this->get_registered_widgets();

		// Add to WordPress all of the registered Widgets.
		foreach ( $registered_widgets as $widget => $class_name ) {
			register_widget( $class_name );
		}
	}

	/**
	 * Remove Widget from WordPress widget register by class name.
	 *
	 * @since  4.12.12
	 *
	 * @param string $class_name The class name of the widget to unregister.
	 */
	public function unregister_widget_from_wp( $class_name ) {
		unregister_widget( $class_name );
	}
}