Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-01-10 18:37:58 +01:00
Code Issues Projects Releases Wiki Activity

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

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

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


git-svn-id: http://core.svn.wordpress.org/trunk@34575 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-09-27 00:37:24 +00:00
parent 08277293e5
commit 80a32b4bc8
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-34610'; $wp_version = '4.4-alpha-34611';
/** /**
* 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.

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

@ -16,14 +16,26 @@
*/ */
class WP_Widget_Search extends WP_Widget { class WP_Widget_Search extends WP_Widget {
/**
* Sets up a new Search widget instance.
*
* @since 2.8.0
* @access public
*/
public function __construct() { public function __construct() {
$widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your site.") ); $widget_ops = array('classname' => 'widget_search', 'description' => __( "A search form for your site.") );
parent::__construct( 'search', _x( 'Search', 'Search widget' ), $widget_ops ); parent::__construct( 'search', _x( 'Search', 'Search widget' ), $widget_ops );
} }
/** /**
* @param array $args * Outputs the content for the current Search 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 Search 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 */
@ -41,7 +53,12 @@ class WP_Widget_Search extends WP_Widget {
} }
/** /**
* @param array $instance * Outputs the settings form for the Search 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' => '') );
@ -52,9 +69,15 @@ class WP_Widget_Search extends WP_Widget {
} }
/** /**
* @param array $new_instance * Handles updating settings for the current Search 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.
*/ */
public function update( $new_instance, $old_instance ) { public function update( $new_instance, $old_instance ) {
$instance = $old_instance; $instance = $old_instance;