Skip to content

Commit a70f256

Browse files
Docs: Add missing descriptions for WP_MS_Sites_List_Table methods.
Follow-up to [15491], [16992]. Props noruzzaman, huzaifaalmesbah. See #64224. Built from https://develop.svn.wordpress.org/trunk@61698 git-svn-id: http://core.svn.wordpress.org/trunk@61006 1a063a9b-81f0-0310-95a4-ce76da25c4cd
1 parent 10a7f4d commit a70f256

2 files changed

Lines changed: 29 additions & 6 deletions

File tree

wp-admin/includes/class-wp-ms-sites-list-table.php

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,11 @@ public function __construct( $args = array() ) {
5050
}
5151

5252
/**
53-
* @return bool
53+
* Checks if the current user has permissions to manage sites.
54+
*
55+
* @since 3.1.0
56+
*
57+
* @return bool Whether the user can manage sites.
5458
*/
5559
public function ajax_user_can() {
5660
return current_user_can( 'manage_sites' );
@@ -62,7 +66,7 @@ public function ajax_user_can() {
6266
* @since 3.1.0
6367
*
6468
* @global string $mode List table view mode.
65-
* @global string $s
69+
* @global string $s Search string.
6670
* @global wpdb $wpdb WordPress database abstraction object.
6771
*/
6872
public function prepare_items() {
@@ -206,6 +210,9 @@ public function prepare_items() {
206210
}
207211

208212
/**
213+
* Displays a message when no sites are found.
214+
*
215+
* @since 3.1.0
209216
*/
210217
public function no_items() {
211218
_e( 'No sites found.' );
@@ -286,7 +293,11 @@ protected function get_views() {
286293
}
287294

288295
/**
289-
* @return array
296+
* Gets an associative array of bulk actions for this table.
297+
*
298+
* @since 3.1.0
299+
*
300+
* @return array<string, string> An associative array of bulk actions.
290301
*/
291302
protected function get_bulk_actions() {
292303
$actions = array();
@@ -300,6 +311,10 @@ protected function get_bulk_actions() {
300311
}
301312

302313
/**
314+
* Displays the pagination.
315+
*
316+
* @since 3.1.0
317+
*
303318
* @global string $mode List table view mode.
304319
*
305320
* @param string $which The location of the pagination nav markup: Either 'top' or 'bottom'.
@@ -359,6 +374,10 @@ protected function extra_tablenav( $which ) {
359374
}
360375

361376
/**
377+
* Gets an array of column titles keyed by their column name.
378+
*
379+
* @since 3.1.0
380+
*
362381
* @return string[] Array of column titles keyed by their column name.
363382
*/
364383
public function get_columns() {
@@ -386,7 +405,11 @@ public function get_columns() {
386405
}
387406

388407
/**
389-
* @return array
408+
* Gets an array of sortable columns.
409+
*
410+
* @since 3.1.0
411+
*
412+
* @return array<string, mixed> An array of sortable columns.
390413
*/
391414
protected function get_sortable_columns() {
392415

@@ -640,7 +663,7 @@ public function display_rows() {
640663
*
641664
* @since 5.3.0
642665
*
643-
* @param array $site
666+
* @param array<string, mixed> $site An array of site data.
644667
*/
645668
protected function site_states( $site ) {
646669
$site_states = array();

wp-includes/version.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
*
1717
* @global string $wp_version
1818
*/
19-
$wp_version = '7.0-alpha-61697';
19+
$wp_version = '7.0-alpha-61698';
2020

2121
/**
2222
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

0 commit comments

Comments
 (0)