<!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>[36386] trunk/src/wp-includes/link-template.php: Networks and sites: Replace "blog" usage with "site" in docs.</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/36386">36386</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/36386","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ericlewis</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-01-23 16:46:31 +0000 (Sat, 23 Jan 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'>Networks and sites: Replace "blog" usage with "site" in docs.
This effort focuses on `src/wp-includes/link-template.php`.
Multisite functions use the term "blog" to refer to what we now call a "site," e.g. `get_current_blog_id()`. These functions are here to stay because of our commitment to backwards compatibility. What we can do is set the documentation straight.
Props mrahmadawais.
Fixes <a href="https://core.trac.wordpress.org/ticket/35589">#35589</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludeslinktemplatephp"></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/link-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/link-template.php 2016-01-23 11:21:14 UTC (rev 36385)
+++ trunk/src/wp-includes/link-template.php 2016-01-23 16:46:31 UTC (rev 36386)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -28,12 +28,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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve trailing slash string, if blog set for adding trailing slashes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve trailing slash string, if site is set for adding trailing slashes.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Conditionally adds a trailing slash if the permalink structure has a trailing
</span><span class="cx" style="display: block; padding: 0 10px"> * slash, strips the trailing slash if not. The string is passed through the
</span><span class="cx" style="display: block; padding: 0 10px"> * 'user_trailingslashit' filter. Will remove trailing slash from string, if
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * blog is not set to have them.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * site is not set to have them.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1432,7 +1432,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display edit bookmark (literally a URL external to blog) link.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Display edit bookmark link.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1448,7 +1448,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $location = admin_url('link.php?action=edit&link_id=') . $link->link_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the bookmark (link) edit link.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filter the bookmark edit link.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1459,7 +1459,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Display edit bookmark (literally a URL external to blog) link anchor content.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Display edit bookmark link anchor content.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2954,7 +2954,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $pagenow
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $blog_id Optional. Blog ID. Default null (current blog).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $blog_id Optional. Site ID. Default null (current site).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Optional. Path relative to the home URL. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $scheme Optional. Scheme to give the home URL context. Accepts
</span><span class="cx" style="display: block; padding: 0 10px"> * 'http', 'https', 'relative', 'rest', or null. Default null.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2994,7 +2994,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Path relative to the home URL. Blank string if no path is specified.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $orig_scheme Scheme to give the home URL context. Accepts 'http', 'https',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'relative', 'rest', or null.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|null $blog_id Blog ID, or null for the current blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|null $blog_id Site ID, or null for the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'home_url', $url, $path, $orig_scheme, $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3025,7 +3025,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $blog_id Optional. Blog ID. Default null (current site).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $blog_id Optional. Site ID. Default null (current site).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Optional. Path relative to the site url. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $scheme Optional. Scheme to give the site url context. Accepts
</span><span class="cx" style="display: block; padding: 0 10px"> * 'http', 'https', 'login', 'login_post', 'admin', or
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3055,7 +3055,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Path relative to the site URL. Blank string if no path is specified.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string|null $scheme Scheme to give the site URL context. Accepts 'http', 'https', 'login',
</span><span class="cx" style="display: block; padding: 0 10px"> * 'login_post', 'admin', 'relative' or null.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|null $blog_id Blog ID, or null for the current blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|null $blog_id Site ID, or null for the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'site_url', $url, $path, $scheme, $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3078,7 +3078,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $blog_id Optional. Blog ID. Default null (current site).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $blog_id Optional. Site ID. Default null (current site).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Optional. Path relative to the admin url. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https',
</span><span class="cx" style="display: block; padding: 0 10px"> * to force those schemes. Default 'admin', which obeys
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3098,7 +3098,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $url The complete admin area URL including scheme and path.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Path relative to the admin area URL. Blank string if no path is specified.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int|null $blog_id Blog ID, or null for the current blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|null $blog_id Site ID, or null for the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( 'admin_url', $url, $path, $blog_id );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3352,7 +3352,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Retrieve the url to the admin area for either the current blog or the network depending on context.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieve the url to the admin area for either the current site or the network depending on context.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3421,12 +3421,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If a user does not belong to any site, the global user dashboard is used. If the user belongs to the current site,
</span><span class="cx" style="display: block; padding: 0 10px"> * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * primary blog is returned.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * primary site is returned.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $user_id Optional. User ID. Defaults to current user.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $path Optional path relative to the dashboard. Use only paths known to both blog and user admins.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional path relative to the dashboard. Use only paths known to both site and user admins.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $scheme The scheme to use. Default is 'admin', which obeys force_ssl_admin() and is_ssl(). 'http' or 'https' can be passed to force those schemes.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Dashboard url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3531,7 +3531,7 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return a shortlink for a post, page, attachment, or blog.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Return a shortlink for a post, page, attachment, or a site.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This function exists to provide a shortlink tag that all themes and plugins can target. A plugin must hook in to
</span><span class="cx" style="display: block; padding: 0 10px"> * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3540,8 +3540,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $id A post or blog id. Default is 0, which means the current post or blog.
- * @param string $context Whether the id is a 'blog' id, 'post' id, or 'media' id.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id A post or site id. Default is 0, which means the current post or site.
+ * @param string $context Whether the id is a 'site' id, 'post' id, or 'media' id.
</ins><span class="cx" style="display: block; padding: 0 10px"> * If 'post', the post_type of the post is consulted.
</span><span class="cx" style="display: block; padding: 0 10px"> * If 'query', the current query is consulted to determine the id and context.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default is 'post'.
</span></span></pre>
</div>
</div>
</body>
</html>