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_RSS.

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


git-svn-id: https://develop.svn.wordpress.org/trunk@34612 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-09-27 00:41:47 +00:00
parent f111c41375
commit 14cac9aded
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
src/wp-includes/widgets/class-wp-widget-rss.php
View File

@ -16,6 +16,12 @@
*/ */
class WP_Widget_RSS extends WP_Widget { class WP_Widget_RSS extends WP_Widget {
/**
* Sets up a new RSS widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array( 'description' => __('Entries from any RSS or Atom feed.') ); $widget_ops = array( 'description' => __('Entries from any RSS or Atom feed.') );
$control_ops = array( 'width' => 400, 'height' => 200 ); $control_ops = array( 'width' => 400, 'height' => 200 );
@ -23,8 +29,14 @@ class WP_Widget_RSS extends WP_Widget {
} }
/** /**
* @param array $args * Outputs the content for the current RSS 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 RSS widget instance.
*/ */
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
if ( isset($instance['error']) && $instance['error'] ) if ( isset($instance['error']) && $instance['error'] )
@ -79,9 +91,15 @@ class WP_Widget_RSS extends WP_Widget {
} }
/** /**
* @param array $new_instance * Handles updating settings for the current RSS 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 ) {
$testurl = ( isset( $new_instance['url'] ) && ( !isset( $old_instance['url'] ) || ( $new_instance['url'] != $old_instance['url'] ) ) ); $testurl = ( isset( $new_instance['url'] ) && ( !isset( $old_instance['url'] ) || ( $new_instance['url'] != $old_instance['url'] ) ) );
@ -89,7 +107,12 @@ class WP_Widget_RSS extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the RSS widget.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
*/ */
public function form( $instance ) { public function form( $instance ) {
if ( empty( $instance ) ) { if ( empty( $instance ) ) {