<!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>[18448] trunk/wp-includes/functions.php: phpdoc typo fixes for functions.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, #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/18448">18448</a></dd>
<dt>Author</dt> <dd>ryan</dd>
<dt>Date</dt> <dd>2011-07-21 17:48:25 +0000 (Thu, 21 Jul 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>phpdoc typo fixes for functions.php. Props coffee2code. fixes <a href="http://core.trac.wordpress.org/ticket/17752">#17752</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesfunctionsphp">trunk/wp-includes/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/functions.php (18447 => 18448)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/functions.php 2011-07-21 17:46:01 UTC (rev 18447)
+++ trunk/wp-includes/functions.php 2011-07-21 17:48:25 UTC (rev 18448)
</span><span class="lines">@@ -454,7 +454,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Loads and caches certain often requested site options if is_multisite() and a peristent cache is not being used.
</del><ins>+ * Loads and caches certain often requested site options if is_multisite() and a persistent cache is not being used.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @package WordPress
</span><span class="lines">@@ -686,7 +686,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete a transient
</del><ins>+ * Delete a transient.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> * @package WordPress
</span><span class="lines">@@ -719,7 +719,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the value of a transient
</del><ins>+ * Get the value of a transient.
</ins><span class="cx"> *
</span><span class="cx"> * If the transient does not exist or does not have a value, then the return value
</span><span class="cx"> * will be false.
</span><span class="lines">@@ -768,7 +768,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Set/update the value of a transient
</del><ins>+ * Set/update the value of a transient.
</ins><span class="cx"> *
</span><span class="cx"> * You do not need to serialize values. If the value needs to be serialized, then
</span><span class="cx"> * it will be serialized before it is set.
</span><span class="lines">@@ -1417,7 +1417,7 @@
</span><span class="cx"> * using this function. You can also retrieve the full URL with query data.
</span><span class="cx"> *
</span><span class="cx"> * Adding a single key & value or an associative array. Setting a key value to
</span><del>- * emptystring removes the key. Omitting oldquery_or_uri uses the $_SERVER
</del><ins>+ * an empty string removes the key. Omitting oldquery_or_uri uses the $_SERVER
</ins><span class="cx"> * value.
</span><span class="cx"> *
</span><span class="cx"> * @since 1.5.0
</span><span class="lines">@@ -1794,7 +1794,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Load the RSS 1.0 Feed Template
</del><ins>+ * Load the RSS 1.0 Feed Template.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.1.0
</span><span class="cx"> */
</span><span class="lines">@@ -2744,13 +2744,13 @@
</span><span class="cx"> * HTML will be displayed to the user. It is recommended to use this function
</span><span class="cx"> * only, when the execution should not continue any further. It is not
</span><span class="cx"> * recommended to call this function very often and try to handle as many errors
</span><del>- * as possible siliently.
</del><ins>+ * as possible silently.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.0.4
</span><span class="cx"> *
</span><span class="cx"> * @param string $message Error message.
</span><span class="cx"> * @param string $title Error title.
</span><del>- * @param string|array $args Optional arguements to control behaviour.
</del><ins>+ * @param string|array $args Optional arguments to control behavior.
</ins><span class="cx"> */
</span><span class="cx"> function wp_die( $message, $title = '', $args = array() ) {
</span><span class="cx"> if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
</span><span class="lines">@@ -2776,7 +2776,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $message Error message.
</span><span class="cx"> * @param string $title Error title.
</span><del>- * @param string|array $args Optional arguements to control behaviour.
</del><ins>+ * @param string|array $args Optional arguments to control behavior.
</ins><span class="cx"> */
</span><span class="cx"> function _default_wp_die_handler( $message, $title = '', $args = array() ) {
</span><span class="cx"> $defaults = array( 'response' => 500 );
</span><span class="lines">@@ -2867,7 +2867,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @param string $message Error message.
</span><span class="cx"> * @param string $title Error title.
</span><del>- * @param string|array $args Optional arguements to control behaviour.
</del><ins>+ * @param string|array $args Optional arguments to control behavior.
</ins><span class="cx"> */
</span><span class="cx"> function _xmlrpc_wp_die_handler( $message, $title = '', $args = array() ) {
</span><span class="cx"> global $wp_xmlrpc_server;
</span><span class="lines">@@ -2896,7 +2896,7 @@
</span><span class="cx"> /**
</span><span class="cx"> * Retrieve the WordPress home page URL.
</span><span class="cx"> *
</span><del>- * If the constant named 'WP_HOME' exists, then it willl be used and returned by
</del><ins>+ * If the constant named 'WP_HOME' exists, then it will be used and returned by
</ins><span class="cx"> * the function. This can be used to counter the redirection on your local
</span><span class="cx"> * development environment.
</span><span class="cx"> *
</span><span class="lines">@@ -3098,7 +3098,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Clean up an array, comma- or space-separated list of IDs
</del><ins>+ * Clean up an array, comma- or space-separated list of IDs.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="lines">@@ -3113,7 +3113,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Extract a slice of an array, given a list of keys
</del><ins>+ * Extract a slice of an array, given a list of keys.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="lines">@@ -3131,7 +3131,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filters a list of objects, based on a set of key => value arguments
</del><ins>+ * Filters a list of objects, based on a set of key => value arguments.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> *
</span><span class="lines">@@ -3155,7 +3155,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Filters a list of objects, based on a set of key => value arguments
</del><ins>+ * Filters a list of objects, based on a set of key => value arguments.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="lines">@@ -3192,7 +3192,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Pluck a certain field out of each object in a list
</del><ins>+ * Pluck a certain field out of each object in a list.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> *
</span><span class="lines">@@ -3305,7 +3305,7 @@
</span><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> *
</span><del>- * @param mixed $maybeint Data you wish to have convered to an nonnegative integer
</del><ins>+ * @param mixed $maybeint Data you wish to have converted to a nonnegative integer
</ins><span class="cx"> * @return int An nonnegative integer
</span><span class="cx"> */
</span><span class="cx"> function absint( $maybeint ) {
</span><span class="lines">@@ -3503,7 +3503,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Is the server running earlier than 1.5.0 version of lighttpd
</del><ins>+ * Is the server running earlier than 1.5.0 version of lighttpd?
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> *
</span><span class="lines">@@ -3516,7 +3516,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Does the specified module exist in the apache config?
</del><ins>+ * Does the specified module exist in the Apache config?
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.5.0
</span><span class="cx"> *
</span><span class="lines">@@ -3545,7 +3545,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Check if IIS 7 supports pretty permalinks
</del><ins>+ * Check if IIS 7 supports pretty permalinks.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><span class="lines">@@ -3889,7 +3889,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Delete a site transient
</del><ins>+ * Delete a site transient.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><span class="cx"> * @package WordPress
</span><span class="lines">@@ -3920,7 +3920,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Get the value of a site transient
</del><ins>+ * Get the value of a site transient.
</ins><span class="cx"> *
</span><span class="cx"> * If the transient does not exist or does not have a value, then the return value
</span><span class="cx"> * will be false.
</span><span class="lines">@@ -3969,7 +3969,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Set/update the value of a site transient
</del><ins>+ * Set/update the value of a site transient.
</ins><span class="cx"> *
</span><span class="cx"> * You do not need to serialize values, if the value needs to be serialize, then
</span><span class="cx"> * it will be serialized before it is set.
</span><span class="lines">@@ -4016,7 +4016,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * is main site
</del><ins>+ * Is main site?
</ins><span class="cx"> *
</span><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="lines">@@ -4062,9 +4062,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * gmt_offset modification for smart timezone handling
</del><ins>+ * gmt_offset modification for smart timezone handling.
</ins><span class="cx"> *
</span><del>- * Overrides the gmt_offset option if we have a timezone_string available
</del><ins>+ * Overrides the gmt_offset option if we have a timezone_string available.
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="cx"> *
</span><span class="lines">@@ -4131,7 +4131,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Gives a nicely formatted list of timezone strings // temporary! Not in final
</del><ins>+ * Gives a nicely formatted list of timezone strings. // temporary! Not in final
</ins><span class="cx"> *
</span><span class="cx"> * @since 2.9.0
</span><span class="cx"> *
</span><span class="lines">@@ -4260,7 +4260,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Strip close comment and close php tags from file headers used by WP
</del><ins>+ * Strip close comment and close php tags from file headers used by WP.
</ins><span class="cx"> * See http://core.trac.wordpress.org/ticket/8497
</span><span class="cx"> *
</span><span class="cx"> * @since 2.8.0
</span><span class="lines">@@ -4321,7 +4321,7 @@
</span><span class="cx"> * Retrieve metadata from a file.
</span><span class="cx"> *
</span><span class="cx"> * Searches for metadata in the first 8kiB of a file, such as a plugin or theme.
</span><del>- * Each piece of metadata must be on its own line. Fields can not span multple
</del><ins>+ * Each piece of metadata must be on its own line. Fields can not span multiple
</ins><span class="cx"> * lines, the value will get cut at the end of the first line.
</span><span class="cx"> *
</span><span class="cx"> * If the file data is not within that first 8kiB, then the author should correct
</span><span class="lines">@@ -4370,7 +4370,7 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Used internally to tidy up the search terms
</del><ins>+ * Used internally to tidy up the search terms.
</ins><span class="cx"> *
</span><span class="cx"> * @access private
</span><span class="cx"> * @since 2.9.0
</span><span class="lines">@@ -4383,9 +4383,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns true
</del><ins>+ * Returns true.
</ins><span class="cx"> *
</span><del>- * Useful for returning true to filters easily
</del><ins>+ * Useful for returning true to filters easily.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @see __return_false()
</span><span class="lines">@@ -4396,9 +4396,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns false
</del><ins>+ * Returns false.
</ins><span class="cx"> *
</span><del>- * Useful for returning false to filters easily
</del><ins>+ * Useful for returning false to filters easily.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @see __return_true()
</span><span class="lines">@@ -4409,9 +4409,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns 0
</del><ins>+ * Returns 0.
</ins><span class="cx"> *
</span><del>- * Useful for returning 0 to filters easily
</del><ins>+ * Useful for returning 0 to filters easily.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @see __return_zero()
</span><span class="lines">@@ -4422,9 +4422,9 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns an empty array
</del><ins>+ * Returns an empty array.
</ins><span class="cx"> *
</span><del>- * Useful for returning an empty array to filters easily
</del><ins>+ * Useful for returning an empty array to filters easily.
</ins><span class="cx"> *
</span><span class="cx"> * @since 3.0.0
</span><span class="cx"> * @see __return_zero()
</span><span class="lines">@@ -4501,7 +4501,7 @@
</span><span class="cx"> * @since 3.1.0
</span><span class="cx"> * @access private
</span><span class="cx"> *
</span><del>- * @param callback $callback function that accupts ( ID, callback_arg, ... ) and outputs parent_ID
</del><ins>+ * @param callback $callback function that accepts ( ID, callback_arg, ... ) and outputs parent_ID
</ins><span class="cx"> * @param int $start The ID to start the loop check at
</span><span class="cx"> * @param array $override an array of ( ID => parent_ID, ... ) to use instead of $callback
</span><span class="cx"> * @param array $callback_args optional additional arguments to send to $callback
</span></span></pre>
</div>
</div>
</body>
</html>