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

Props leemon.
Fixes #34020. See #34013.

Built from https://develop.svn.wordpress.org/trunk@34616


git-svn-id: http://core.svn.wordpress.org/trunk@34580 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-27 00:58:24 +00:00
parent 033c9b8d7f
commit 233ecbfdb8
2 changed files with 34 additions and 11 deletions

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-34615'; $wp_version = '4.4-alpha-34616';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -18,14 +18,26 @@
*/ */
class WP_Widget_Meta extends WP_Widget { class WP_Widget_Meta extends WP_Widget {
/**
* Sets up a new Meta widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array('classname' => 'widget_meta', 'description' => __( "Login, RSS, & WordPress.org links.") ); $widget_ops = array('classname' => 'widget_meta', 'description' => __( "Login, RSS, & WordPress.org links.") );
parent::__construct('meta', __('Meta'), $widget_ops); parent::__construct('meta', __('Meta'), $widget_ops);
} }
/** /**
* @param array $args * Outputs the content for the current Meta 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 Meta widget instance.
*/ */
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
/** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */ /** This filter is documented in wp-includes/widgets/class-wp-widget-pages.php */
@ -35,13 +47,13 @@ class WP_Widget_Meta extends WP_Widget {
if ( $title ) { if ( $title ) {
echo $args['before_title'] . $title . $args['after_title']; echo $args['before_title'] . $title . $args['after_title'];
} }
?> ?>
<ul> <ul>
<?php wp_register(); ?> <?php wp_register(); ?>
<li><?php wp_loginout(); ?></li> <li><?php wp_loginout(); ?></li>
<li><a href="<?php echo esc_url( get_bloginfo( 'rss2_url' ) ); ?>"><?php _e('Entries <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li> <li><a href="<?php echo esc_url( get_bloginfo( 'rss2_url' ) ); ?>"><?php _e('Entries <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li>
<li><a href="<?php echo esc_url( get_bloginfo( 'comments_rss2_url' ) ); ?>"><?php _e('Comments <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li> <li><a href="<?php echo esc_url( get_bloginfo( 'comments_rss2_url' ) ); ?>"><?php _e('Comments <abbr title="Really Simple Syndication">RSS</abbr>'); ?></a></li>
<?php <?php
/** /**
* Filter the "Powered by WordPress" text in the Meta widget. * Filter the "Powered by WordPress" text in the Meta widget.
* *
@ -56,16 +68,22 @@ class WP_Widget_Meta extends WP_Widget {
) ); ) );
wp_meta(); wp_meta();
?> ?>
</ul> </ul>
<?php <?php
echo $args['after_widget']; echo $args['after_widget'];
} }
/** /**
* @param array $new_instance * Handles updating settings for the current Meta 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;
@ -75,7 +93,12 @@ class WP_Widget_Meta extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the Meta widget.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
*/ */
public function form( $instance ) { public function form( $instance ) {
$instance = wp_parse_args( (array) $instance, array( 'title' => '' ) ); $instance = wp_parse_args( (array) $instance, array( 'title' => '' ) );