<!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>[33676] trunk/src/wp-includes/ms-deprecated.php: Docs: Standardize `@deprecated` tag formatting and add missing summaries to deprecated functions in wp-includes/ms-deprecated.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" 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/33676">33676</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/33676","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-08-20 22:35:30 +0000 (Thu, 20 Aug 2015)</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'>Docs: Standardize `@deprecated` tag formatting and add missing summaries to deprecated functions in wp-includes/ms-deprecated.php.
Props Alphawolf for the initial patch.
Props DrewAPicture
See <a href="https://core.trac.wordpress.org/ticket/28806">#28806</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesmsdeprecatedphp">trunk/src/wp-includes/ms-deprecated.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesmsdeprecatedphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/ms-deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/ms-deprecated.php 2015-08-20 22:25:41 UTC (rev 33675)
+++ trunk/src/wp-includes/ms-deprecated.php 2015-08-20 22:35:30 UTC (rev 33676)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,9 +18,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Dashboard blog functionality was removed in WordPress 3.1, replaced by the user admin.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.1.0
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.1.0 Use get_blog_details()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see get_blog_details()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return int Current site ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_dashboard_blog() {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '3.1' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,9 +32,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Generates a random password.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use wp_generate_password()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use wp_generate_password()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see wp_generate_password()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function generate_random_password( $len = 8 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -51,11 +53,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * legacy function_exists() checks to determine if multisite is enabled.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use is_super_admin()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use is_super_admin()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see is_super_admin()
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see is_multisite()
- *
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function is_site_admin( $user_login = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '3.0', 'is_super_admin()' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,9 +75,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( !function_exists( 'graceful_fail' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to gracefully fail.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use wp_die()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use wp_die()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see wp_die()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function graceful_fail( $message ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -113,9 +113,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> endif;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to retrieve user information.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use get_user_by()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use get_user_by()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see get_user_by()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_user_details( $username ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,9 +125,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to clear the global post cache.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use clean_post_cache()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use clean_post_cache()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see clean_post_cache()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function clear_global_post_cache( $post_id ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -134,9 +136,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to determin if the current site is the main site.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use is_main_site()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use is_main_site()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see is_main_site()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function is_main_blog() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -145,9 +148,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to validate an email address.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated Use is_email()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use is_email()
</ins><span class="cx" style="display: block; padding: 0 10px"> * @see is_email()
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function validate_email( $email, $check_domain = true) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -156,9 +160,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to retrieve a list of all sites.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.0.0
- * @deprecated No alternative available. For performance reasons this function is not recommended.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.0.0 Use wp_get_sites()
+ * @see wp_get_sites()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_blog_list( $start = 0, $num = 10, $deprecated = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '3.0', 'wp_get_sites()' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -184,9 +190,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deprecated functionality to retrieve a list of the most active sites.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><span class="cx" style="display: block; padding: 0 10px"> * @deprecated 3.0.0
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated No alternative available. For performance reasons this function is not recommended.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @return array List of "most active" sites.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_most_active_blogs( $num = 10, $display = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _deprecated_function( __FUNCTION__, '3.0' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,8 +243,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * 6) $url
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.3.0
- * @deprecated Use wp_redirect()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.3.0 Use wp_redirect()
+ * @see wp_redirect()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -273,8 +282,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds an 'updated=true' argument to a URL.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.3.0
- * @deprecated Use add_query_arg()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.3.0 Use add_query_arg()
+ * @see add_query_arg()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -298,8 +307,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * and is simply returned as such.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since MU
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @deprecated 3.6.0
- * @deprecated Use get_user_by()
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @deprecated 3.6.0 Use get_user_by()
+ * @see get_user_by()
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $string Either an email address or a login.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return int
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -346,4 +355,4 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> return esc_url_raw( $url );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-}
</del><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+}
</ins></span></pre>
</div>
</div>
</body>
</html>