<?php namespace Datafeedr\Api\Wuwei\Event;

/**
 * Interface Subscriber
 *
 * A Subscriber knows what specific WordPress events it wants to listen to.
 *
 * When an EventManager adds a Subscriber, it gets all the WordPress events that
 * it wants to listen to. It then adds the subscriber as a listener for each of them.
 *
 * @since 2.0.0
 *
 * @link https://carlalexander.ca/design-system-wordpress-event-management/
 */
interface Subscriber_Interface {

	/**
	 * Returns an array of events that this subscriber wants to listen to.
	 *
	 * The array key is the event name. The value can be:
	 *
	 *  * The method name
	 *  * An array with the method name and priority
	 *  * An array with the method name, priority and number of accepted arguments
	 *
	 * For instance:
	 *
	 *  * array( 'hook_name' => 'method_name' )
	 *  * array( 'hook_name' => array( 'method_name', $priority ) )
	 *  * array( 'hook_name' => array( 'method_name', $priority, $accepted_args ) )
	 *
	 * @return array
	 */
	public static function get_subscribed_events();
}