From 65ec343e0bf296f30ac2e60df7dc69c4380c4631 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sun, 29 Sep 2019 11:03:14 +0000 Subject: [PATCH] Docs: Improve documentation for `::display()` methods in various list tables. Props itowhid06. Fixes #47947. git-svn-id: https://develop.svn.wordpress.org/trunk@46341 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-comments-list-table.php | 4 +++- src/wp-admin/includes/class-wp-list-table.php | 2 +- .../includes/class-wp-plugin-install-list-table.php | 6 +++++- src/wp-admin/includes/class-wp-theme-install-list-table.php | 5 +++++ src/wp-admin/includes/class-wp-themes-list-table.php | 5 +++++ 5 files changed, 19 insertions(+), 3 deletions(-) diff --git a/src/wp-admin/includes/class-wp-comments-list-table.php b/src/wp-admin/includes/class-wp-comments-list-table.php index 8abbbdcb06..73da78ccd8 100644 --- a/src/wp-admin/includes/class-wp-comments-list-table.php +++ b/src/wp-admin/includes/class-wp-comments-list-table.php @@ -487,7 +487,9 @@ class WP_Comments_List_Table extends WP_List_Table { } /** - * Display the comments table. Override the parent method to render extra comments. + * Displays the comments table. + * + * Overrides the parent display() method to render extra comments. * * @since 3.1.0 */ diff --git a/src/wp-admin/includes/class-wp-list-table.php b/src/wp-admin/includes/class-wp-list-table.php index e5d12ceae9..cf0c05c2ab 100644 --- a/src/wp-admin/includes/class-wp-list-table.php +++ b/src/wp-admin/includes/class-wp-list-table.php @@ -1173,7 +1173,7 @@ class WP_List_Table { } /** - * Display the table + * Displays the table. * * @since 3.1.0 */ diff --git a/src/wp-admin/includes/class-wp-plugin-install-list-table.php b/src/wp-admin/includes/class-wp-plugin-install-list-table.php index 89149daf86..acea5c4b28 100644 --- a/src/wp-admin/includes/class-wp-plugin-install-list-table.php +++ b/src/wp-admin/includes/class-wp-plugin-install-list-table.php @@ -333,7 +333,11 @@ class WP_Plugin_Install_List_Table extends WP_List_Table { } /** - * Override the parent display() so we can provide a different container. + * Displays the plugin install table. + * + * Overrides the parent display() method to provide a different container. + * + * @since 4.0.0 */ public function display() { $singular = $this->_args['singular']; diff --git a/src/wp-admin/includes/class-wp-theme-install-list-table.php b/src/wp-admin/includes/class-wp-theme-install-list-table.php index ed6e12c381..637785f392 100644 --- a/src/wp-admin/includes/class-wp-theme-install-list-table.php +++ b/src/wp-admin/includes/class-wp-theme-install-list-table.php @@ -187,6 +187,11 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table { } /** + * Displays the theme install table. + * + * Overrides the parent display() method to provide a different container. + * + * @since 3.1.0 */ public function display() { wp_nonce_field( 'fetch-list-' . get_class( $this ), '_ajax_fetch_list_nonce' ); diff --git a/src/wp-admin/includes/class-wp-themes-list-table.php b/src/wp-admin/includes/class-wp-themes-list-table.php index fa0addab9e..1e600cb632 100644 --- a/src/wp-admin/includes/class-wp-themes-list-table.php +++ b/src/wp-admin/includes/class-wp-themes-list-table.php @@ -151,6 +151,11 @@ class WP_Themes_List_Table extends WP_List_Table { } /** + * Displays the themes table. + * + * Overrides the parent display() method to provide a different container. + * + * @since 3.1.0 */ public function display() { wp_nonce_field( 'fetch-list-' . get_class( $this ), '_ajax_fetch_list_nonce' );