From 8bcf53cc68981f82e1ac25733d2be2722968b887 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Sun, 31 May 2015 01:29:26 +0000 Subject: [PATCH] Fix formatting and add missing return descriptions for inline documenation introduced in [32644] for `WP_List_Table`. Also fixes an error introduced in [32661] for `WP_Links_List_Table`. See #25408. See #32246. Built from https://develop.svn.wordpress.org/trunk@32662 git-svn-id: http://core.svn.wordpress.org/trunk@32632 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- .../includes/class-wp-links-list-table.php | 3 ++- wp-admin/includes/class-wp-list-table.php | 25 ++++++++++--------- wp-includes/version.php | 2 +- 3 files changed, 16 insertions(+), 14 deletions(-) diff --git a/wp-admin/includes/class-wp-links-list-table.php b/wp-admin/includes/class-wp-links-list-table.php index 471a877ed1..2a5ce13395 100644 --- a/wp-admin/includes/class-wp-links-list-table.php +++ b/wp-admin/includes/class-wp-links-list-table.php @@ -144,6 +144,7 @@ class WP_Links_List_Table extends WP_List_Table { * * @since 4.3.0 * @access protected + * * @return string Name of the default primary column, in this case, 'name'. */ protected function get_default_primary_column_name() { @@ -250,7 +251,7 @@ class WP_Links_List_Table extends WP_List_Table { } /** - * Generate and display row actions for links. + * Generate and display row actions links. * * @since 4.3.0 * @access protected diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php index 1dbeed6490..c58b11c487 100644 --- a/wp-admin/includes/class-wp-list-table.php +++ b/wp-admin/includes/class-wp-list-table.php @@ -797,35 +797,37 @@ class WP_List_Table { } /** - * Get name of default primary column + * Get the name of the default primary column. * * @since 4.3.0 * @access protected * - * @return string + * @return string Name of the default primary column, in this case, an empty string. */ protected function get_default_primary_column_name() { return ''; } /** - * Get name of primary column. + * Get the name of the primary column. * * @since 4.3.0 * @access protected * - * @return string Filtered name of primary column + * @return string The name of the primary column. */ protected function get_primary_column_name() { $columns = $this->get_columns(); $default = $this->get_default_primary_column_name(); + /** - * Filter the name of the primary column for the current list table, with context as argument (eg: 'plugins'). + * Filter the name of the primary column for the current list table, with context + * as argument (eg: 'plugins'). * * @since 4.3.0 * - * @param string $default Column name default for the specific list table (eg: 'name') - * @param string $context Screen ID for specific list table (eg: 'plugins') + * @param string $default Column name default for the specific list table, e.g. 'name'. + * @param string $context Screen ID for specific list table, e.g. 'plugins'. */ $column = apply_filters( 'list_table_primary_column', $default, $this->screen->id ); @@ -1156,11 +1158,10 @@ class WP_List_Table { * @since 4.3.0 * @access protected * - * @param object $item Item being acted upon - * @param string $column_name Current column name - * @param string $primary Primary column name - * - * @return string + * @param object $item The item being acted upon. + * @param string $column_name Current column name. + * @param string $primary Primary column name. + * @return string The row actions output. In this case, an empty string. */ protected function handle_row_actions( $item, $column_name, $primary ) { return ''; diff --git a/wp-includes/version.php b/wp-includes/version.php index 3cb9d4ba13..05bc035b78 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.3-alpha-32661'; +$wp_version = '4.3-alpha-32662'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.