<!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>[37258] trunk/src/wp-includes/link-template.php: Docs: Notate more optional parameter defaults for a variety of function DocBlocks in wp-includes/link-template.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/37258">37258</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/37258","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>2016-04-20 14:36:57 +0000 (Wed, 20 Apr 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'>Docs: Notate more optional parameter defaults for a variety of function DocBlocks in wp-includes/link-template.php.
See <a href="https://core.trac.wordpress.org/ticket/30406">#30406</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-04-20 14:07:33 UTC (rev 37257)
+++ trunk/src/wp-includes/link-template.php 2016-04-20 14:36:57 UTC (rev 37258)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2611,8 +2611,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite
</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 $pagenum Optional. Page number.
- * @param int $max_page Optional. The maximum number of comment pages.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $pagenum Optional. Page number. Default 1.
+ * @param int $max_page Optional. The maximum number of comment pages. Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The comments page number link URL.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_comments_pagenum_link( $pagenum = 1, $max_page = 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2655,8 +2655,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Query $wp_query
</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 string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $label Optional. Label for link text. Default empty.
+ * @param int $max_page Optional. Max page. Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|void HTML-formatted link for the next page of comments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_next_comments_link( $label = '', $max_page = 0 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2700,8 +2700,8 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $label Optional. Label for link text.
- * @param int $max_page Optional. Max page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $label Optional. Label for link text. Default empty.
+ * @param int $max_page Optional. Max page. Default 0.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function next_comments_link( $label = '', $max_page = 0 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_next_comments_link( $label, $max_page );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2712,7 +2712,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.7.1
</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 string $label Optional. Label for comments link text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $label Optional. Label for comments link text. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|void HTML-formatted link for the previous page of comments.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_previous_comments_link( $label = '' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2744,7 +2744,7 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $label Optional. Label for comments link text.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $label Optional. Label for comments link text. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function previous_comments_link( $label = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_previous_comments_link( $label );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2758,10 +2758,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Rewrite $wp_rewrite
</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 string|array $args Optional args. See paginate_links().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $args Optional args. See paginate_links(). Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|void Markup for pagination links.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function paginate_comments_links($args = array()) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function paginate_comments_links( $args = array() ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wp_rewrite;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_singular() )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2799,8 +2799,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Default comments navigation arguments.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $prev_text Anchor text to display in the previous comments link. Default 'Older comments'.
- * @type string $next_text Anchor text to display in the next comments link. Default 'Newer comments'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $prev_text Anchor text to display in the previous comments link.
+ * Default 'Older comments'.
+ * @type string $next_text Anchor text to display in the next comments link.
+ * Default 'Newer comments'.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @type string $screen_reader_text Screen reader text for nav element. Default 'Comments navigation'.
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Markup for comments links.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2838,7 +2840,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.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 array $args See {@see get_the_comments_navigation()} for available arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args See get_the_comments_navigation() for available arguments. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function the_comments_navigation( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_the_comments_navigation( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2882,7 +2884,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.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 array $args See {@see get_the_comments_pagination()} for available arguments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args See get_the_comments_pagination() for available arguments. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function the_comments_pagination( $args = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> echo get_the_comments_pagination( $args );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2893,6 +2895,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @global bool $is_IE Whether the browser matches an Internet Explorer user agent.
+ * @global string $wp_version WP version.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @global bool $is_IE
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $wp_version
</span><span class="cx" style="display: block; padding: 0 10px"> * @global WP_Press_This $wp_press_this
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3033,7 +3038,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 string $path Optional. Path relative to the site url.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the site url. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string Site 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">@@ -3092,7 +3097,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $path Optional path relative to the admin url.
</span><del style="background-color: #fdd; text-decoration:none; 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.
</del><ins style="background-color: #dfd; text-decoration:none; 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function admin_url( $path = '', $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3108,7 +3114,7 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * {@see force_ssl_admin()} and {@see is_ssl()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * force_ssl_admin() and is_ssl().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_admin_url( $blog_id = null, $path = '', $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3134,8 +3140,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.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 string $path Optional. Path relative to the includes url.
- * @param string $scheme Optional. Scheme to give the includes url context.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the includes url. Default empty.
+ * @param string $scheme Optional. Scheme to give the includes url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Includes url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function includes_url( $path = '', $scheme = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3161,10 +3168,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.6.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 string $path Optional. Path relative to the content url.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the content url. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Content url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function content_url($path = '') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function content_url( $path = '' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $url = set_url_scheme( WP_CONTENT_URL );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $path && is_string( $path ) )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3242,8 +3249,11 @@
</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 string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. See set_url_scheme().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see set_url_scheme()
+ *
+ * @param string $path Optional. Path relative to the site url. Default empty.
+ * @param string $scheme Optional. Scheme to give the site url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Site url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function network_site_url( $path = '', $scheme = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3277,7 +3287,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the home URL for the current network.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Returns the home url with the appropriate protocol, 'https' {@see is_ssl()}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the home url with the appropriate protocol, 'https' is_ssl()
</ins><span class="cx" style="display: block; padding: 0 10px"> * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
</span><span class="cx" style="display: block; padding: 0 10px"> * overridden.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3325,8 +3335,9 @@
</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 string $path Optional path relative to the admin url.
- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional path relative to the admin url. Default empty.
+ * @param string $scheme Optional. 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function network_admin_url( $path = '', $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3355,8 +3366,9 @@
</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 string $path Optional path relative to the admin url.
- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the admin url. Default empty.
+ * @param string $scheme Optional. 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function user_admin_url( $path = '', $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3382,11 +3394,12 @@
</span><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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $path Optional path relative to the admin url.
- * @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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the admin url. Default empty.
+ * @param string $scheme Optional. 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Admin url link with optional path appended.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function self_admin_url($path = '', $scheme = 'admin') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function self_admin_url( $path = '', $scheme = 'admin' ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_network_admin() )
</span><span class="cx" style="display: block; padding: 0 10px"> return network_admin_url($path, $scheme);
</span><span class="cx" style="display: block; padding: 0 10px"> elseif ( is_user_admin() )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3445,15 +3458,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieves the URL to the user's dashboard.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; 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,
- * the dashboard for the current site is returned. If the user cannot edit the current site, the dashboard to the user's
- * primary site is returned.
</del><ins style="background-color: #dfd; text-decoration:none; 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, the dashboard for the current site is returned. If the user
+ * cannot edit the current site, the dashboard to the user's 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 site and user admins.
- * @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.
</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. Default empty.
+ * @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.
</ins><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="cx" style="display: block; padding: 0 10px"> function get_dashboard_url( $user_id = 0, $path = '', $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3497,8 +3512,8 @@
</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 $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.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $scheme Optional. 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.
</ins><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="cx" style="display: block; padding: 0 10px"> function get_edit_profile_url( $user_id = 0, $scheme = 'admin' ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3559,22 +3574,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns a shortlink for a post, page, attachment, or site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; 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
- * provide the actual shortlinks. Default shortlink support is limited to providing ?p= style links for posts.
- * Plugins can short-circuit this function via the pre_get_shortlink filter or filter the output
- * via the get_shortlink filter.
</del><ins style="background-color: #dfd; text-decoration:none; 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 provide the actual shortlinks. Default shortlink support is
+ * limited to providing ?p= style links for posts. Plugins can short-circuit this function
+ * via the {@see 'pre_get_shortlink'} filter or filter the output via the {@see 'get_shortlink'} filter.
</ins><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 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.
- * If 'post', the post_type of the post is consulted.
- * If 'query', the current query is consulted to determine the id and context.
- * Default is 'post'.
- * @param bool $allow_slugs Whether to allow post slugs in the shortlink. It is up to the plugin how and whether to honor this.
- * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks are not enabled.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id Optional. A post or site id. Default is 0, which means the current post or site.
+ * @param string $context Optional. Whether the id is a 'site' id, 'post' id, or 'media' id. If 'post',
+ * the post_type of the post is consulted. If 'query', the current query is consulted
+ * to determine the id and context. Default 'post'.
+ * @param bool $allow_slugs Optional. Whether to allow post slugs in the shortlink. It is up to the plugin how
+ * and whether to honor this. Default true.
+ * @return string A shortlink or an empty string if no shortlink exists for the requested resource or if shortlinks
+ * are not enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_get_shortlink($id = 0, $context = 'post', $allow_slugs = true) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_get_shortlink( $id = 0, $context = 'post', $allow_slugs = true ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters whether to preempt generating a shortlink for the given post.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3633,7 +3649,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Injects rel=shortlink into the head if a shortlink is defined for the current page.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Attached to the wp_head action.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Attached to the {@see 'wp_head'} action.
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3670,14 +3686,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Must be called from inside "The Loop"
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Call like the_shortlink(__('Shortlinkage FTW'))
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Call like the_shortlink( __( 'Shortlinkage FTW' ) )
</ins><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><span class="cx" style="display: block; padding: 0 10px"> * @param string $text Optional The link text or HTML to be displayed. Defaults to 'This is the short link.'
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $title Optional The tooltip for the link. Must be sanitized. Defaults to the sanitized post title.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $before Optional HTML to display before the link.
- * @param string $after Optional HTML to display after the link.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $before Optional HTML to display before the link. Default empty.
+ * @param string $after Optional HTML to display after the link. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function the_shortlink( $text = '', $title = '', $before = '', $after = '' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post();
</span></span></pre>
</div>
</div>
</body>
</html>