From a05eb043c31b6acd36bcd7d32c6c779c9873aa6f Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 27 Sep 2015 01:07:25 +0000 Subject: [PATCH] Docs: Improve documentation for the `__construct()`, `widget()`, `update()`, and `form()` methods in `WP_Widget_Calendar`. Props leemon. Fixes #34017. See #34013. Built from https://develop.svn.wordpress.org/trunk@34619 git-svn-id: http://core.svn.wordpress.org/trunk@34583 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/version.php | 2 +- .../widgets/class-wp-widget-calendar.php | 39 +++++++++++++++---- 2 files changed, 32 insertions(+), 9 deletions(-) diff --git a/wp-includes/version.php b/wp-includes/version.php index 01247343ba..04bca78062 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.4-alpha-34618'; +$wp_version = '4.4-alpha-34619'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. diff --git a/wp-includes/widgets/class-wp-widget-calendar.php b/wp-includes/widgets/class-wp-widget-calendar.php index 67af08d35f..2a8911ad2b 100644 --- a/wp-includes/widgets/class-wp-widget-calendar.php +++ b/wp-includes/widgets/class-wp-widget-calendar.php @@ -26,14 +26,26 @@ class WP_Widget_Calendar extends WP_Widget { */ private static $instance = 0; + /** + * Sets up a new Calendar widget instance. + * + * @since 2.8.0 + * @access public + */ public function __construct() { $widget_ops = array('classname' => 'widget_calendar', 'description' => __( 'A calendar of your site’s Posts.') ); parent::__construct('calendar', __('Calendar'), $widget_ops); } /** - * @param array $args - * @param array $instance + * Outputs the content for the current Calendar widget instance. + * + * @since 2.8.0 + * @access public + * + * @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 ) { /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ @@ -56,9 +68,15 @@ class WP_Widget_Calendar extends WP_Widget { } /** - * @param array $new_instance - * @param array $old_instance - * @return array + * Handles updating settings for the current Calendar widget instance. + * + * @since 2.8.0 + * @access public + * + * @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; @@ -68,14 +86,19 @@ class WP_Widget_Calendar extends WP_Widget { } /** - * @param array $instance + * Outputs the settings form for the Calendar widget. + * + * @since 2.8.0 + * @access public + * + * @param array $instance Current settings. */ public function form( $instance ) { $instance = wp_parse_args( (array) $instance, array( 'title' => '' ) ); $title = sanitize_text_field( $instance['title'] ); -?> + ?>

-