<!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" />
<title>[27356] trunk/src/wp-admin/includes/class-wp-plugins-list-table.php: Inline documentation for hooks in wp-admin/includes/class-wp-plugins-list-table.php.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { 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 #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#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>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/27356">27356</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2014-03-02 20:47:31 +0000 (Sun, 02 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Inline documentation for hooks in wp-admin/includes/class-wp-plugins-list-table.php.
Props nicolealleyinteractivecom, kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/26957">#26957</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswppluginslisttablephp">trunk/src/wp-admin/includes/class-wp-plugins-list-table.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswppluginslisttablephp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-admin/includes/class-wp-plugins-list-table.php (27355 => 27356)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2014-03-02 20:31:15 UTC (rev 27355)
+++ trunk/src/wp-admin/includes/class-wp-plugins-list-table.php 2014-03-02 20:47:31 UTC (rev 27356)
</span><span class="lines">@@ -40,6 +40,15 @@
</span><span class="cx">
</span><span class="cx"> wp_reset_vars( array( 'orderby', 'order', 's' ) );
</span><span class="cx">
</span><ins>+ /**
+ * Filter the full array of plugins to list in the Plugins list table.
+ *
+ * @since 3.0.0
+ *
+ * @see get_plugins()
+ *
+ * @param array $plugins An array of plugins to display in the list table.
+ */
</ins><span class="cx"> $plugins = array(
</span><span class="cx"> 'all' => apply_filters( 'all_plugins', get_plugins() ),
</span><span class="cx"> 'search' => array(),
</span><span class="lines">@@ -54,8 +63,27 @@
</span><span class="cx"> $screen = $this->screen;
</span><span class="cx">
</span><span class="cx"> if ( ! is_multisite() || ( $screen->in_admin( 'network' ) && current_user_can( 'manage_network_plugins' ) ) ) {
</span><del>- if ( apply_filters( 'show_advanced_plugins', true, 'mustuse' ) )
</del><ins>+
+ /**
+ * Filter whether to display the advanced plugins list table.
+ *
+ * There are two types of advanced plugins - must-use and drop-ins -
+ * which can be used in a single site or Multisite network.
+ *
+ * The $type parameter allows you to differentiate between the type of advanced
+ * plugins to filter the display of. Contexts include 'mustuse' and 'dropins'.
+ *
+ * @since 3.0.0
+ *
+ * @param bool $show Whether to show the advanced plugins for the specified
+ * plugin type. Default true.
+ * @param string $type The plugin type. Accepts 'mustuse', 'dropins'.
+ */
+ if ( apply_filters( 'show_advanced_plugins', true, 'mustuse' ) ) {
</ins><span class="cx"> $plugins['mustuse'] = get_mu_plugins();
</span><ins>+ }
+
+ /** This action is documented in wp-admin/includes/class-wp-plugins-list-table.php */
</ins><span class="cx"> if ( apply_filters( 'show_advanced_plugins', true, 'dropins' ) )
</span><span class="cx"> $plugins['dropins'] = get_dropins();
</span><span class="cx">
</span><span class="lines">@@ -369,7 +397,53 @@
</span><span class="cx"> } // end if $context
</span><span class="cx">
</span><span class="cx"> $prefix = $screen->in_admin( 'network' ) ? 'network_admin_' : '';
</span><ins>+
+ /**
+ * Filter the action links displayed for each plugin in the Plugins list table.
+ *
+ * The dynamic portion of the hook name, $prefix, refers to the context the
+ * action links are displayed in. The 'network_admin_' prefix is used if the
+ * current screen is the Network plugins list table. The prefix is empty ('')
+ * if the current screen is the site plugins list table.
+ *
+ * The default action links for the Network plugins list table include
+ * 'Network Activate', 'Network Deactivate', 'Edit', and 'Delete'.
+ *
+ * The default action links for the site plugins list table include
+ * 'Activate', 'Deactivate', and 'Edit', for a network site, and
+ * 'Activate', 'Deactivate', 'Edit', and 'Delete' for a single site.
+ *
+ * @since 2.5.0
+ *
+ * @param array $actions An array of plugin action links.
+ * @param string $plugin_file Path to the plugin file.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $context The plugin context. Defaults are 'All', 'Active',
+ * 'Inactive', 'Recently Activated', 'Upgrade',
+ * 'Must-Use', 'Drop-ins', 'Search'.
+ */
</ins><span class="cx"> $actions = apply_filters( $prefix . 'plugin_action_links', array_filter( $actions ), $plugin_file, $plugin_data, $context );
</span><ins>+
+ /**
+ * Filter the list of action links displayed for a specific plugin.
+ *
+ * The first dynamic portion of the hook name, $prefix, refers to the context
+ * the action links are displayed in. The 'network_admin_' prefix is used if the
+ * current screen is the Network plugins list table. The prefix is empty ('')
+ * if the current screen is the site plugins list table.
+ *
+ * The second dynamic portion of the hook name, $plugin_file, refers to the path
+ * to the plugin file, relative to the plugins directory.
+ *
+ * @since 2.7.0
+ *
+ * @param array $actions An array of plugin action links.
+ * @param string $plugin_file Path to the plugin file.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $context The plugin context. Defaults are 'All', 'Active',
+ * 'Inactive', 'Recently Activated', 'Upgrade',
+ * 'Must-Use', 'Drop-ins', 'Search'.
+ */
</ins><span class="cx"> $actions = apply_filters( $prefix . "plugin_action_links_$plugin_file", $actions, $plugin_file, $plugin_data, $context );
</span><span class="cx">
</span><span class="cx"> $class = $is_active ? 'active' : 'inactive';
</span><span class="lines">@@ -424,6 +498,20 @@
</span><span class="cx"> if ( ! empty( $plugin_data['PluginURI'] ) )
</span><span class="cx"> $plugin_meta[] = '<a href="' . $plugin_data['PluginURI'] . '" title="' . esc_attr__( 'Visit plugin site' ) . '">' . __( 'Visit plugin site' ) . '</a>';
</span><span class="cx">
</span><ins>+ /**
+ * Filter the array of row meta for each plugin in the Plugins list table.
+ *
+ * @since 2.8.0
+ *
+ * @param array $plugin_meta An array of the plugin's metadata,
+ * including the version, author,
+ * author URI, and plugin URI.
+ * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $status Status of the plugin. Defaults are 'All', 'Active',
+ * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+ * 'Drop-ins', 'Search'.
+ */
</ins><span class="cx"> $plugin_meta = apply_filters( 'plugin_row_meta', $plugin_meta, $plugin_file, $plugin_data, $status );
</span><span class="cx"> echo implode( ' | ', $plugin_meta );
</span><span class="cx">
</span><span class="lines">@@ -431,6 +519,16 @@
</span><span class="cx"> break;
</span><span class="cx"> default:
</span><span class="cx"> echo "<td class='$column_name column-$column_name'$style>";
</span><ins>+
+ /**
+ * Fires inside each custom column of the Plugins list table.
+ *
+ * @since 3.1.0
+ *
+ * @param string $column_name Name of the column.
+ * @param string $plugin_file Path to the plugin file.
+ * @param array $plugin_data An array of plugin data.
+ */
</ins><span class="cx"> do_action( 'manage_plugins_custom_column', $column_name, $plugin_file, $plugin_data );
</span><span class="cx"> echo "</td>";
</span><span class="cx"> }
</span><span class="lines">@@ -438,7 +536,33 @@
</span><span class="cx">
</span><span class="cx"> echo "</tr>";
</span><span class="cx">
</span><ins>+ /**
+ * Fires after each row in the Plugins list table.
+ *
+ * @since 2.3.0
+ *
+ * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $status Status of the plugin. Defaults are 'All', 'Active',
+ * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+ * 'Drop-ins', 'Search'.
+ */
</ins><span class="cx"> do_action( 'after_plugin_row', $plugin_file, $plugin_data, $status );
</span><ins>+
+ /**
+ * Fires after each specific row in the Plugins list table.
+ *
+ * The dynamic portion of the hook name, $plugin_file, refers to the path
+ * to the plugin file, relative to the plugins directory.
+ *
+ * @since 2.7.0
+ *
+ * @param string $plugin_file Path to the plugin file, relative to the plugins directory.
+ * @param array $plugin_data An array of plugin data.
+ * @param string $status Status of the plugin. Defaults are 'All', 'Active',
+ * 'Inactive', 'Recently Activated', 'Upgrade', 'Must-Use',
+ * 'Drop-ins', 'Search'.
+ */
</ins><span class="cx"> do_action( "after_plugin_row_$plugin_file", $plugin_file, $plugin_data, $status );
</span><span class="cx"> }
</span><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>