WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve various `@param` docs for List Tables. 

See #30224.

Built from https://develop.svn.wordpress.org/trunk@30679


git-svn-id: http://core.svn.wordpress.org/trunk@30669 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2014-12-01 00:33:23 +00:00
parent da4c39480f
commit 65ab522a51
11 changed files with 172 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
wp-admin/includes/class-wp-list-table.php
View File

@ -479,6 +479,8 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
*
* @param string $post_type
*/
protected function months_dropdown( $post_type ) {
global $wpdb, $wp_locale;
@ -535,6 +537,8 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
*
* @param string $current_mode
*/
protected function view_switcher( $current_mode ) {
?>
@ -601,6 +605,8 @@ class WP_List_Table {
* @since 3.1.0
* @access protected
*
* @param string $option
* @param int $default
* @return int
*/
protected function get_items_per_page( $option, $default = 20 ) {
@ -629,6 +635,8 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
*
* @param string $which
*/
protected function pagination( $which ) {
if ( empty( $this->_pagination_args ) ) {
@ -929,6 +937,7 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
* @param string $which
*/
protected function display_tablenav( $which ) {
if ( 'top' == $which )
@ -954,6 +963,8 @@ class WP_List_Table {
*
* @since 3.1.0
* @access protected
*
* @param string $which
*/
protected function extra_tablenav( $which ) {}

12
wp-admin/includes/class-wp-media-list-table.php
View File

@ -104,6 +104,9 @@ class WP_Media_List_Table extends WP_List_Table {
return $actions;
}
/**
* @param string $which
*/
protected function extra_tablenav( $which ) {
if ( 'bar' !== $which ) {
return;
@ -146,9 +149,10 @@ class WP_Media_List_Table extends WP_List_Table {
_e( 'No media attachments found.' );
}
/**
* @param string $which
*/
protected function pagination( $which ) {
global $mode;
parent::pagination( $which );
}
@ -493,6 +497,10 @@ foreach ( $columns as $column_name => $column_display_name ) {
<?php endwhile;
}
/**
* @param WP_Post $post
* @param string $att_title
*/
private function _get_row_actions( $post, $att_title ) {
$actions = array();

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

@ -146,6 +146,9 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
return $actions;
}
/**
* @param string $which
*/
protected function pagination( $which ) {
global $mode;

19
wp-admin/includes/class-wp-ms-themes-list-table.php
View File

@ -142,6 +142,11 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
) );
}
/**
* @staticvar string $term
* @param WP_Theme $theme
* @return bool
*/
public function _search_callback( $theme ) {
static $term;
if ( is_null( $term ) )
@ -163,6 +168,13 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
}
// Not used by any core columns.
/**
* @global string $orderby
* @global string $order
* @param array $theme_a
* @param array $theme_b
* @return int
*/
public function _order_callback( $theme_a, $theme_b ) {
global $orderby, $order;
@ -266,6 +278,13 @@ class WP_MS_Themes_List_Table extends WP_List_Table {
$this->single_row( $theme );
}
/**
* @global string $status
* @global int $page
* @global string $s
* @global array $totals
* @param WP_Theme $theme
*/
public function single_row( $theme ) {
global $status, $page, $s, $totals;

4
wp-admin/includes/class-wp-ms-users-list-table.php
View File

@ -102,6 +102,10 @@ class WP_MS_Users_List_Table extends WP_List_Table {
return $role_links;
}
/**
* @global string $mode
* @param string $which
*/
protected function pagination( $which ) {
global $mode;

8
wp-admin/includes/class-wp-plugin-install-list-table.php
View File

@ -268,6 +268,9 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
$this->display_tablenav( 'bottom' );
}
/**
* @param string $which
*/
protected function display_tablenav( $which ) {
if ( $GLOBALS['tab'] === 'featured' ) {
return;
@ -306,6 +309,11 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
return array();
}
/**
* @param object $plugin_a
* @param object $plugin_b
* @return int
*/
private function order_callback( $plugin_a, $plugin_b ) {
$orderby = $this->orderby;
if ( ! isset( $plugin_a->$orderby, $plugin_b->$orderby ) ) {

29
wp-admin/includes/class-wp-plugins-list-table.php
View File

@ -191,6 +191,11 @@ class WP_Plugins_List_Table extends WP_List_Table {
) );
}
/**
* @staticvar string $term
* @param array $plugin
* @return boolean
*/
public function _search_callback( $plugin ) {
static $term;
if ( is_null( $term ) )
@ -205,6 +210,13 @@ class WP_Plugins_List_Table extends WP_List_Table {
return false;
}
/**
* @global string $orderby
* @global string $order
* @param array $plugin_a
* @param array $plugin_b
* @return int
*/
public function _order_callback( $plugin_a, $plugin_b ) {
global $orderby, $order;
@ -308,6 +320,11 @@ class WP_Plugins_List_Table extends WP_List_Table {
return $actions;
}
/**
* @global string $status
* @param string $which
* @return null
*/
public function bulk_actions( $which = '' ) {
global $status;
@ -317,6 +334,11 @@ class WP_Plugins_List_Table extends WP_List_Table {
parent::bulk_actions( $which );
}
/**
* @global string $status
* @param string $which
* @return null
*/
protected function extra_tablenav( $which ) {
global $status;
@ -352,6 +374,13 @@ class WP_Plugins_List_Table extends WP_List_Table {
$this->single_row( array( $plugin_file, $plugin_data ) );
}
/**
* @global string $status
* @global int $page
* @global string $s
* @global array $totals
* @param array $item
*/
public function single_row( $item ) {
global $status, $page, $s, $totals;

32
wp-admin/includes/class-wp-posts-list-table.php
View File

@ -217,6 +217,10 @@ class WP_Posts_List_Table extends WP_List_Table {
return $actions;
}
/**
* @global int $cat
* @param string $which
*/
protected function extra_tablenav( $which ) {
global $cat;
?>
@ -268,6 +272,10 @@ class WP_Posts_List_Table extends WP_List_Table {
return parent::current_action();
}
/**
* @global string $mode
* @param string $which
*/
protected function pagination( $which ) {
global $mode;
@ -375,6 +383,12 @@ class WP_Posts_List_Table extends WP_List_Table {
);
}
/**
* @global WP_Query $wp_query
* @global int $per_page
* @param array $posts
* @param int $level
*/
public function display_rows( $posts = array(), $level = 0 ) {
global $wp_query, $per_page;
@ -390,6 +404,11 @@ class WP_Posts_List_Table extends WP_List_Table {
}
}
/**
* @global string $mode
* @param array $posts
* @param int $level
*/
private function _display_rows( $posts, $level = 0 ) {
global $mode;
@ -405,6 +424,13 @@ class WP_Posts_List_Table extends WP_List_Table {
$this->single_row( $post, $level );
}
/**
* @global wpdb $wpdb
* @param array $pages
* @param int $pagenum
* @param int $per_page
* @return bool|null
*/
private function _display_rows_hierarchical( $pages, $pagenum = 1, $per_page = 20 ) {
global $wpdb;
@ -542,6 +568,12 @@ class WP_Posts_List_Table extends WP_List_Table {
unset( $children_pages[$parent] ); //required in order to keep track of orphans
}
/**
* @global string $mode
* @staticvar string $alternate
* @param WP_Post $post
* @param int $level
*/
public function single_row( $post, $level = 0 ) {
global $mode;
static $alternate;

45
wp-admin/includes/class-wp-terms-list-table.php
View File

@ -202,6 +202,16 @@ class WP_Terms_List_Table extends WP_List_Table {
}
}
/**
* @param string $taxonomy
* @param array $terms
* @param array $children
* @param int $start
* @param int $per_page
* @param int $count
* @param int $parent
* @param int $level
*/
private function _rows( $taxonomy, $terms, &$children, $start, $per_page, &$count, $parent = 0, $level = 0 ) {
$end = $start + $per_page;
@ -250,6 +260,12 @@ class WP_Terms_List_Table extends WP_List_Table {
}
}
/**
* @global string $taxonomy
* @staticvar string $row_class
* @param object $tag
* @param int $level
*/
public function single_row( $tag, $level = 0 ) {
global $taxonomy;
$tag = sanitize_term( $tag, $taxonomy );
@ -264,6 +280,10 @@ class WP_Terms_List_Table extends WP_List_Table {
echo '</tr>';
}
/**
* @param object $tag
* @return string
*/
public function column_cb( $tag ) {
$default_term = get_option( 'default_' . $this->screen->taxonomy );
@ -274,6 +294,10 @@ class WP_Terms_List_Table extends WP_List_Table {
return '&nbsp;';
}
/**
* @param object $tag
* @return string
*/
public function column_name( $tag ) {
$taxonomy = $this->screen->taxonomy;
$tax = get_taxonomy( $taxonomy );
@ -348,15 +372,27 @@ class WP_Terms_List_Table extends WP_List_Table {
return $out;
}
/**
* @param object $tag
* @return string
*/
public function column_description( $tag ) {
return $tag->description;
}
/**
* @param object $tag
* @return string
*/
public function column_slug( $tag ) {
/** This filter is documented in wp-admin/edit-tag-form.php */
return apply_filters( 'editable_slug', $tag->slug );
}
/**
* @param object $tag
* @return string
*/
public function column_posts( $tag ) {
$count = number_format_i18n( $tag->count );
@ -381,6 +417,10 @@ class WP_Terms_List_Table extends WP_List_Table {
return "<a href='" . esc_url ( add_query_arg( $args, 'edit.php' ) ) . "'>$count</a>";
}
/**
* @param object $tag
* @return string
*/
public function column_links( $tag ) {
$count = number_format_i18n( $tag->count );
if ( $count )
@ -388,6 +428,11 @@ class WP_Terms_List_Table extends WP_List_Table {
return $count;
}
/**
* @param object $tag
* @param string $column_name
* @return string
*/
public function column_default( $tag, $column_name ) {
/**
* Filter the displayed columns in the terms list table.

10
wp-admin/includes/class-wp-themes-list-table.php
View File

@ -95,6 +95,10 @@ class WP_Themes_List_Table extends WP_List_Table {
printf( __( 'Only the current theme is available to you. Contact the %s administrator for information about accessing additional themes.' ), get_site_option( 'site_name' ) );
}
/**
* @param string $which
* @return null
*/
public function tablenav( $which = 'top' ) {
if ( $this->get_pagination_arg( 'total_pages' ) <= 1 )
return;
@ -219,6 +223,10 @@ class WP_Themes_List_Table extends WP_List_Table {
endforeach;
}
/**
* @param WP_Theme $theme
* @return bool
*/
public function search_theme( $theme ) {
// Search the features
foreach ( $this->features as $word ) {
@ -255,6 +263,8 @@ class WP_Themes_List_Table extends WP_List_Table {
*
* @since 3.4.0
* @access public
*
* @param array $extra_args
*/
public function _js_vars( $extra_args = array() ) {
$search_string = isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '4.1-beta2-30678';
$wp_version = '4.1-beta2-30679';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.