<!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>[37466] trunk/src/wp-admin: Multisite: Filter the links displayed on "Edit Site" views</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/37466">37466</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/37466","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jeremyfelt</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-05-19 21:47:06 +0000 (Thu, 19 May 2016)</dd>
</dl>

<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Multisite: Filter the links displayed on "Edit Site" views

Introduce the `network_edit_site_nav` function, which DRYs up the code used to display a common set of links at the top of "Edit Site" views.

Introduce the `network_edit_site_nav_links` filter, which allows plugins to modify the list of links displayed at the top of Edit Site views as a "tabbed" interface.

Props johnjamesjacoby, c3mdigital, Bueltge.
Fixes <a href="https://core.trac.wordpress.org/ticket/15800">#15800</a>.</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesmsphp">trunk/src/wp-admin/includes/ms.php</a></li>
<li><a href="#trunksrcwpadminnetworksiteinfophp">trunk/src/wp-admin/network/site-info.php</a></li>
<li><a href="#trunksrcwpadminnetworksitesettingsphp">trunk/src/wp-admin/network/site-settings.php</a></li>
<li><a href="#trunksrcwpadminnetworksitethemesphp">trunk/src/wp-admin/network/site-themes.php</a></li>
<li><a href="#trunksrcwpadminnetworksiteusersphp">trunk/src/wp-admin/network/site-users.php</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesmsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/ms.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/ms.php        2016-05-19 02:38:33 UTC (rev 37465)
+++ trunk/src/wp-admin/includes/ms.php  2016-05-19 21:47:06 UTC (rev 37466)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1028,3 +1028,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </script>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * Outputs the HTML for a network's "Edit Site" tabular interface
+ *
+ * @since 4.6.0
+ *
+ * @link https://core.trac.wordpress.org/ticket/15800 discussion
+ *
+ * @param $args {
+ *     Optional. Array or string of Query parameters.
+ *
+ *     @type int     $blog_id   The site ID. Default is the current site.
+ *     @type array   $links     The tabs to include with (label|url|cap) keys
+ *     @type string  $selected  The ID of the selected link
+ * }
+ */
+function network_edit_site_nav( $args = array() ) {
+
+       /**
+        * Filter the links that appear on site-editing network pages
+        *
+        * Default links: 'site-info', 'site-users', 'site-themes', and 'site-settings'
+        *
+        * @since 4.6.0
+        *
+        * @param array Array of link data.
+        */
+       $links = apply_filters( 'network_edit_site_nav_links', array(
+               'site-info'     => array( 'label' => __( 'Info' ),     'url' => 'site-info.php',     'cap' => 'manage_sites' ),
+               'site-users'    => array( 'label' => __( 'Users' ),    'url' => 'site-users.php',    'cap' => 'manage_sites' ),
+               'site-themes'   => array( 'label' => __( 'Themes' ),   'url' => 'site-themes.php',   'cap' => 'manage_sites' ),
+               'site-settings' => array( 'label' => __( 'Settings' ), 'url' => 'site-settings.php', 'cap' => 'manage_sites' )
+       ) );
+
+       // Parse arguments
+       $r = wp_parse_args( $args, array(
+               'blog_id'  => isset( $_GET['blog_id'] ) ? (int) $_GET['blog_id'] : 0,
+               'links'    => $links,
+               'selected' => 'site-info',
+       ) );
+
+       // Setup the links array
+       $screen_links = array();
+
+       // Loop through tabs
+       foreach ( $r['links'] as $link_id => $link ) {
+
+               // Skip link if user can't access
+               if ( ! current_user_can( $link['cap'], $r['blog_id'] ) ) {
+                       continue;
+               }
+
+               // Link classes
+               $classes = array( 'nav-tab' );
+
+               // Selected is set by the parent OR assumed by the $pagenow global
+               if ( $r['selected'] === $link_id || $link['url'] === $GLOBALS['pagenow'] ) {
+                       $classes[] = 'nav-tab-active';
+               }
+
+               // Escape each class
+               $esc_classes = implode( ' ', array_map( 'esc_attr', $classes ) );
+
+               // Get the URL for this link
+               $url = add_query_arg( array( 'id' => $r['blog_id'] ), network_admin_url( $link['url'] ) );
+
+               // Add link to nav links
+               $screen_links[ $link_id ] = '<a href="' . esc_url( $url ) . '" id="' . esc_attr( $link_id ) . '" class="' . $esc_classes . '">' . esc_html( $link['label'] ) . '</a>';
+       }
+
+       // Start a buffer
+       ob_start();
+
+       // All done!
+       echo '<h2 class="nav-tab-wrapper wp-clearfix">';
+       echo implode( '', $screen_links );
+       echo '</h2>';
+
+       // Output the nav
+       echo ob_get_clean();
+}
</ins></span></pre></div>
<a id="trunksrcwpadminnetworksiteinfophp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/site-info.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/site-info.php  2016-05-19 02:38:33 UTC (rev 37465)
+++ trunk/src/wp-admin/network/site-info.php    2016-05-19 21:47:06 UTC (rev 37466)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -143,21 +143,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="cx" style="display: block; padding: 0 10px"> <h1 id="edit-site"><?php echo $title; ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="edit-site-actions"><a href="<?php echo esc_url( get_home_url( $id, '/' ) ); ?>"><?php _e( 'Visit' ); ?></a> | <a href="<?php echo esc_url( get_admin_url( $id ) ); ?>"><?php _e( 'Dashboard' ); ?></a></p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<h2 class="nav-tab-wrapper nav-tab-small wp-clearfix">
</del><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$tabs = array(
-       'site-info'     => array( 'label' => __( 'Info' ),     'url' => 'site-info.php'     ),
-       'site-users'    => array( 'label' => __( 'Users' ),    'url' => 'site-users.php'    ),
-       'site-themes'   => array( 'label' => __( 'Themes' ),   'url' => 'site-themes.php'   ),
-       'site-settings' => array( 'label' => __( 'Settings' ), 'url' => 'site-settings.php' ),
-);
-foreach ( $tabs as $tab_id => $tab ) {
-       $class = ( $tab['url'] == $pagenow ) ? ' nav-tab-active' : '';
-       echo '<a href="' . $tab['url'] . '?id=' . $id .'" class="nav-tab' . $class . '">' . esc_html( $tab['label'] ) . '</a>';
-}
-?>
-</h2>
-<?php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+network_edit_site_nav( array(
+       'blog_id'  => $id,
+       'selected' => 'site-info'
+) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $messages ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">        foreach ( $messages as $msg ) {
</span><span class="cx" style="display: block; padding: 0 10px">                echo '<div id="message" class="updated notice is-dismissible"><p>' . $msg . '</p></div>';
</span></span></pre></div>
<a id="trunksrcwpadminnetworksitesettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/site-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/site-settings.php      2016-05-19 02:38:33 UTC (rev 37465)
+++ trunk/src/wp-admin/network/site-settings.php        2016-05-19 21:47:06 UTC (rev 37466)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -95,21 +95,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="cx" style="display: block; padding: 0 10px"> <h1 id="edit-site"><?php echo $title; ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="edit-site-actions"><a href="<?php echo esc_url( get_home_url( $id, '/' ) ); ?>"><?php _e( 'Visit' ); ?></a> | <a href="<?php echo esc_url( get_admin_url( $id ) ); ?>"><?php _e( 'Dashboard' ); ?></a></p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<h2 class="nav-tab-wrapper nav-tab-small wp-clearfix">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$tabs = array(
-       'site-info'     => array( 'label' => __( 'Info' ),     'url' => 'site-info.php'     ),
-       'site-users'    => array( 'label' => __( 'Users' ),    'url' => 'site-users.php'    ),
-       'site-themes'   => array( 'label' => __( 'Themes' ),   'url' => 'site-themes.php'   ),
-       'site-settings' => array( 'label' => __( 'Settings' ), 'url' => 'site-settings.php' ),
-);
-foreach ( $tabs as $tab_id => $tab ) {
-       $class = ( $tab['url'] == $pagenow ) ? ' nav-tab-active' : '';
-       echo '<a href="' . $tab['url'] . '?id=' . $id .'" class="nav-tab' . $class . '">' . esc_html( $tab['label'] ) . '</a>';
-}
-?>
-</h2>
-<?php
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+network_edit_site_nav( array(
+       'blog_id'  => $id,
+       'selected' => 'site-settings'
+) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $messages ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">        foreach ( $messages as $msg )
</span><span class="cx" style="display: block; padding: 0 10px">                echo '<div id="message" class="updated notice is-dismissible"><p>' . $msg . '</p></div>';
</span></span></pre></div>
<a id="trunksrcwpadminnetworksitethemesphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/site-themes.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/site-themes.php        2016-05-19 02:38:33 UTC (rev 37465)
+++ trunk/src/wp-admin/network/site-themes.php  2016-05-19 21:47:06 UTC (rev 37466)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,21 +149,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="cx" style="display: block; padding: 0 10px"> <h1 id="edit-site"><?php echo $title; ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="edit-site-actions"><a href="<?php echo esc_url( get_home_url( $id, '/' ) ); ?>"><?php _e( 'Visit' ); ?></a> | <a href="<?php echo esc_url( get_admin_url( $id ) ); ?>"><?php _e( 'Dashboard' ); ?></a></p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<h2 class="nav-tab-wrapper nav-tab-small wp-clearfix">
</del><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$tabs = array(
-       'site-info'     => array( 'label' => __( 'Info' ),     'url' => 'site-info.php'     ),
-       'site-users'    => array( 'label' => __( 'Users' ),    'url' => 'site-users.php'    ),
-       'site-themes'   => array( 'label' => __( 'Themes' ),   'url' => 'site-themes.php'   ),
-       'site-settings' => array( 'label' => __( 'Settings' ), 'url' => 'site-settings.php' ),
-);
-foreach ( $tabs as $tab_id => $tab ) {
-       $class = ( $tab['url'] == $pagenow ) ? ' nav-tab-active' : '';
-       echo '<a href="' . $tab['url'] . '?id=' . $id .'" class="nav-tab' . $class . '">' . esc_html( $tab['label'] ) . '</a>';
-}
-?>
-</h2><?php
</del><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+network_edit_site_nav( array(
+       'blog_id'  => $id,
+       'selected' => 'site-themes'
+) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $_GET['enabled'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">        $enabled = absint( $_GET['enabled'] );
</span><span class="cx" style="display: block; padding: 0 10px">        if ( 1 == $enabled ) {
</span></span></pre></div>
<a id="trunksrcwpadminnetworksiteusersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/network/site-users.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/network/site-users.php 2016-05-19 02:38:33 UTC (rev 37465)
+++ trunk/src/wp-admin/network/site-users.php   2016-05-19 21:47:06 UTC (rev 37466)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -204,21 +204,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <div class="wrap">
</span><span class="cx" style="display: block; padding: 0 10px"> <h1 id="edit-site"><?php echo $title; ?></h1>
</span><span class="cx" style="display: block; padding: 0 10px"> <p class="edit-site-actions"><a href="<?php echo esc_url( get_home_url( $id, '/' ) ); ?>"><?php _e( 'Visit' ); ?></a> | <a href="<?php echo esc_url( get_admin_url( $id ) ); ?>"><?php _e( 'Dashboard' ); ?></a></p>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<h2 class="nav-tab-wrapper nav-tab-small wp-clearfix">
</del><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-$tabs = array(
-       'site-info'     => array( 'label' => __( 'Info' ),     'url' => 'site-info.php'     ),
-       'site-users'    => array( 'label' => __( 'Users' ),    'url' => 'site-users.php'    ),
-       'site-themes'   => array( 'label' => __( 'Themes' ),   'url' => 'site-themes.php'   ),
-       'site-settings' => array( 'label' => __( 'Settings' ), 'url' => 'site-settings.php' ),
-);
-foreach ( $tabs as $tab_id => $tab ) {
-       $class = ( $tab['url'] == $pagenow ) ? ' nav-tab-active' : '';
-       echo '<a href="' . $tab['url'] . '?id=' . $id .'" class="nav-tab' . $class . '">' . esc_html( $tab['label'] ) . '</a>';
-}
-?>
-</h2><?php
</del><span class="cx" style="display: block; padding: 0 10px"> 
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+network_edit_site_nav( array(
+       'blog_id'  => $id,
+       'selected' => 'site-users'
+) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset($_GET['update']) ) :
</span><span class="cx" style="display: block; padding: 0 10px">        switch($_GET['update']) {
</span><span class="cx" style="display: block; padding: 0 10px">        case 'adduser':
</span></span></pre>
</div>
</div>

</body>
</html>