<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[15958] trunk/wp-admin/includes: phpdoc for the various list table includes
.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/15958">15958</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2010-10-25 04:04:18 +0000 (Mon, 25 Oct 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>phpdoc for the various list table includes. see <a href="http://trac.wordpress.org/ticket/14579">#14579</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesclasswplisttablephp">trunk/wp-admin/includes/class-wp-list-table.php</a></li>
<li><a href="#trunkwpadminincludeslisttablecommentsphp">trunk/wp-admin/includes/list-table-comments.php</a></li>
<li><a href="#trunkwpadminincludeslisttablelinksphp">trunk/wp-admin/includes/list-table-links.php</a></li>
<li><a href="#trunkwpadminincludeslisttablemediaphp">trunk/wp-admin/includes/list-table-media.php</a></li>
<li><a href="#trunkwpadminincludeslisttablemsusersphp">trunk/wp-admin/includes/list-table-ms-users.php</a></li>
<li><a href="#trunkwpadminincludeslisttableplugininstallphp">trunk/wp-admin/includes/list-table-plugin-install.php</a></li>
<li><a href="#trunkwpadminincludeslisttablepluginsphp">trunk/wp-admin/includes/list-table-plugins.php</a></li>
<li><a href="#trunkwpadminincludeslisttablepostsphp">trunk/wp-admin/includes/list-table-posts.php</a></li>
<li><a href="#trunkwpadminincludeslisttablesitesphp">trunk/wp-admin/includes/list-table-sites.php</a></li>
<li><a href="#trunkwpadminincludeslisttabletermsphp">trunk/wp-admin/includes/list-table-terms.php</a></li>
<li><a href="#trunkwpadminincludeslisttablethemeinstallphp">trunk/wp-admin/includes/list-table-theme-install.php</a></li>
<li><a href="#trunkwpadminincludeslisttablethemesphp">trunk/wp-admin/includes/list-table-themes.php</a></li>
<li><a href="#trunkwpadminincludeslisttableusersphp">trunk/wp-admin/includes/list-table-users.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesclasswplisttablephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/class-wp-list-table.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/class-wp-list-table.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/class-wp-list-table.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,9 +1,17 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Base class and helper functions for displaying a list of items in an ajaxified HTML table.
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
</ins><span class="cx">
</span><span class="cx"> /**
</span><del>- * Base class for displaying a list of items as an ajaxified html table
</del><ins>+ * Base class for displaying a list of items in an ajaxified HTML table.
</ins><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><ins>+ * @subpackage List_Table
</ins><span class="cx"> * @since 3.1.0
</span><span class="cx"> */
</span><span class="cx"> class WP_List_Table {
</span><span class="lines">@@ -811,7 +819,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Fetch an instance of a WP_List_Table class
</del><ins>+ * Fetch an instance of a WP_List_Table class.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablecommentsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-comments.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-comments.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-comments.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,21 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Comments and Post Comments List Table classes.
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
</ins><span class="cx">
</span><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Post Comments List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
</del><ins>+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> *
</span><del>- * @package WordPress
- * @subpackage Administration
</del><ins>+ * @see WP_Comments_Table
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Post_Comments_Table extends WP_Comments_Table {
</span><span class="cx">
</span><span class="cx"> function get_columns() {
</span><span class="lines">@@ -23,6 +30,13 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><ins>+/**
+ * Comments List Table class.
+ *
+ * @package WordPress
+ * @subpackage List_Table
+ * @since 3.1.0
+ */
</ins><span class="cx"> class WP_Comments_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> var $checkbox = true;
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablelinksphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-links.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-links.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-links.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Links Manager List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Links_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Links_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablemediaphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-media.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-media.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-media.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Media Library List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Media_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Media_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablemsusersphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-ms-users.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-ms-users.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-ms-users.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Multisite Users List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_MS_Users_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_MS_Users_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttableplugininstallphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-plugin-install.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-plugin-install.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-plugin-install.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Plugin Installer List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Plugin_Install_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Plugin_Install_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablepluginsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-plugins.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-plugins.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-plugins.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Plugins List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Plugins_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Plugins_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablepostsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-posts.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-posts.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-posts.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,13 +1,11 @@
</span><span class="cx"> <?php
</span><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Posts List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Posts_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablesitesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-sites.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-sites.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-sites.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Sites List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Sites_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Sites_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttabletermsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-terms.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-terms.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-terms.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Terms List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Terms_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> var $callback_args;
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablethemeinstallphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-theme-install.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-theme-install.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-theme-install.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Theme Installer List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Theme_Install_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Theme_Install_Table() {
</span></span></pre></div>
<a id="trunkwpadminincludeslisttablethemesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-themes.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-themes.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-themes.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Themes List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Themes_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> var $search = array();
</span></span></pre></div>
<a id="trunkwpadminincludeslisttableusersphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/list-table-users.php (15957 => 15958)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/list-table-users.php 2010-10-25 03:11:01 UTC (rev 15957)
+++ trunk/wp-admin/includes/list-table-users.php 2010-10-25 04:04:18 UTC (rev 15958)
</span><span class="lines">@@ -1,14 +1,11 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * List table classes
</del><ins>+ * Users List Table class.
</ins><span class="cx"> *
</span><del>- * Each list-type admin screen has a class that handles the rendering of the list table.
- *
</del><span class="cx"> * @package WordPress
</span><del>- * @subpackage Administration
</del><ins>+ * @subpackage List_Table
+ * @since 3.1.0
</ins><span class="cx"> */
</span><del>-
</del><span class="cx"> class WP_Users_Table extends WP_List_Table {
</span><span class="cx">
</span><span class="cx"> function WP_Users_Table() {
</span></span></pre>
</div>
</div>
</body>
</html>