X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/5aa86a9053fb0fa15846bb60aac2fb8fdfff524a..refs/tags/wordpress-4.0:/wp-admin/includes/class-wp-list-table.php diff --git a/wp-admin/includes/class-wp-list-table.php b/wp-admin/includes/class-wp-list-table.php index 446174d4..8d2bc51e 100644 --- a/wp-admin/includes/class-wp-list-table.php +++ b/wp-admin/includes/class-wp-list-table.php @@ -2,18 +2,11 @@ /** * Base class for displaying a list of items in an ajaxified HTML table. * - * @package WordPress - * @subpackage List_Table * @since 3.1.0 - */ - -/** - * Base class for displaying a list of items in an ajaxified HTML table. + * @access private * * @package WordPress * @subpackage List_Table - * @since 3.1.0 - * @access private */ class WP_List_Table { @@ -22,9 +15,9 @@ class WP_List_Table { * * @since 3.1.0 * @var array - * @access protected + * @access public */ - var $items; + public $items; /** * Various information about the current table @@ -33,7 +26,7 @@ class WP_List_Table { * @var array * @access private */ - var $_args; + private $_args; /** * Various information needed for displaying the pagination @@ -42,7 +35,7 @@ class WP_List_Table { * @var array * @access private */ - var $_pagination_args = array(); + private $_pagination_args = array(); /** * The current screen @@ -51,7 +44,7 @@ class WP_List_Table { * @var object * @access protected */ - var $screen; + protected $screen; /** * Cached bulk actions @@ -60,7 +53,7 @@ class WP_List_Table { * @var array * @access private */ - var $_actions; + private $_actions; /** * Cached pagination output @@ -69,27 +62,48 @@ class WP_List_Table { * @var string * @access private */ - var $_pagination; + private $_pagination; /** - * Constructor. The child class should call this constructor from it's own constructor + * Constructor. * - * @param array $args An associative array with information about the current table - * @access protected + * The child class should call this constructor from its own constructor to override + * the default $args. + * + * @since 3.1.0 + * @access public + * + * @param array|string $args { + * Array or string of arguments. + * + * @type string $plural Plural value used for labels and the objects being listed. + * This affects things such as CSS class-names and nonces used + * in the list table, e.g. 'posts'. Default empty. + * @type string $singular Singular label for an object being listed, e.g. 'post'. + * Default empty + * @type bool $ajax Whether the list table supports AJAX. This includes loading + * and sorting data, for example. If true, the class will call + * the {@see _js_vars()} method in the footer to provide variables + * to any scripts handling AJAX events. Default false. + * @type string $screen String containing the hook name used to determine the current + * screen. If left null, the current screen will be automatically set. + * Default null. + * } */ - function __construct( $args = array() ) { + public function __construct( $args = array() ) { $args = wp_parse_args( $args, array( 'plural' => '', 'singular' => '', - 'ajax' => false + 'ajax' => false, + 'screen' => null, ) ); - $screen = get_current_screen(); + $this->screen = convert_to_screen( $args['screen'] ); - add_filter( "manage_{$screen->id}_columns", array( &$this, 'get_columns' ), 0 ); + add_filter( "manage_{$this->screen->id}_columns", array( $this, 'get_columns' ), 0 ); if ( !$args['plural'] ) - $args['plural'] = $screen->base; + $args['plural'] = $this->screen->base; $args['plural'] = sanitize_key( $args['plural'] ); $args['singular'] = sanitize_key( $args['singular'] ); @@ -98,10 +112,76 @@ class WP_List_Table { if ( $args['ajax'] ) { // wp_enqueue_script( 'list-table' ); - add_action( 'admin_footer', array( &$this, '_js_vars' ) ); + add_action( 'admin_footer', array( $this, '_js_vars' ) ); } } + /** + * Make private properties readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to get. + * @return mixed Property. + */ + public function __get( $name ) { + return $this->$name; + } + + /** + * Make private properties settable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to set. + * @param mixed $value Property value. + * @return mixed Newly-set property. + */ + public function __set( $name, $value ) { + return $this->$name = $value; + } + + /** + * Make private properties checkable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to check if set. + * @return bool Whether the property is set. + */ + public function __isset( $name ) { + return isset( $this->$name ); + } + + /** + * Make private properties un-settable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param string $name Property to unset. + */ + public function __unset( $name ) { + unset( $this->$name ); + } + + /** + * Make private/protected methods readable for backwards compatibility. + * + * @since 4.0.0 + * @access public + * + * @param callable $name Method to call. + * @param array $arguments Arguments to pass when calling. + * @return mixed|bool Return value of the callback, false otherwise. + */ + public function __call( $name, $arguments ) { + return call_user_func_array( array( $this, $name ), $arguments ); + } + /** * Checks the current user's permissions * @uses wp_die() @@ -110,7 +190,7 @@ class WP_List_Table { * @access public * @abstract */ - function ajax_user_can() { + public function ajax_user_can() { die( 'function WP_List_Table::ajax_user_can() must be over-ridden in a sub-class.' ); } @@ -122,7 +202,7 @@ class WP_List_Table { * @access public * @abstract */ - function prepare_items() { + public function prepare_items() { die( 'function WP_List_Table::prepare_items() must be over-ridden in a sub-class.' ); } @@ -132,7 +212,7 @@ class WP_List_Table { * @param array $args An associative array with information about the pagination * @access protected */ - function set_pagination_args( $args ) { + protected function set_pagination_args( $args ) { $args = wp_parse_args( $args, array( 'total_items' => 0, 'total_pages' => 0, @@ -142,7 +222,7 @@ class WP_List_Table { if ( !$args['total_pages'] && $args['per_page'] > 0 ) $args['total_pages'] = ceil( $args['total_items'] / $args['per_page'] ); - // redirect if page number is invalid and headers are not already sent + // Redirect if page number is invalid and headers are not already sent. if ( ! headers_sent() && ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX ) && $args['total_pages'] > 0 && $this->get_pagenum() > $args['total_pages'] ) { wp_redirect( add_query_arg( 'paged', $args['total_pages'] ) ); exit; @@ -160,7 +240,7 @@ class WP_List_Table { * @param string $key * @return array */ - function get_pagination_arg( $key ) { + public function get_pagination_arg( $key ) { if ( 'page' == $key ) return $this->get_pagenum(); @@ -176,7 +256,7 @@ class WP_List_Table { * * @return bool */ - function has_items() { + public function has_items() { return !empty( $this->items ); } @@ -186,7 +266,7 @@ class WP_List_Table { * @since 3.1.0 * @access public */ - function no_items() { + public function no_items() { _e( 'No items found.' ); } @@ -199,7 +279,7 @@ class WP_List_Table { * @param string $text The search button text * @param string $input_id The search input id */ - function search_box( $text, $input_id ) { + public function search_box( $text, $input_id ) { if ( empty( $_REQUEST['s'] ) && !$this->has_items() ) return; @@ -209,10 +289,14 @@ class WP_List_Table { echo ''; if ( ! empty( $_REQUEST['order'] ) ) echo ''; + if ( ! empty( $_REQUEST['post_mime_type'] ) ) + echo ''; + if ( ! empty( $_REQUEST['detached'] ) ) + echo ''; ?> get_views(); - $views = apply_filters( 'views_' . $screen->id, $views ); + /** + * Filter the list of available list table views. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * @since 3.5.0 + * + * @param array $views An array of available list table views. + */ + $views = apply_filters( "views_{$this->screen->id}", $views ); if ( empty( $views ) ) return; @@ -263,7 +355,7 @@ class WP_List_Table { * * @return array */ - function get_bulk_actions() { + protected function get_bulk_actions() { return array(); } @@ -271,15 +363,27 @@ class WP_List_Table { * Display the bulk actions dropdown. * * @since 3.1.0 - * @access public + * @access protected + * + * @param string $which The location of the bulk actions: 'top' or 'bottom'. + * This is designated as optional for backwards-compatibility. */ - function bulk_actions() { - $screen = get_current_screen(); - + protected function bulk_actions( $which = '' ) { if ( is_null( $this->_actions ) ) { $no_new_actions = $this->_actions = $this->get_bulk_actions(); - // This filter can currently only be used to remove actions. - $this->_actions = apply_filters( 'bulk_actions-' . $screen->id, $this->_actions ); + /** + * Filter the list table Bulk Actions drop-down. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * This filter can currently only be used to remove bulk actions. + * + * @since 3.5.0 + * + * @param array $actions An array of the available bulk actions. + */ + $this->_actions = apply_filters( "bulk_actions-{$this->screen->id}", $this->_actions ); $this->_actions = array_intersect_assoc( $this->_actions, $no_new_actions ); $two = ''; } else { @@ -289,7 +393,8 @@ class WP_List_Table { if ( empty( $this->_actions ) ) return; - echo "\n"; echo "\n"; foreach ( $this->_actions as $name => $title ) { @@ -300,7 +405,7 @@ class WP_List_Table { echo "\n"; - submit_button( __( 'Apply' ), 'button-secondary action', false, false, array( 'id' => "doaction$two" ) ); + submit_button( __( 'Apply' ), 'action', false, false, array( 'id' => "doaction$two" ) ); echo "\n"; } @@ -312,7 +417,10 @@ class WP_List_Table { * * @return string|bool The action name or False if no action was selected */ - function current_action() { + public function current_action() { + if ( isset( $_REQUEST['filter_action'] ) && ! empty( $_REQUEST['filter_action'] ) ) + return false; + if ( isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] ) return $_REQUEST['action']; @@ -332,14 +440,14 @@ class WP_List_Table { * @param bool $always_visible Whether the actions should be always visible * @return string */ - function row_actions( $actions, $always_visible = false ) { + protected function row_actions( $actions, $always_visible = false ) { $action_count = count( $actions ); $i = 0; if ( !$action_count ) return ''; - $out = '
'; + $out = '
'; foreach ( $actions as $action => $link ) { ++$i; ( $i == $action_count ) ? $sep = '' : $sep = ' | '; @@ -356,7 +464,7 @@ class WP_List_Table { * @since 3.1.0 * @access protected */ - function months_dropdown( $post_type ) { + protected function months_dropdown( $post_type ) { global $wpdb, $wp_locale; $months = $wpdb->get_results( $wpdb->prepare( " @@ -366,6 +474,16 @@ class WP_List_Table { ORDER BY post_date DESC ", $post_type ) ); + /** + * Filter the 'Months' drop-down results. + * + * @since 3.7.0 + * + * @param object $months The months drop-down query results. + * @param string $post_type The post type. + */ + $months = apply_filters( 'months_dropdown_results', $months, $post_type ); + $month_count = count( $months ); if ( !$month_count || ( 1 == $month_count && 0 == $months[0]->month ) ) @@ -373,8 +491,9 @@ class WP_List_Table { $m = isset( $_GET['m'] ) ? (int) $_GET['m'] : 0; ?> - + value="0"> year ) @@ -386,7 +505,8 @@ class WP_List_Table { printf( "\n", selected( $m, $year . $month, false ), esc_attr( $arc_row->year . $month ), - $wp_locale->get_month( $month ) . " $year" + /* translators: 1: month name, 2: 4-digit year */ + sprintf( __( '%1$s %2$d' ), $wp_locale->get_month( $month ), $year ) ); } ?> @@ -400,7 +520,7 @@ class WP_List_Table { * @since 3.1.0 * @access protected */ - function view_switcher( $current_mode ) { + protected function view_switcher( $current_mode ) { $modes = array( 'list' => __( 'List View' ), 'excerpt' => __( 'Excerpt View' ) @@ -411,8 +531,15 @@ class WP_List_Table {
$title ) { - $class = ( $current_mode == $mode ) ? 'class="current"' : ''; - echo "$title\n"; + $classes = array( 'view-' . $mode ); + if ( $current_mode == $mode ) + $classes[] = 'current'; + printf( + "%s\n", + esc_url( add_query_arg( 'mode', $mode ) ), + implode( ' ', $classes ), + $title + ); } ?>
@@ -425,10 +552,10 @@ class WP_List_Table { * @since 3.1.0 * @access protected * - * @param int $post_id - * @param int $pending_comments + * @param int $post_id The post ID. + * @param int $pending_comments Number of pending comments. */ - function comments_bubble( $post_id, $pending_comments ) { + protected function comments_bubble( $post_id, $pending_comments ) { $pending_phrase = sprintf( __( '%s pending' ), number_format( $pending_comments ) ); if ( $pending_comments ) @@ -444,11 +571,11 @@ class WP_List_Table { * Get the current page number * * @since 3.1.0 - * @access protected + * @access public * * @return int */ - function get_pagenum() { + public function get_pagenum() { $pagenum = isset( $_REQUEST['paged'] ) ? absint( $_REQUEST['paged'] ) : 0; if( isset( $this->_pagination_args['total_pages'] ) && $pagenum > $this->_pagination_args['total_pages'] ) @@ -465,11 +592,23 @@ class WP_List_Table { * * @return int */ - function get_items_per_page( $option, $default = 20 ) { + protected function get_items_per_page( $option, $default = 20 ) { $per_page = (int) get_user_option( $option ); if ( empty( $per_page ) || $per_page < 1 ) $per_page = $default; + /** + * Filter the number of items to be displayed on each page of the list table. + * + * The dynamic hook name, $option, refers to the per page option depending + * on the type of list table in use. Possible values may include: + * 'edit_comments_per_page', 'sites_network_per_page', 'site_themes_network_per_page', + * 'themes_netework_per_page', 'users_network_per_page', 'edit_{$post_type}', etc. + * + * @since 2.9.0 + * + * @param int $per_page Number of items to be displayed. Default 20. + */ return (int) apply_filters( $option, $per_page ); } @@ -479,28 +618,35 @@ class WP_List_Table { * @since 3.1.0 * @access protected */ - function pagination( $which ) { - if ( empty( $this->_pagination_args ) ) + protected function pagination( $which ) { + if ( empty( $this->_pagination_args ) ) { return; + } - extract( $this->_pagination_args ); + $total_items = $this->_pagination_args['total_items']; + $total_pages = $this->_pagination_args['total_pages']; + $infinite_scroll = false; + if ( isset( $this->_pagination_args['infinite_scroll'] ) ) { + $infinite_scroll = $this->_pagination_args['infinite_scroll']; + } $output = '' . sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) ) . ''; $current = $this->get_pagenum(); - $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; + $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); $current_url = remove_query_arg( array( 'hotkeys_highlight_last', 'hotkeys_highlight_first' ), $current_url ); $page_links = array(); $disable_first = $disable_last = ''; - if ( $current == 1 ) + if ( $current == 1 ) { $disable_first = ' disabled'; - if ( $current == $total_pages ) + } + if ( $current == $total_pages ) { $disable_last = ' disabled'; - + } $page_links[] = sprintf( "%s", 'first-page' . $disable_first, esc_attr__( 'Go to the first page' ), @@ -515,16 +661,16 @@ class WP_List_Table { '‹' ); - if ( 'bottom' == $which ) + if ( 'bottom' == $which ) { $html_current_page = $current; - else - $html_current_page = sprintf( "", + } else { + $html_current_page = sprintf( "%s", + '', esc_attr__( 'Current page' ), - esc_attr( 'paged' ), $current, strlen( $total_pages ) ); - + } $html_total_pages = sprintf( "%s", number_format_i18n( $total_pages ) ); $page_links[] = '' . sprintf( _x( '%1$s of %2$s', 'paging' ), $html_current_page, $html_total_pages ) . ''; @@ -542,13 +688,17 @@ class WP_List_Table { '»' ); - $output .= "\n" . join( "\n", $page_links ) . ''; + $pagination_links_class = 'pagination-links'; + if ( ! empty( $infinite_scroll ) ) { + $pagination_links_class = ' hide-if-js'; + } + $output .= "\n" . join( "\n", $page_links ) . ''; - if ( $total_pages ) + if ( $total_pages ) { $page_class = $total_pages < 2 ? ' one-page' : ''; - else + } else { $page_class = ' no-pages'; - + } $this->_pagination = "
$output
"; echo $this->_pagination; @@ -559,12 +709,12 @@ class WP_List_Table { * 'internal-name' => 'Title' * * @since 3.1.0 - * @access protected + * @access public * @abstract * * @return array */ - function get_columns() { + public function get_columns() { die( 'function WP_List_Table::get_columns() must be over-ridden in a sub-class.' ); } @@ -581,7 +731,7 @@ class WP_List_Table { * * @return array */ - function get_sortable_columns() { + protected function get_sortable_columns() { return array(); } @@ -593,16 +743,25 @@ class WP_List_Table { * * @return array */ - function get_column_info() { + protected function get_column_info() { if ( isset( $this->_column_headers ) ) return $this->_column_headers; - $screen = get_current_screen(); - - $columns = get_column_headers( $screen ); - $hidden = get_hidden_columns( $screen ); - - $_sortable = apply_filters( "manage_{$screen->id}_sortable_columns", $this->get_sortable_columns() ); + $columns = get_column_headers( $this->screen ); + $hidden = get_hidden_columns( $this->screen ); + + $sortable_columns = $this->get_sortable_columns(); + /** + * Filter the list table sortable columns for a specific screen. + * + * The dynamic portion of the hook name, $this->screen->id, refers + * to the ID of the current screen, usually a string. + * + * @since 3.5.0 + * + * @param array $sortable_columns An array of sortable columns. + */ + $_sortable = apply_filters( "manage_{$this->screen->id}_sortable_columns", $sortable_columns ); $sortable = array(); foreach ( $_sortable as $id => $data ) { @@ -629,7 +788,7 @@ class WP_List_Table { * * @return int */ - function get_column_count() { + public function get_column_count() { list ( $columns, $hidden ) = $this->get_column_info(); $hidden = array_intersect( array_keys( $columns ), array_filter( $hidden ) ); return count( $columns ) - count( $hidden ); @@ -639,16 +798,14 @@ class WP_List_Table { * Print column headers, accounting for hidden and sortable columns. * * @since 3.1.0 - * @access protected + * @access public * * @param bool $with_id Whether to set the id attribute or not */ - function print_column_headers( $with_id = true ) { - $screen = get_current_screen(); - + public function print_column_headers( $with_id = true ) { list( $columns, $hidden, $sortable ) = $this->get_column_info(); - $current_url = ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']; + $current_url = set_url_scheme( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); $current_url = remove_query_arg( 'paged', $current_url ); if ( isset( $_GET['orderby'] ) ) @@ -661,6 +818,13 @@ class WP_List_Table { else $current_order = 'asc'; + if ( ! empty( $columns['cb'] ) ) { + static $cb_counter = 1; + $columns['cb'] = '' + . ''; + $cb_counter++; + } + foreach ( $columns as $column_key => $column_display_name ) { $class = array( 'manage-column', "column-$column_key" ); @@ -706,13 +870,13 @@ class WP_List_Table { * @since 3.1.0 * @access public */ - function display() { - extract( $this->_args ); + public function display() { + $singular = $this->_args['singular']; $this->display_tablenav( 'top' ); ?> - +
print_column_headers(); ?> @@ -725,7 +889,10 @@ class WP_List_Table { - > + > display_rows_or_placeholder(); ?>
@@ -741,7 +908,7 @@ class WP_List_Table { * * @return array */ - function get_table_classes() { + protected function get_table_classes() { return array( 'widefat', 'fixed', $this->_args['plural'] ); } @@ -751,13 +918,13 @@ class WP_List_Table { * @since 3.1.0 * @access protected */ - function display_tablenav( $which ) { + protected function display_tablenav( $which ) { if ( 'top' == $which ) wp_nonce_field( 'bulk-' . $this->_args['plural'] ); ?>
-
+
bulk_actions( $which ); ?>
part of the table * * @since 3.1.0 - * @access protected + * @access public */ - function display_rows_or_placeholder() { + public function display_rows_or_placeholder() { if ( $this->has_items() ) { $this->display_rows(); } else { - list( $columns, $hidden ) = $this->get_column_info(); echo ''; $this->no_items(); echo ''; @@ -799,9 +965,9 @@ class WP_List_Table { * Generate the table rows * * @since 3.1.0 - * @access protected + * @access public */ - function display_rows() { + public function display_rows() { foreach ( $this->items as $item ) $this->single_row( $item ); } @@ -810,16 +976,16 @@ class WP_List_Table { * Generates content for a single row of the table * * @since 3.1.0 - * @access protected + * @access public * * @param object $item The current item */ - function single_row( $item ) { + public function single_row( $item ) { static $row_class = ''; $row_class = ( $row_class == '' ? ' class="alternate"' : '' ); echo ''; - echo $this->single_row_columns( $item ); + $this->single_row_columns( $item ); echo ''; } @@ -831,7 +997,7 @@ class WP_List_Table { * * @param object $item The current item */ - function single_row_columns( $item ) { + protected function single_row_columns( $item ) { list( $columns, $hidden ) = $this->get_column_info(); foreach ( $columns as $column_name => $column_display_name ) { @@ -850,7 +1016,7 @@ class WP_List_Table { } elseif ( method_exists( $this, 'column_' . $column_name ) ) { echo ""; - echo call_user_func( array( &$this, 'column_' . $column_name ), $item ); + echo call_user_func( array( $this, 'column_' . $column_name ), $item ); echo ""; } else { @@ -867,28 +1033,29 @@ class WP_List_Table { * @since 3.1.0 * @access public */ - function ajax_response() { + public function ajax_response() { $this->prepare_items(); - extract( $this->_args ); - extract( $this->_pagination_args ); - ob_start(); - if ( ! empty( $_REQUEST['no_placeholder'] ) ) + if ( ! empty( $_REQUEST['no_placeholder'] ) ) { $this->display_rows(); - else + } else { $this->display_rows_or_placeholder(); + } $rows = ob_get_clean(); $response = array( 'rows' => $rows ); - if ( isset( $total_items ) ) - $response['total_items_i18n'] = sprintf( _n( '1 item', '%s items', $total_items ), number_format_i18n( $total_items ) ); - - if ( isset( $total_pages ) ) { - $response['total_pages'] = $total_pages; - $response['total_pages_i18n'] = number_format_i18n( $total_pages ); + if ( isset( $this->_pagination_args['total_items'] ) ) { + $response['total_items_i18n'] = sprintf( + _n( '1 item', '%s items', $this->_pagination_args['total_items'] ), + number_format_i18n( $this->_pagination_args['total_items'] ) + ); + } + if ( isset( $this->_pagination_args['total_pages'] ) ) { + $response['total_pages'] = $this->_pagination_args['total_pages']; + $response['total_pages_i18n'] = number_format_i18n( $this->_pagination_args['total_pages'] ); } die( json_encode( $response ) ); @@ -897,20 +1064,17 @@ class WP_List_Table { /** * Send required variables to JavaScript land * - * @access private + * @access public */ - function _js_vars() { - $current_screen = get_current_screen(); - + public function _js_vars() { $args = array( 'class' => get_class( $this ), 'screen' => array( - 'id' => $current_screen->id, - 'base' => $current_screen->base, + 'id' => $this->screen->id, + 'base' => $this->screen->base, ) ); printf( "\n", json_encode( $args ) ); } } -?>