<!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>[13998] trunk: File-level phpdoc for multisite files.</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/13998">13998</a></dd>
<dt>Author</dt> <dd>nacin</dd>
<dt>Date</dt> <dd>2010-04-04 13:29:35 +0000 (Sun, 04 Apr 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>File-level phpdoc for multisite files.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludesmsdeprecatedphp">trunk/wp-admin/includes/ms-deprecated.php</a></li>
<li><a href="#trunkwpadminincludesmsphp">trunk/wp-admin/includes/ms.php</a></li>
<li><a href="#trunkwpadminmsadminphp">trunk/wp-admin/ms-admin.php</a></li>
<li><a href="#trunkwpadminmsdeletesitephp">trunk/wp-admin/ms-delete-site.php</a></li>
<li><a href="#trunkwpadminmseditphp">trunk/wp-admin/ms-edit.php</a></li>
<li><a href="#trunkwpadminmsoptionsphp">trunk/wp-admin/ms-options.php</a></li>
<li><a href="#trunkwpadminmssitesphp">trunk/wp-admin/ms-sites.php</a></li>
<li><a href="#trunkwpadminmsthemesphp">trunk/wp-admin/ms-themes.php</a></li>
<li><a href="#trunkwpadminmsupgradenetworkphp">trunk/wp-admin/ms-upgrade-network.php</a></li>
<li><a href="#trunkwpadminmsusersphp">trunk/wp-admin/ms-users.php</a></li>
<li><a href="#trunkwpadminmysitesphp">trunk/wp-admin/my-sites.php</a></li>
<li><a href="#trunkwpincludesmsdefaultconstantsphp">trunk/wp-includes/ms-default-constants.php</a></li>
<li><a href="#trunkwpincludesmsdefaultfiltersphp">trunk/wp-includes/ms-default-filters.php</a></li>
<li><a href="#trunkwpincludesmsdeprecatedphp">trunk/wp-includes/ms-deprecated.php</a></li>
<li><a href="#trunkwpincludesmsfunctionsphp">trunk/wp-includes/ms-functions.php</a></li>
<li><a href="#trunkwpincludesmssettingsphp">trunk/wp-includes/ms-settings.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludesmsdeprecatedphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/ms-deprecated.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/ms-deprecated.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/includes/ms-deprecated.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,59 +1,67 @@
</span><span class="cx"> <?php
</span><del>-
</del><span class="cx"> /**
</span><del>- * Deprecated multisite admin functions from past WordPress versions. You shouldn't use these
- * globals and functions and look for the alternatives instead. The functions
- * and globals will be removed in a later version.
</del><ins>+ * Deprecated multisite admin functions from past WordPress versions and WordPress MU.
+ * You shouldn't use these functions and look for the alternatives instead. The functions
+ * will be removed in a later version.
</ins><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage Deprecated
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @deprecated 3.0
</del><ins>+ * @deprecated 3.0.0
</ins><span class="cx"> */
</span><span class="cx"> function wpmu_menu() {
</span><del>- _deprecated_function(__FUNCTION__, '3.0', '' );
</del><ins>+ _deprecated_function(__FUNCTION__, '3.0' );
</ins><span class="cx"> // deprecated. See #11763
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Determines if the available space defined by the admin has been exceeded by the user. Dies if it has.
- * @deprecated 3.0
</del><ins>+ * Determines if the available space defined by the admin has been exceeded by the user.
+ *
+ * @deprecated 3.0.0
+ * @see is_upload_space_available()
</ins><span class="cx"> */
</span><span class="cx"> function wpmu_checkAvailableSpace() {
</span><del>- _deprecated_function(__FUNCTION__, '3.0', 'is_upload_space_available' );
</del><ins>+ _deprecated_function(__FUNCTION__, '3.0', 'is_upload_space_available()' );
</ins><span class="cx">
</span><span class="cx"> if ( !is_upload_space_available() )
</span><span class="cx"> wp_die( __('Sorry, you must delete files before you can upload any more.') );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @deprecated 3.0
</del><ins>+ * @deprecated 3.0.0
</ins><span class="cx"> */
</span><span class="cx"> function mu_options( $options ) {
</span><del>- _deprecated_function(__FUNCTION__, '3.0', '' );
</del><ins>+ _deprecated_function(__FUNCTION__, '3.0' );
</ins><span class="cx"> return $options;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @deprecated 3.0
</del><ins>+ * @deprecated 3.0.0
+ * @see activate_plugin()
</ins><span class="cx"> */
</span><span class="cx"> function activate_sitewide_plugin() {
</span><ins>+ _deprecated_function(__FUNCTION__, '3.0', 'activate_plugin()' );
</ins><span class="cx"> return false;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @deprecated 3.0
</del><ins>+ * @deprecated 3.0.0
+ * @see deactivate_sitewide_plugin()
</ins><span class="cx"> */
</span><span class="cx"> function deactivate_sitewide_plugin( $plugin = false ) {
</span><ins>+ _deprecated_function(__FUNCTION__, '3.0', 'deactivate_plugin()' );
</ins><span class="cx"> return;
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * @deprecated 3.0 is_network_only_plugin()
</del><ins>+ * @deprecated 3.0.0
+ * @see is_network_only_plugin()
</ins><span class="cx"> */
</span><span class="cx"> function is_wpmu_sitewide_plugin( $file ) {
</span><ins>+ _deprecated_function(__FUNCTION__, '3.0', 'is_network_only_plugin()' );
</ins><span class="cx"> return is_network_only_plugin( $file );
</span><span class="cx"> }
</span><span class="cx">
</span></span></pre></div>
<a id="trunkwpadminincludesmsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/ms.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/ms.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/includes/ms.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,11 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite administration functions.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
</ins><span class="cx">
</span><span class="cx"> /**
</span><span class="cx"> * Determine if uploaded file exceeds space quota.
</span></span></pre></div>
<a id="trunkwpadminmsadminphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-admin.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-admin.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-admin.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmsdeletesitephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-delete-site.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-delete-site.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-delete-site.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite delete site panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmseditphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-edit.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-edit.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-edit.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,9 +1,20 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Action handler for Multisite administration panels.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span><span class="cx"> wp_die( __( 'Multisite support is not enabled.' ) );
</span><span class="cx">
</span><ins>+if ( empty( $_GET['action'] ) )
+ wp_redirect( admin_url( 'ms-admin.php' ) );
+
</ins><span class="cx"> do_action( 'wpmuadminedit' , '');
</span><span class="cx">
</span><span class="cx"> if ( isset( $_GET['id' ]) )
</span></span></pre></div>
<a id="trunkwpadminmsoptionsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-options.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-options.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-options.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite network settings administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( ! is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmssitesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-sites.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-sites.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-sites.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite sites administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmsthemesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-themes.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-themes.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-themes.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite themes administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( ! current_user_can( 'manage_network_themes' ) )
</span></span></pre></div>
<a id="trunkwpadminmsupgradenetworkphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-upgrade-network.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-upgrade-network.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-upgrade-network.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite upgrade administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once('admin.php');
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmsusersphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/ms-users.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/ms-users.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/ms-users.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * Multisite users administration panel.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpadminmysitesphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/my-sites.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/my-sites.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-admin/my-sites.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -1,4 +1,12 @@
</span><span class="cx"> <?php
</span><ins>+/**
+ * My Sites dashboard.
+ *
+ * @package WordPress
+ * @subpackage Multisite
+ * @since 3.0.0
+ */
+
</ins><span class="cx"> require_once( './admin.php' );
</span><span class="cx">
</span><span class="cx"> if ( !is_multisite() )
</span></span></pre></div>
<a id="trunkwpincludesmsdefaultconstantsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-default-constants.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-default-constants.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-includes/ms-default-constants.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -4,6 +4,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage Multisite
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunkwpincludesmsdefaultfiltersphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-default-filters.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-default-filters.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-includes/ms-default-filters.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -10,6 +10,7 @@
</span><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage Multisite
</span><span class="cx"> * @see default-filters.php
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> // Users
</span></span></pre></div>
<a id="trunkwpincludesmsdeprecatedphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-deprecated.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-deprecated.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-includes/ms-deprecated.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -6,6 +6,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage Deprecated
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> /*
</span></span></pre></div>
<a id="trunkwpincludesmsfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-functions.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-functions.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-includes/ms-functions.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -3,6 +3,8 @@
</span><span class="cx"> * Multi-site WordPress API
</span><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><ins>+ * @subpackage Multisite
+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> function get_sitestats() {
</span></span></pre></div>
<a id="trunkwpincludesmssettingsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/ms-settings.php (13997 => 13998)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/ms-settings.php 2010-04-04 12:42:34 UTC (rev 13997)
+++ trunk/wp-includes/ms-settings.php 2010-04-04 13:29:35 UTC (rev 13998)
</span><span class="lines">@@ -7,6 +7,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @package WordPress
</span><span class="cx"> * @subpackage Multisite
</span><ins>+ * @since 3.0.0
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> // $base sanity check.
</span></span></pre>
</div>
</div>
</body>
</html>