wppaste
WordPress

WP_Widget_Calendar

Since
2.8.0
Source
wp-includes/widgets/class-wp-widget-calendar.php:17
Core class used to implement the Calendar widget.

Compatibility

WordPress
since 2.8.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

Every hook that fires from inside WP_Widget_Calendar, in the order it appears in the class, grouped by the method that fires it.

Properties · 1

$instanceintprivate static
Ensure that the ID attribute only appears in the markup once

Methods · 4

  • __construct()Sets up a new Calendar widget instance.
  • widget()Outputs the content for the current Calendar widget instance.
  • update()Handles updating settings for the current Calendar widget instance.
  • form()Outputs the settings form for the Calendar widget.

Source code

class WP_Widget_Calendar extends WP_Widget {	/**	 * Ensure that the ID attribute only appears in the markup once	 *	 * @since 4.4.0	 * @var int	 */	private static $instance = 0; 	/**	 * Sets up a new Calendar widget instance.	 *	 * @since 2.8.0	 */	public function __construct() {		$widget_ops = array(			'classname'                   => 'widget_calendar',			'description'                 => __( 'A calendar of your site’s posts.' ),			'customize_selective_refresh' => true,			'show_instance_in_rest'       => true,		);		parent::__construct( 'calendar', __( 'Calendar' ), $widget_ops );	} 	/**	 * Outputs the content for the current Calendar widget instance.	 *	 * @since 2.8.0	 *	 * @param array $args     Display arguments including 'before_title', 'after_title',	 *                        'before_widget', and 'after_widget'.	 * @param array $instance The settings for the particular instance of the widget.	 */	public function widget( $args, $instance ) {		$title = ! empty( $instance['title'] ) ? $instance['title'] : ''; 		/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */		$title = apply_filters( 'widget_title', $title, $instance, $this->id_base ); 		echo $args['before_widget'];		if ( $title ) {			echo $args['before_title'] . $title . $args['after_title'];		}		if ( 0 === self::$instance ) {			echo '<div id="calendar_wrap" class="calendar_wrap">';		} else {			echo '<div class="calendar_wrap">';		}		get_calendar();		echo '</div>';		echo $args['after_widget']; 		++self::$instance;	} 	/**	 * Handles updating settings for the current Calendar widget instance.	 *	 * @since 2.8.0	 *	 * @param array $new_instance New settings for this instance as input by the user via	 *                            WP_Widget::form().	 * @param array $old_instance Old settings for this instance.	 * @return array Updated settings to save.	 */	public function update( $new_instance, $old_instance ) {		$instance          = $old_instance;		$instance['title'] = sanitize_text_field( $new_instance['title'] ); 		return $instance;	} 	/**	 * Outputs the settings form for the Calendar widget.	 *	 * @since 2.8.0	 *	 * @param array $instance Current settings.	 */	public function form( $instance ) {

Changelog

Introduced in 2.8.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/widgets/class-wp-widget-calendar.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.