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

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

Browse Source 
Also fixes a typo in the class DocBlock.

Props leemon.
Fixes #34022. See #34013.


git-svn-id: https://develop.svn.wordpress.org/trunk@34614 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-27 00:50:04 +00:00
parent fdd92e64cd
commit f2af1a6a1f
1 changed files with 38 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/wp-includes/widgets/class-wp-widget-recent-comments.php
View File

@ -8,7 +8,7 @@
*/ */
/** /**
* Core class used to implement a Recent_Comments widget. * Core class used to implement a Recent Comments widget.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -16,6 +16,12 @@
*/ */
class WP_Widget_Recent_Comments extends WP_Widget { class WP_Widget_Recent_Comments extends WP_Widget {
/**
* Sets up a new Recent Comments widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array('classname' => 'widget_recent_comments', 'description' => __( 'Your site’s most recent comments.' ) ); $widget_ops = array('classname' => 'widget_recent_comments', 'description' => __( 'Your site’s most recent comments.' ) );
parent::__construct('recent-comments', __('Recent Comments'), $widget_ops); parent::__construct('recent-comments', __('Recent Comments'), $widget_ops);
@ -26,6 +32,9 @@ class WP_Widget_Recent_Comments extends WP_Widget {
} }
/** /**
* Outputs the default styles for the Recent Comments widget.
*
* @since 2.8.0
* @access public * @access public
*/ */
public function recent_comments_style() { public function recent_comments_style() {
@ -46,8 +55,14 @@ class WP_Widget_Recent_Comments extends WP_Widget {
} }
/** /**
* @param array $args * Outputs the content for the current Recent Comments widget instance.
* @param array $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 Settings for the current Recent Comments widget instance.
*/ */
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
if ( ! isset( $args['widget_id'] ) ) if ( ! isset( $args['widget_id'] ) )
@ -107,9 +122,15 @@ class WP_Widget_Recent_Comments extends WP_Widget {
} }
/** /**
* @param array $new_instance * Handles updating settings for the current Recent Comments widget instance.
* @param array $old_instance *
* @return array * @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 ) { public function update( $new_instance, $old_instance ) {
$instance = $old_instance; $instance = $old_instance;
@ -119,7 +140,12 @@ class WP_Widget_Recent_Comments extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the Recent Comments widget.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
*/ */
public function form( $instance ) { public function form( $instance ) {
$title = isset( $instance['title'] ) ? $instance['title'] : ''; $title = isset( $instance['title'] ) ? $instance['title'] : '';