wp/wp-admin/includes/list-table.php
author ymh <ymh.work@gmail.com>
Wed, 06 Nov 2013 03:21:17 +0000
changeset 0 d970ebf37754
child 5 5e2f62d02dcd
permissions -rw-r--r--
first import
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     1
<?php
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     2
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     3
 * Helper functions for displaying a list of items in an ajaxified HTML table.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     4
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     5
 * @package WordPress
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     6
 * @subpackage List_Table
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     7
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     8
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
     9
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    10
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    11
 * Fetch an instance of a WP_List_Table class.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    12
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    13
 * @access private
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    14
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    15
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    16
 * @param string $class The type of the list table, which is the class name.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    17
 * @param array $args Optional. Arguments to pass to the class. Accepts 'screen'.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    18
 * @return object|bool Object on success, false if the class does not exist.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    19
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    20
function _get_list_table( $class, $args = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    21
	$core_classes = array(
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    22
		//Site Admin
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    23
		'WP_Posts_List_Table' => 'posts',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    24
		'WP_Media_List_Table' => 'media',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    25
		'WP_Terms_List_Table' => 'terms',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    26
		'WP_Users_List_Table' => 'users',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    27
		'WP_Comments_List_Table' => 'comments',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    28
		'WP_Post_Comments_List_Table' => 'comments',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    29
		'WP_Links_List_Table' => 'links',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    30
		'WP_Plugin_Install_List_Table' => 'plugin-install',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    31
		'WP_Themes_List_Table' => 'themes',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    32
		'WP_Theme_Install_List_Table' => array( 'themes', 'theme-install' ),
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    33
		'WP_Plugins_List_Table' => 'plugins',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    34
		// Network Admin
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    35
		'WP_MS_Sites_List_Table' => 'ms-sites',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    36
		'WP_MS_Users_List_Table' => 'ms-users',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    37
		'WP_MS_Themes_List_Table' => 'ms-themes',
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    38
	);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    39
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    40
	if ( isset( $core_classes[ $class ] ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    41
		foreach ( (array) $core_classes[ $class ] as $required )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    42
			require_once( ABSPATH . 'wp-admin/includes/class-wp-' . $required . '-list-table.php' );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    43
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    44
		if ( isset( $args['screen'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    45
			$args['screen'] = convert_to_screen( $args['screen'] );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    46
		elseif ( isset( $GLOBALS['hook_suffix'] ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    47
			$args['screen'] = get_current_screen();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    48
		else
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    49
			$args['screen'] = null;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    50
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    51
		return new $class( $args );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    52
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    53
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    54
	return false;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    55
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    56
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    57
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    58
 * Register column headers for a particular screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    59
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    60
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    61
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    62
 * @param string $screen The handle for the screen to add help to. This is usually the hook name returned by the add_*_page() functions.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    63
 * @param array $columns An array of columns with column IDs as the keys and translated column names as the values
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    64
 * @see get_column_headers(), print_column_headers(), get_hidden_columns()
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    65
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    66
function register_column_headers($screen, $columns) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    67
	$wp_list_table = new _WP_List_Table_Compat($screen, $columns);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    68
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    69
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    70
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    71
 * Prints column headers for a particular screen.
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    72
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    73
 * @since 2.7.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    74
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    75
function print_column_headers($screen, $id = true) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    76
	$wp_list_table = new _WP_List_Table_Compat($screen);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    77
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    78
	$wp_list_table->print_column_headers($id);
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    79
}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    80
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    81
/**
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    82
 * Helper class to be used only by back compat functions
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    83
 *
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    84
 * @since 3.1.0
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    85
 */
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    86
class _WP_List_Table_Compat extends WP_List_Table {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    87
	var $_screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    88
	var $_columns;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    89
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    90
	function _WP_List_Table_Compat( $screen, $columns = array() ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    91
		if ( is_string( $screen ) )
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    92
			$screen = convert_to_screen( $screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    93
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    94
		$this->_screen = $screen;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    95
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    96
		if ( !empty( $columns ) ) {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    97
			$this->_columns = $columns;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    98
			add_filter( 'manage_' . $screen->id . '_columns', array( $this, 'get_columns' ), 0 );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
    99
		}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   100
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   101
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   102
	function get_column_info() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   103
		$columns = get_column_headers( $this->_screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   104
		$hidden = get_hidden_columns( $this->_screen );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   105
		$sortable = array();
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   106
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   107
		return array( $columns, $hidden, $sortable );
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   108
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   109
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   110
	function get_columns() {
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   111
		return $this->_columns;
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   112
	}
d970ebf37754 first import
ymh <ymh.work@gmail.com>
parents:
diff changeset
   113
}