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.


git-svn-id: https://develop.svn.wordpress.org/trunk@32662 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2015-05-31 01:28:28 +00:00
parent 3725befcd8
commit e3077edcad
2 changed files with 15 additions and 13 deletions

View File

@ -144,6 +144,7 @@ class WP_Links_List_Table extends WP_List_Table {
* *
* @since 4.3.0 * @since 4.3.0
* @access protected * @access protected
*
* @return string Name of the default primary column, in this case, 'name'. * @return string Name of the default primary column, in this case, 'name'.
*/ */
protected function get_default_primary_column_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 * @since 4.3.0
* @access protected * @access protected

View File

@ -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 * @since 4.3.0
* @access protected * @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() { protected function get_default_primary_column_name() {
return ''; return '';
} }
/** /**
* Get name of primary column. * Get the name of the primary column.
* *
* @since 4.3.0 * @since 4.3.0
* @access protected * @access protected
* *
* @return string Filtered name of primary column * @return string The name of the primary column.
*/ */
protected function get_primary_column_name() { protected function get_primary_column_name() {
$columns = $this->get_columns(); $columns = $this->get_columns();
$default = $this->get_default_primary_column_name(); $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 * @since 4.3.0
* *
* @param string $default Column name default for the specific list table (eg: 'name') * @param string $default Column name default for the specific list table, e.g. 'name'.
* @param string $context Screen ID for specific list table (eg: 'plugins') * @param string $context Screen ID for specific list table, e.g. 'plugins'.
*/ */
$column = apply_filters( 'list_table_primary_column', $default, $this->screen->id ); $column = apply_filters( 'list_table_primary_column', $default, $this->screen->id );
@ -1156,11 +1158,10 @@ class WP_List_Table {
* @since 4.3.0 * @since 4.3.0
* @access protected * @access protected
* *
* @param object $item Item being acted upon * @param object $item The item being acted upon.
* @param string $column_name Current column name * @param string $column_name Current column name.
* @param string $primary Primary column name * @param string $primary Primary column name.
* * @return string The row actions output. In this case, an empty string.
* @return string
*/ */
protected function handle_row_actions( $item, $column_name, $primary ) { protected function handle_row_actions( $item, $column_name, $primary ) {
return ''; return '';