Docs: Standardize hook docs in wp-includes/widgets/* to use third-person singular verbs per the inline documentation standards for PHP.

See #36913.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37457 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-05-22 18:06:28 +00:00
parent c3055cc190
commit 6b8248f3f7
11 changed files with 15 additions and 15 deletions

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.6-alpha-37488'; $wp_version = '4.6-alpha-37489';
/** /**
* 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

@ -61,7 +61,7 @@ class WP_Nav_Menu_Widget extends WP_Widget {
); );
/** /**
* Filter the arguments for the Custom Menu widget. * Filters the arguments for the Custom Menu widget.
* *
* @since 4.2.0 * @since 4.2.0
* @since 4.4.0 Added the `$instance` parameter. * @since 4.4.0 Added the `$instance` parameter.

View File

@ -60,7 +60,7 @@ class WP_Widget_Archives extends WP_Widget {
<select id="<?php echo esc_attr( $dropdown_id ); ?>" name="archive-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'> <select id="<?php echo esc_attr( $dropdown_id ); ?>" name="archive-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'>
<?php <?php
/** /**
* Filter the arguments for the Archives widget drop-down. * Filters the arguments for the Archives widget drop-down.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -101,7 +101,7 @@ class WP_Widget_Archives extends WP_Widget {
<ul> <ul>
<?php <?php
/** /**
* Filter the arguments for the Archives widget. * Filters the arguments for the Archives widget.
* *
* @since 2.8.0 * @since 2.8.0
* *

View File

@ -72,7 +72,7 @@ class WP_Widget_Categories extends WP_Widget {
$cat_args['id'] = $dropdown_id; $cat_args['id'] = $dropdown_id;
/** /**
* Filter the arguments for the Categories widget drop-down. * Filters the arguments for the Categories widget drop-down.
* *
* @since 2.8.0 * @since 2.8.0
* *
@ -105,7 +105,7 @@ class WP_Widget_Categories extends WP_Widget {
$cat_args['title_li'] = ''; $cat_args['title_li'] = '';
/** /**
* Filter the arguments for the Categories widget. * Filters the arguments for the Categories widget.
* *
* @since 2.8.0 * @since 2.8.0
* *

View File

@ -69,7 +69,7 @@ class WP_Widget_Links extends WP_Widget {
); );
/** /**
* Filter the arguments for the Links widget. * Filters the arguments for the Links widget.
* *
* @since 2.6.0 * @since 2.6.0
* @since 4.4.0 The `$instance` parameter was added. * @since 4.4.0 The `$instance` parameter was added.

View File

@ -59,7 +59,7 @@ class WP_Widget_Meta extends WP_Widget {
<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. * Filters the "Powered by WordPress" text in the Meta widget.
* *
* @since 3.6.0 * @since 3.6.0
* *

View File

@ -44,7 +44,7 @@ class WP_Widget_Pages extends WP_Widget {
public function widget( $args, $instance ) { public function widget( $args, $instance ) {
/** /**
* Filter the widget title. * Filters the widget title.
* *
* @since 2.6.0 * @since 2.6.0
* *
@ -61,7 +61,7 @@ class WP_Widget_Pages extends WP_Widget {
$sortby = 'menu_order, post_title'; $sortby = 'menu_order, post_title';
/** /**
* Filter the arguments for the Pages widget. * Filters the arguments for the Pages widget.
* *
* @since 2.8.0 * @since 2.8.0
* *

View File

@ -44,7 +44,7 @@ class WP_Widget_Recent_Comments extends WP_Widget {
*/ */
public function recent_comments_style() { public function recent_comments_style() {
/** /**
* Filter the Recent Comments default widget styles. * Filters the Recent Comments default widget styles.
* *
* @since 3.1.0 * @since 3.1.0
* *
@ -85,7 +85,7 @@ class WP_Widget_Recent_Comments extends WP_Widget {
$number = 5; $number = 5;
/** /**
* Filter the arguments for the Recent Comments widget. * Filters the arguments for the Recent Comments widget.
* *
* @since 3.4.0 * @since 3.4.0
* *

View File

@ -58,7 +58,7 @@ class WP_Widget_Recent_Posts extends WP_Widget {
$show_date = isset( $instance['show_date'] ) ? $instance['show_date'] : false; $show_date = isset( $instance['show_date'] ) ? $instance['show_date'] : false;
/** /**
* Filter the arguments for the Recent Posts widget. * Filters the arguments for the Recent Posts widget.
* *
* @since 3.4.0 * @since 3.4.0
* *

View File

@ -54,7 +54,7 @@ class WP_Widget_Tag_Cloud extends WP_Widget {
} }
/** /**
* Filter the taxonomy used in the Tag Cloud widget. * Filters the taxonomy used in the Tag Cloud widget.
* *
* @since 2.8.0 * @since 2.8.0
* @since 3.0.0 Added taxonomy drop-down. * @since 3.0.0 Added taxonomy drop-down.

View File

@ -50,7 +50,7 @@ class WP_Widget_Text extends WP_Widget {
$widget_text = ! empty( $instance['text'] ) ? $instance['text'] : ''; $widget_text = ! empty( $instance['text'] ) ? $instance['text'] : '';
/** /**
* Filter the content of the Text widget. * Filters the content of the Text widget.
* *
* @since 2.3.0 * @since 2.3.0
* @since 4.4.0 Added the `$this` parameter. * @since 4.4.0 Added the `$this` parameter.