<!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>[19753] trunk/wp-includes/rewrite.php: Improve the inline documentation of rewrite endpoints.</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, #logmsg > ol { margin-left: 0; 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">

<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/19753">19753</a></dd>

<dt>Author</dt> <dd>duck_</dd>

<dt>Date</dt> <dd>2012-01-25 21:58:23 +0000 (Wed, 25 Jan 2012)</dd>

</dl>

<h3>Log Message</h3>

<pre>Improve the inline documentation of rewrite endpoints. See <a href="http://core.trac.wordpress.org/ticket/16303">#16303</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#trunkwpincludesrewritephp">trunk/wp-includes/rewrite.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="trunkwpincludesrewritephp"></a>

<div class="modfile"><h4>Modified: trunk/wp-includes/rewrite.php (19752 => 19753)</h4>

<pre class="diff"><span>

<span class="info">--- trunk/wp-includes/rewrite.php        2012-01-25 21:44:02 UTC (rev 19752)

+++ trunk/wp-includes/rewrite.php        2012-01-25 21:58:23 UTC (rev 19753)

</span><span class="lines">@@ -101,7 +101,6 @@

</span><span class="cx">         $wp_rewrite-&gt;flush_rules( $hard );

</span><span class="cx"> }

</span><span class="cx"> 

</span><del>-//pseudo-places

</del><span class="cx"> /**

<span class="cx">  * Endpoint Mask for default, which is nothing.

</span><span class="cx">  *

</span><span class="lines">@@ -210,22 +209,37 @@

</span><span class="cx"> /**

<span class="cx">  * Add an endpoint, like /trackback/.

</span><span class="cx">  *

</span><del>- * The endpoints are added to the end of the request. So a request matching

- * &quot;/2008/10/14/my_post/myep/&quot;, the endpoint will be &quot;/myep/&quot;.

</del><ins>+ * Adding an endpoint creates extra rewrite rules for each of the matching

+ * places specified by the provided bitmask. For example:

</ins><span class="cx">  *

</span><del>- * Be sure to flush the rewrite rules (wp_rewrite-&gt;flush_rules()) when your plugin gets

- * activated (register_activation_hook()) and deactivated (register_deactivation_hook())

</del><ins>+ * &lt;code&gt;

+ * add_rewrite_endpoint( 'json', EP_PERMALINK | EP_PAGES );

+ * &lt;/code&gt;

</ins><span class="cx">  *

</span><ins>+ * will add a new rewrite rule ending with &quot;json(/(.*))?/?$&quot; for every permastruct

+ * that describes a permalink (post) or page. This is rewritten to &quot;json=$match&quot;

+ * where $match is the part of the URL matched by the endpoint regex (e.g. &quot;foo&quot; in

+ * &quot;&lt;permalink&gt;/json/foo/&quot;).

+ *

+ * A new query var with the same name as the endpoint will also be created.

+ *

+ * When specifying $places ensure that you are using the EP_* constants (or a

+ * combination of them using the bitwise OR operator) as their values are not

+ * guaranteed to remain static (especially EP_ALL).

+ *

+ * Be sure to flush the rewrite rules - flush_rewrite_rules() - when your plugin gets

+ * activated and deactivated.

+ *

</ins><span class="cx">  * @since 2.1.0

<del>- * @see WP_Rewrite::add_endpoint() Parameters and more description.

- * @uses $wp_rewrite

</del><ins>+ * @see WP_Rewrite::add_endpoint()

+ * @global object $wp_rewrite

</ins><span class="cx">  *

</span><del>- * @param unknown_type $name

- * @param unknown_type $places

</del><ins>+ * @param string $name Name of the endpoint.

+ * @param int $places Endpoint mask describing the places the endpoint should be added.

</ins><span class="cx">  */

</span><del>-function add_rewrite_endpoint($name, $places) {

</del><ins>+function add_rewrite_endpoint( $name, $places ) {

</ins><span class="cx">         global $wp_rewrite;

</span><del>-        $wp_rewrite-&gt;add_endpoint($name, $places);

</del><ins>+        $wp_rewrite-&gt;add_endpoint( $name, $places );

</ins><span class="cx"> }

</span><span class="cx"> 

</span><span class="cx"> /**

</span><span class="lines">@@ -1833,13 +1847,15 @@

</span><span class="cx">         /**

<span class="cx">          * Add an endpoint, like /trackback/.

</span><span class="cx">          *

<del>-         * To be inserted after certain URL types (specified in $places).

</del><ins>+         * See {@link add_rewrite_endpoint()} for full documentation.

</ins><span class="cx">          *

</span><ins>+         * @see add_rewrite_endpoint()

</ins><span class="cx">          * @since 2.1.0

</span><span class="cx">          * @access public

</span><ins>+         * @uses WP::add_query_var()

</ins><span class="cx">          *

<del>-         * @param string $name Name of endpoint.

-         * @param array $places URL types that endpoint can be used.

</del><ins>+         * @param string $name Name of the endpoint.

+         * @param int $places Endpoint mask describing the places the endpoint should be added.

</ins><span class="cx">          */

</span><span class="cx">         function add_endpoint($name, $places) {

</span><span class="cx">                 global $wp;

</span></span></pre>

</div>

</div>

</body>

</html>