sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve documentation for the __construct(), widget(), update(), and form() methods in WP_Widget_Calendar.

Browse Source 
Props leemon.
Fixes #34017. See #34013.


git-svn-id: https://develop.svn.wordpress.org/trunk@34619 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-27 01:06:20 +00:00
parent b8264d11bc
commit 9909c7ff2b
1 changed files with 31 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
src/wp-includes/widgets/class-wp-widget-calendar.php
View File

@ -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'] );
?>
?>
<p><label for="<?php echo $this->get_field_id('title'); ?>"><?php _e('Title:'); ?></label>
<input class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" type="text" value="<?php echo esc_attr($title); ?>" /></p>
<?php
<?php
}
}