<!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>[25564] trunk/src/wp-trackback.php: Improve inline documentation for wp-trackback.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">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/25564">25564</a></dd>
<dt>Author</dt> <dd>DrewAPicture</dd>
<dt>Date</dt> <dd>2013-09-22 18:38:56 +0000 (Sun, 22 Sep 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve inline documentation for wp-trackback.php.
Props kpdesign.
Fixes <a href="http://core.trac.wordpress.org/ticket/25377">#25377</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwptrackbackphp">trunk/src/wp-trackback.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwptrackbackphp"></a>
<div class="modfile"><h4>Modified: trunk/src/wp-trackback.php (25563 => 25564)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/wp-trackback.php 2013-09-22 14:33:11 UTC (rev 25563)
+++ trunk/src/wp-trackback.php 2013-09-22 18:38:56 UTC (rev 25564)
</span><span class="lines">@@ -1,8 +1,11 @@
</span><span class="cx"> <?php
</span><span class="cx"> /**
</span><del>- * Handle Trackbacks and Pingbacks sent to WordPress
</del><ins>+ * Handle Trackbacks and Pingbacks Sent to WordPress
</ins><span class="cx"> *
</span><ins>+ * @since 0.71
+ *
</ins><span class="cx"> * @package WordPress
</span><ins>+ * @subpackage Trackbacks
</ins><span class="cx"> */
</span><span class="cx">
</span><span class="cx"> if (empty($wp)) {
</span><span class="lines">@@ -11,10 +14,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * trackback_response() - Respond with an error or success XML message
</del><ins>+ * Response to a trackback.
</ins><span class="cx"> *
</span><del>- * @param int|bool $error Whether there was an error
- * @param string $error_message Error message if an error occurred
</del><ins>+ * Responds with an error or success XML message.
+ *
+ * @since 0.71
+ *
+ * @param int|bool $error Whether there was an error.
+ * Default '0'. Accepts '0' or '1'.
+ * @param string $error_message Error message if an error occurred.
</ins><span class="cx"> */
</span><span class="cx"> function trackback_response($error = 0, $error_message = '') {
</span><span class="cx"> header('Content-Type: text/xml; charset=' . get_option('blog_charset') );
</span><span class="lines">@@ -33,7 +41,7 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>-// trackback is done by a POST
</del><ins>+// Trackback is done by a POST.
</ins><span class="cx"> $request_array = 'HTTP_POST_VARS';
</span><span class="cx">
</span><span class="cx"> if ( !isset($_GET['tb_id']) || !$_GET['tb_id'] ) {
</span><span class="lines">@@ -44,7 +52,7 @@
</span><span class="cx"> $tb_url = isset($_POST['url']) ? $_POST['url'] : '';
</span><span class="cx"> $charset = isset($_POST['charset']) ? $_POST['charset'] : '';
</span><span class="cx">
</span><del>-// These three are stripslashed here so that they can be properly escaped after mb_convert_encoding()
</del><ins>+// These three are stripslashed here so they can be properly escaped after mb_convert_encoding().
</ins><span class="cx"> $title = isset($_POST['title']) ? wp_unslash($_POST['title']) : '';
</span><span class="cx"> $excerpt = isset($_POST['excerpt']) ? wp_unslash($_POST['excerpt']) : '';
</span><span class="cx"> $blog_name = isset($_POST['blog_name']) ? wp_unslash($_POST['blog_name']) : '';
</span><span class="lines">@@ -54,17 +62,18 @@
</span><span class="cx"> else
</span><span class="cx"> $charset = 'ASCII, UTF-8, ISO-8859-1, JIS, EUC-JP, SJIS';
</span><span class="cx">
</span><del>-// No valid uses for UTF-7
</del><ins>+// No valid uses for UTF-7.
</ins><span class="cx"> if ( false !== strpos($charset, 'UTF-7') )
</span><span class="cx"> die;
</span><span class="cx">
</span><del>-if ( function_exists('mb_convert_encoding') ) { // For international trackbacks
</del><ins>+// For international trackbacks.
+if ( function_exists('mb_convert_encoding') ) {
</ins><span class="cx"> $title = mb_convert_encoding($title, get_option('blog_charset'), $charset);
</span><span class="cx"> $excerpt = mb_convert_encoding($excerpt, get_option('blog_charset'), $charset);
</span><span class="cx"> $blog_name = mb_convert_encoding($blog_name, get_option('blog_charset'), $charset);
</span><span class="cx"> }
</span><span class="cx">
</span><del>-// Now that mb_convert_encoding() has been given a swing, we need to escape these three
</del><ins>+// Now that mb_convert_encoding() has been given a swing, we need to escape these three.
</ins><span class="cx"> $title = wp_slash($title);
</span><span class="cx"> $excerpt = wp_slash($excerpt);
</span><span class="cx"> $blog_name = wp_slash($blog_name);
</span><span class="lines">@@ -76,7 +85,7 @@
</span><span class="cx"> trackback_response(1, 'I really need an ID for this to work.');
</span><span class="cx">
</span><span class="cx"> if (empty($title) && empty($tb_url) && empty($blog_name)) {
</span><del>- // If it doesn't look like a trackback at all...
</del><ins>+ // If it doesn't look like a trackback at all.
</ins><span class="cx"> wp_redirect(get_permalink($tb_id));
</span><span class="cx"> exit;
</span><span class="cx"> }
</span><span class="lines">@@ -110,6 +119,7 @@
</span><span class="cx"> * Fires after a trackback is added to a post.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.2.0
</span><ins>+ *
</ins><span class="cx"> * @param int $trackback_id Trackback ID.
</span><span class="cx"> */
</span><span class="cx"> do_action( 'trackback_post', $trackback_id );
</span></span></pre>
</div>
</div>
</body>
</html>