Skip to content

Commit 229a578

Browse files
committed
Docs: Use third-person singular verbs for function descriptions in the WP_Screen API.
See #55646. git-svn-id: https://develop.svn.wordpress.org/trunk@53514 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 17554d8 commit 229a578

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

src/wp-admin/includes/class-wp-screen.php

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ public function set_current_screen() {
430430
private function __construct() {}
431431

432432
/**
433-
* Indicates whether the screen is in a particular admin
433+
* Indicates whether the screen is in a particular admin.
434434
*
435435
* @since 3.5.0
436436
*
@@ -475,7 +475,7 @@ public static function add_old_compat_help( $screen, $help ) {
475475
}
476476

477477
/**
478-
* Set the parent information for the screen.
478+
* Sets the parent information for the screen.
479479
*
480480
* This is called in admin-header.php after the menu parent for the screen has been determined.
481481
*
@@ -505,7 +505,7 @@ public function add_option( $option, $args = array() ) {
505505
}
506506

507507
/**
508-
* Remove an option from the screen.
508+
* Removes an option from the screen.
509509
*
510510
* @since 3.8.0
511511
*
@@ -516,7 +516,7 @@ public function remove_option( $option ) {
516516
}
517517

518518
/**
519-
* Remove all options from the screen.
519+
* Removes all options from the screen.
520520
*
521521
* @since 3.8.0
522522
*/
@@ -525,7 +525,7 @@ public function remove_options() {
525525
}
526526

527527
/**
528-
* Get the options registered for the screen.
528+
* Gets the options registered for the screen.
529529
*
530530
* @since 3.8.0
531531
*
@@ -606,7 +606,7 @@ public function get_help_tab( $id ) {
606606
}
607607

608608
/**
609-
* Add a help tab to the contextual help for the screen.
609+
* Adds a help tab to the contextual help for the screen.
610610
*
611611
* Call this on the `load-$pagenow` hook for the relevant screen,
612612
* or fetch the `$current_screen` object, or use get_current_screen()
@@ -682,7 +682,7 @@ public function get_help_sidebar() {
682682
}
683683

684684
/**
685-
* Add a sidebar to the contextual help for the screen.
685+
* Adds a sidebar to the contextual help for the screen.
686686
*
687687
* Call this in template files after admin.php is loaded and before admin-header.php is loaded
688688
* to add a sidebar to the contextual help.
@@ -713,7 +713,7 @@ public function get_columns() {
713713
}
714714

715715
/**
716-
* Get the accessible hidden headings and text used in the screen.
716+
* Gets the accessible hidden headings and text used in the screen.
717717
*
718718
* @since 4.4.0
719719
*
@@ -726,7 +726,7 @@ public function get_screen_reader_content() {
726726
}
727727

728728
/**
729-
* Get a screen reader text string.
729+
* Gets a screen reader text string.
730730
*
731731
* @since 4.4.0
732732
*
@@ -741,7 +741,7 @@ public function get_screen_reader_text( $key ) {
741741
}
742742

743743
/**
744-
* Add accessible hidden headings and text for the screen.
744+
* Adds accessible hidden headings and text for the screen.
745745
*
746746
* @since 4.4.0
747747
*
@@ -768,7 +768,7 @@ public function set_screen_reader_content( $content = array() ) {
768768
}
769769

770770
/**
771-
* Remove all the accessible hidden headings and text for the screen.
771+
* Removes all the accessible hidden headings and text for the screen.
772772
*
773773
* @since 4.4.0
774774
*/
@@ -777,7 +777,7 @@ public function remove_screen_reader_content() {
777777
}
778778

779779
/**
780-
* Render the screen's help section.
780+
* Renders the screen's help section.
781781
*
782782
* This will trigger the deprecated filters for backward compatibility.
783783
*
@@ -1034,7 +1034,7 @@ public function show_screen_options() {
10341034
}
10351035

10361036
/**
1037-
* Render the screen options tab.
1037+
* Renders the screen options tab.
10381038
*
10391039
* @since 3.3.0
10401040
*
@@ -1097,7 +1097,7 @@ public function render_screen_options( $options = array() ) {
10971097
}
10981098

10991099
/**
1100-
* Render the meta boxes preferences.
1100+
* Renders the meta boxes preferences.
11011101
*
11021102
* @since 4.4.0
11031103
*
@@ -1140,7 +1140,7 @@ public function render_meta_boxes_preferences() {
11401140
}
11411141

11421142
/**
1143-
* Render the list table columns preferences.
1143+
* Renders the list table columns preferences.
11441144
*
11451145
* @since 4.4.0
11461146
*/
@@ -1188,7 +1188,7 @@ public function render_list_table_columns_preferences() {
11881188
}
11891189

11901190
/**
1191-
* Render the option for number of columns on the page
1191+
* Renders the option for number of columns on the page.
11921192
*
11931193
* @since 3.3.0
11941194
*/
@@ -1220,7 +1220,7 @@ public function render_screen_layout() {
12201220
}
12211221

12221222
/**
1223-
* Render the items per page option
1223+
* Renders the items per page option.
12241224
*
12251225
* @since 3.3.0
12261226
*/
@@ -1284,7 +1284,7 @@ public function render_per_page_options() {
12841284
}
12851285

12861286
/**
1287-
* Render the list table view mode preferences.
1287+
* Renders the list table view mode preferences.
12881288
*
12891289
* @since 4.4.0
12901290
*
@@ -1338,7 +1338,7 @@ public function render_view_mode() {
13381338
}
13391339

13401340
/**
1341-
* Render screen reader text.
1341+
* Renders screen reader text.
13421342
*
13431343
* @since 4.4.0
13441344
*

0 commit comments

Comments
 (0)