<!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>[34939] trunk/src/wp-includes/class-wp-rewrite.php: Docs: Remove invalid inline `@link` tags from a variety of DocBlocks in `WP_Rewrite`.</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/34939">34939</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/34939","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-10-08 16:46:16 +0000 (Thu, 08 Oct 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: Remove invalid inline `@link` tags from a variety of DocBlocks in `WP_Rewrite`.
See <a href="https://core.trac.wordpress.org/ticket/34218">#34218</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswprewritephp">trunk/src/wp-includes/class-wp-rewrite.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswprewritephp"></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/class-wp-rewrite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-rewrite.php 2015-10-08 16:40:11 UTC (rev 34938)
+++ trunk/src/wp-includes/class-wp-rewrite.php 2015-10-08 16:46:16 UTC (rev 34939)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,8 +163,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The prefix for all permalink structures.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If PATHINFO/index permalinks are in use then the root is the value of
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * {@link WP_Rewrite::$index} with a trailing slash appended. Otherwise
- * the root will be empty.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `WP_Rewrite::$index` with a trailing slash appended. Otherwise the root
+ * will be empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Rewrite::init()
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Rewrite::using_index_permalinks()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -226,7 +226,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Rules that don't redirect to WordPress' index.php.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These rules are written to the mod_rewrite portion of the .htaccess,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * and are added by {@link add_external_rule()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * and are added by add_external_rule().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,7 +235,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var $non_wp_rules = array();
</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">- * Extra permalink structures, e.g. categories, added by {@link add_permastruct()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Extra permalink structures, e.g. categories, added by add_permastruct().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -244,7 +244,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> var $extra_permastructs = array();
</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">- * Endpoints (like /trackback/) added by {@link add_rewrite_endpoint()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Endpoints (like /trackback/) added by add_rewrite_endpoint().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,14 +272,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * also match a page name (e.g. %postname% or %author%) then this flag is
</span><span class="cx" style="display: block; padding: 0 10px"> * set to true. Prior to WordPress 3.3 this flag indicated that every page
</span><span class="cx" style="display: block; padding: 0 10px"> * would have a set of rules added to the top of the rewrite rules array.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Now it tells {@link WP::parse_request()} to check if a URL matching the
- * page permastruct is actually a page before accepting it.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Now it tells WP::parse_request() to check if a URL matching the page
+ * permastruct is actually a page before accepting it.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @link https://core.trac.wordpress.org/ticket/16687
- * @see WP_Rewrite::init()
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> * @var bool
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ *
+ * @see WP_Rewrite::init()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public $use_verbose_page_rules = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -287,10 +287,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Rewrite tags that can be used in permalink structures.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * These are translated into the regular expressions stored in
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * {@link WP_Rewrite::$rewritereplace} and are rewritten to the
- * query variables listed in {@link WP_Rewrite::$queryreplace}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `WP_Rewrite::$rewritereplace` and are rewritten to the query
+ * variables listed in WP_Rewrite::$queryreplace.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Additional tags can be added with {@link add_rewrite_tag()}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Additional tags can be added with add_rewrite_tag().
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -312,7 +312,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"> * Regular expressions to be substituted into rewrite rules in place
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * of rewrite tags, see {@link WP_Rewrite::$rewritecode}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * of rewrite tags, see WP_Rewrite::$rewritecode.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -333,7 +333,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">- * Query variables that rewrite tags map to, see {@link WP_Rewrite::$rewritecode}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1138,14 +1138,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Generate Rewrite rules with permalink structure and walking directory only.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Shorten version of {@link WP_Rewrite::generate_rewrite_rules()} that
- * allows for shorter list of parameters. See the method for longer
- * description of what generating rewrite rules does.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Shorten version of WP_Rewrite::generate_rewrite_rules() that allows for shorter
+ * list of parameters. See the method for longer description of what generating
+ * rewrite rules does.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @see WP_Rewrite::generate_rewrite_rules() See for long description and rest of parameters.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $permalink_structure The permalink structure to generate rules.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $walk_dirs Optional, default is false. Whether to create list of directories to walk over.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1363,11 +1364,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve the rewrite rules.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The difference between this method and {@link
- * WP_Rewrite::rewrite_rules()} is that this method stores the rewrite rules
- * in the 'rewrite_rules' option and retrieves it. This prevents having to
- * process all of the permalinks to get the rewrite rules in the form of
- * caching.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The difference between this method and WP_Rewrite::rewrite_rules() is that
+ * this method stores the rewrite rules in the 'rewrite_rules' option and retrieves
+ * it. This prevents having to process all of the permalinks to get the rewrite rules
+ * in the form of caching.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1622,14 +1622,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Add a new permalink structure.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules; it
- * is an easy way of expressing a set of regular expressions that rewrite to a set of query strings.
- * The new permastruct is added to the {@link WP_Rewrite::$extra_permastructs} array. When the
- * rewrite rules are built by {@link WP_Rewrite::rewrite_rules()} all of these extra permastructs
- * are passed to {@link WP_Rewrite::generate_rewrite_rules()} which transforms them into the
- * regular expressions that many love to hate.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * A permalink structure (permastruct) is an abstract definition of a set of rewrite rules;
+ * it is an easy way of expressing a set of regular expressions that rewrite to a set of
+ * query strings. The new permastruct is added to the WP_Rewrite::$extra_permastructs array.
+ * When the rewrite rules are built by WP_Rewrite::rewrite_rules(), all of these extra
+ * permastructs are passed to WP_Rewrite::generate_rewrite_rules() which transforms them
+ * into the regular expressions that many love to hate.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The $args parameter gives you control over how {@link WP_Rewrite::generate_rewrite_rules()}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The `$args` parameter gives you control over how WP_Rewrite::generate_rewrite_rules()
</ins><span class="cx" style="display: block; padding: 0 10px"> * works on the new permastruct.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.5.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1678,9 +1678,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Remove rewrite rules and then recreate rewrite rules.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Calls {@link WP_Rewrite::wp_rewrite_rules()} after removing the
- * 'rewrite_rules' option. If the function named 'save_mod_rewrite_rules'
- * exists, it will be called.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Calls WP_Rewrite::wp_rewrite_rules() after removing the 'rewrite_rules' option.
+ * If the function named 'save_mod_rewrite_rules' exists, it will be called.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.1
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1761,7 +1760,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Will update the 'permalink_structure' option, if there is a difference
</span><span class="cx" style="display: block; padding: 0 10px"> * between the current permalink structure and the parameter value. Calls
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * {@link WP_Rewrite::init()} after the option is updated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * WP_Rewrite::init() after the option is updated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires the 'permalink_structure_changed' action once the init call has
</span><span class="cx" style="display: block; padding: 0 10px"> * processed passing the old and new values
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1793,8 +1792,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Set the category base for the category permalink.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Will update the 'category_base' option, if there is a difference between
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * the current category base and the parameter value. Calls
- * {@link WP_Rewrite::init()} after the option is updated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * the current category base and the parameter value. Calls WP_Rewrite::init()
+ * after the option is updated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1812,8 +1811,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Set the tag base for the tag permalink.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Will update the 'tag_base' option, if there is a difference between the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * current tag base and the parameter value. Calls
- * {@link WP_Rewrite::init()} after the option is updated.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * current tag base and the parameter value. Calls WP_Rewrite::init() after
+ * the option is updated.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access public
</span></span></pre>
</div>
</div>
</body>
</html>