Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-28 07:45:02 +02:00
Code Issues Projects Releases Wiki Activity

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

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

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


git-svn-id: http://core.svn.wordpress.org/trunk@34581 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-27 01:00:24 +00:00
parent 233ecbfdb8
commit 192e7f8c61
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-34616'; $wp_version = '4.4-alpha-34617';
/** /**
* 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-links.php
View File

@ -16,14 +16,26 @@
*/ */
class WP_Widget_Links extends WP_Widget { class WP_Widget_Links extends WP_Widget {
/**
* Sets up a new Links widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array('description' => __( "Your blogroll" ) ); $widget_ops = array('description' => __( "Your blogroll" ) );
parent::__construct('links', __('Links'), $widget_ops); parent::__construct('links', __('Links'), $widget_ops);
} }
/** /**
* @param array $args * Outputs the content for the current Links 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 Links widget instance.
*/ */
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
$show_description = isset($instance['description']) ? $instance['description'] : false; $show_description = isset($instance['description']) ? $instance['description'] : false;
@ -68,9 +80,15 @@ class WP_Widget_Links extends WP_Widget {
} }
/** /**
* @param array $new_instance * Handles updating settings for the current Links 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 ) {
$new_instance = (array) $new_instance; $new_instance = (array) $new_instance;
@ -91,7 +109,12 @@ class WP_Widget_Links extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the Links widget.
*
* @since 2.8.0
* @access public
*
* @param array $instance Current settings.
*/ */
public function form( $instance ) { public function form( $instance ) {
@ -100,7 +123,7 @@ class WP_Widget_Links extends WP_Widget {
$link_cats = get_terms( 'link_category' ); $link_cats = get_terms( 'link_category' );
if ( ! $limit = intval( $instance['limit'] ) ) if ( ! $limit = intval( $instance['limit'] ) )
$limit = -1; $limit = -1;
?> ?>
<p> <p>
<label for="<?php echo $this->get_field_id('category'); ?>"><?php _e( 'Select Link Category:' ); ?></label> <label for="<?php echo $this->get_field_id('category'); ?>"><?php _e( 'Select Link Category:' ); ?></label>
<select class="widefat" id="<?php echo $this->get_field_id('category'); ?>" name="<?php echo $this->get_field_name('category'); ?>"> <select class="widefat" id="<?php echo $this->get_field_id('category'); ?>" name="<?php echo $this->get_field_name('category'); ?>">
@ -135,6 +158,6 @@ class WP_Widget_Links extends WP_Widget {
<label for="<?php echo $this->get_field_id('limit'); ?>"><?php _e( 'Number of links to show:' ); ?></label> <label for="<?php echo $this->get_field_id('limit'); ?>"><?php _e( 'Number of links to show:' ); ?></label>
<input id="<?php echo $this->get_field_id('limit'); ?>" name="<?php echo $this->get_field_name('limit'); ?>" type="text" value="<?php echo $limit == -1 ? '' : intval( $limit ); ?>" size="3" /> <input id="<?php echo $this->get_field_id('limit'); ?>" name="<?php echo $this->get_field_name('limit'); ?>" type="text" value="<?php echo $limit == -1 ? '' : intval( $limit ); ?>" size="3" />
</p> </p>
<?php <?php
} }
} }