WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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

Props leemon.
Fixes #34021. See #34013.

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


git-svn-id: http://core.svn.wordpress.org/trunk@34579 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-27 00:54:24 +00:00
parent 5ab3821730
commit 033c9b8d7f
2 changed files with 32 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.4-alpha-34614'; $wp_version = '4.4-alpha-34615';
/** /**
* 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.

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

@ -16,14 +16,26 @@
*/ */
class WP_Widget_Pages extends WP_Widget { class WP_Widget_Pages extends WP_Widget {
/**
* Sets up a new Pages widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array('classname' => 'widget_pages', 'description' => __( 'A list of your site’s Pages.') ); $widget_ops = array('classname' => 'widget_pages', 'description' => __( 'A list of your site’s Pages.') );
parent::__construct('pages', __('Pages'), $widget_ops); parent::__construct('pages', __('Pages'), $widget_ops);
} }
/** /**
* @param array $args * Outputs the content for the current Pages 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 Pages widget instance.
*/ */
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
@ -75,9 +87,15 @@ class WP_Widget_Pages extends WP_Widget {
} }
/** /**
* @param array $new_instance * Handles updating settings for the current Pages 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;
@ -94,12 +112,17 @@ class WP_Widget_Pages extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the Pages widget.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
*/ */
public function form( $instance ) { public function form( $instance ) {
//Defaults //Defaults
$instance = wp_parse_args( (array) $instance, array( 'sortby' => 'post_title', 'title' => '', 'exclude' => '') ); $instance = wp_parse_args( (array) $instance, array( 'sortby' => 'post_title', 'title' => '', 'exclude' => '') );
?> ?>
<p> <p>
<label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title:' ); ?></label> <label for="<?php echo esc_attr( $this->get_field_id( 'title' ) ); ?>"><?php _e( 'Title:' ); ?></label>
<input class="widefat" id="<?php echo esc_attr( $this->get_field_id('title') ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" /> <input class="widefat" id="<?php echo esc_attr( $this->get_field_id('title') ); ?>" name="<?php echo esc_attr( $this->get_field_name( 'title' ) ); ?>" type="text" value="<?php echo esc_attr( $instance['title'] ); ?>" />
@ -118,7 +141,7 @@ class WP_Widget_Pages extends WP_Widget {
<br /> <br />
<small><?php _e( 'Page IDs, separated by commas.' ); ?></small> <small><?php _e( 'Page IDs, separated by commas.' ); ?></small>
</p> </p>
<?php <?php
} }
} }