<!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>[30753] trunk/src: Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for 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/30753">30753</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/30753","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>2014-12-06 21:23:52 +0000 (Sat, 06 Dec 2014)</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'>Convert various uses of `(optional)` in core parameter descriptions to use the style prescribed in the inline documentation standards for PHP.
The style for marking parameters optional in inline PHP docs is: `@param type $var Optional. Description. Accepts. Default.`, where Accepts can be omitted on a case-by-case basis.
Props coffee2code.
Fixes <a href="https://core.trac.wordpress.org/ticket/30591">#30591</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpfilesystemdirectphp">trunk/src/wp-admin/includes/class-wp-filesystem-direct.php</a></li>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
<li><a href="#trunksrcwpadminincludespostphp">trunk/src/wp-admin/includes/post.php</a></li>
<li><a href="#trunksrcwpincludesclasswpscriptsphp">trunk/src/wp-includes/class.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesdeprecatedphp">trunk/src/wp-includes/deprecated.php</a></li>
<li><a href="#trunksrcwpincludeslinktemplatephp">trunk/src/wp-includes/link-template.php</a></li>
<li><a href="#trunksrcwpincludesmetaphp">trunk/src/wp-includes/meta.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpfilesystemdirectphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-filesystem-direct.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-filesystem-direct.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-admin/includes/class-wp-filesystem-direct.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -49,10 +49,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Write a string to a file
</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 $file Remote path to the file where to write the data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file Remote path to the file where to write the data.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $contents The data to write.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $mode (optional) The file permissions as octal number, usually 0644.
- * @return bool False upon failure.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $mode Optional. The file permissions as octal number, usually 0644.
+ * Default false.
+ * @return bool False upon failure, true otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function put_contents( $file, $contents, $mode = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $fp = @fopen( $file, 'wb' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -99,9 +100,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Changes file group
</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 $file Path to the file.
- * @param mixed $group A group name or number.
- * @param bool $recursive (optional) If set True changes file group recursively. Defaults to False.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file Path to the file.
+ * @param mixed $group A group name or number.
+ * @param bool $recursive Optional. If set True changes file group recursively. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Returns true on success or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function chgrp($file, $group, $recursive = false) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -123,9 +124,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Changes filesystem permissions
</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 $file Path to the file.
- * @param int $mode (optional) The permissions as octal number, usually 0644 for files, 0755 for dirs.
- * @param bool $recursive (optional) If set True changes file group recursively. Defaults to False.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file Path to the file.
+ * @param int $mode Optional. The permissions as octal number, usually 0644 for files,
+ * 0755 for dirs. Default false.
+ * @param bool $recursive Optional. If set True changes file group recursively. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Returns true on success or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function chmod($file, $mode = false, $recursive = false) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,9 +154,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Changes file owner
</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 $file Path to the file.
- * @param mixed $owner A user name or number.
- * @param bool $recursive (optional) If set True changes file owner recursively. Defaults to False.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file Path to the file.
+ * @param mixed $owner A user name or number.
+ * @param bool $recursive Optional. If set True changes file owner recursively.
+ * Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool Returns true on success or false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function chown($file, $owner, $recursive = false) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesfilephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/file.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/file.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-admin/includes/file.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -97,8 +97,8 @@
</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 $folder Full path to folder
- * @param int $levels (optional) Levels of folders to follow, Default: 100 (PHP Loop limit).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $folder Optional. Full path to folder. Default empty.
+ * @param int $levels Optional. Levels of folders to follow, Default 100 (PHP Loop limit).
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool|array False on failure, Else array of files
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function list_files( $folder = '', $levels = 100 ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -137,8 +137,8 @@
</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 $filename (optional) Filename to base the Unique file off
- * @param string $dir (optional) Directory to store the file in
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $filename Optional. Filename to base the Unique file off. Default empty.
+ * @param string $dir Optional. Directory to store the file in. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string a writable filename
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_tempnam($filename = '', $dir = '') {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,14 +805,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Initialises and connects the WordPress Filesystem Abstraction classes.
</span><span class="cx" style="display: block; padding: 0 10px"> * This function will include the chosen transport and attempt connecting.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Plugins may add extra transports, And force WordPress to use them by returning the filename via the 'filesystem_method_file' filter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Plugins may add extra transports, And force WordPress to use them by returning
+ * the filename via the {@see 'filesystem_method_file'} filter.
</ins><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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $args (optional) Connection args, These are passed directly to the WP_Filesystem_*() classes.
- * @param string $context (optional) Context for get_filesystem_method(), See function declaration for more information.
- * @param bool $allow_relaxed_file_ownership Whether to allow Group/World writable.
- * @return null|boolean false on failure, true on success
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $args Optional. Connection args, These are passed directly to
+ * the `WP_Filesystem_*()` classes. Default false.
+ * @param string $context Optional. Context for {@see get_filesystem_method()}.
+ * Default false.
+ * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
+ * Default false.
+ * @return null|boolean false on failure, true on success.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function WP_Filesystem( $args = false, $context = false, $allow_relaxed_file_ownership = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_filesystem;
</span></span></pre></div>
<a id="trunksrcwpadminincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/post.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-admin/includes/post.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1116,14 +1116,14 @@
</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">- * {@internal Missing Short Description}}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Get a sample permalink based off of the post name.
</ins><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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param integer $id Post ID or post object.
- * @param string $title (optional) Title
- * @param string $name (optional) Name
- * @return array With two entries of type string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id Post ID or post object.
+ * @param string $title Optional. Title. Default null.
+ * @param string $name Optional. Name. Default null.
+ * @return array Arra yith two entries of type string.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_sample_permalink($id, $title = null, $name = null) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post = get_post( $id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1185,9 +1185,9 @@
</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="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param integer $id Post ID or post object.
- * @param string $new_title Optional. New title.
- * @param string $new_slug Optional. New slug.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $id Post ID or post object.
+ * @param string $new_title Optional. New title. Default null.
+ * @param string $new_slug Optional. New slug. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The HTML of the sample permalink slug editor.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_sample_permalink_html( $id, $new_title = null, $new_slug = null ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpscriptsphp"></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-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class.wp-scripts.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/class.wp-scripts.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -47,13 +47,15 @@
</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">- * Prints scripts
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prints scripts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Prints the scripts passed to it or the print queue. Also prints all necessary dependencies.
</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 mixed $handles (optional) Scripts to be printed. (void) prints queue, (string) prints that script, (array of strings) prints those scripts.
- * @param int $group (optional) If scripts were queued in groups prints this group number.
- * @return array Scripts that have been printed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param mixed $handles Optional. Scripts to be printed. (void) prints queue, (string) prints
+ * that script, (array of strings) prints those scripts. Default false.
+ * @param int $group Optional. If scripts were queued in groups prints this group number.
+ * Default false.
+ * @return array Scripts that have been printed.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function print_scripts( $handles = false, $group = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->do_items( $handles, $group );
</span></span></pre></div>
<a id="trunksrcwpincludesdeprecatedphp"></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/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/deprecated.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/deprecated.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1214,7 +1214,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $username The user's username.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password The user's password.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $email The user's email (optional).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $email The user's email.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int The new user's ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function create_user($username, $password, $email) {
</span></span></pre></div>
<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 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/link-template.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2587,13 +2587,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve the home url for the current site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the 'home' option with the appropriate protocol, 'https' if
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
- * overridden.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is overridden.
</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 string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the home url. Default empty.
+ * @param string $scheme Optional. Scheme to give the home url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Home 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 home_url( $path = '', $scheme = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2604,15 +2605,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve the home url for a given site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the 'home' option with the appropriate protocol, 'https' if
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is
</ins><span class="cx" style="display: block; padding: 0 10px"> * overridden.
</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 int $blog_id (optional) Blog ID. Defaults to current blog.
- * @param string $path (optional) Path relative to the home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
- * @return string Home url link with optional path appended.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $blog_id Optional. Blog ID. Default null (current blog).
+ * @param string $path Optional. Path relative to the home URL. Default empty.
+ * @param string|null $orig_scheme Optional. Scheme to give the home URL context. Accepts
+ * 'http', 'https', 'relative', or null. Default null.
+ * @return string Home URL link with optional path appended.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_home_url( $blog_id = null, $path = '', $scheme = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $orig_scheme = $scheme;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2671,14 +2674,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Retrieve the site url for a given site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns the 'site_url' option with the appropriate protocol, 'https' if
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
- * overridden.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * {@see is_ssl()} and 'http' otherwise. If `$scheme` is 'http' or 'https',
+ * `is_ssl()` is overridden.
</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 $blog_id (optional) Blog ID. Defaults to current blog.
- * @param string $path Optional. Path relative to the site url.
- * @param string $scheme Optional. Scheme to give the site url context. Currently 'http', 'https', 'login', 'login_post', 'admin', or 'relative'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int $blog_id Optional. Blog ID. Default null (current site).
+ * @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', 'login', 'login_post', 'admin', 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 get_site_url( $blog_id = null, $path = '', $scheme = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2723,13 +2728,15 @@
</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">- * Retrieve the url to the admin area for a given site.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the url to the admin area for a given site.
</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 $blog_id (optional) Blog ID. Defaults to current blog.
- * @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 int $blog_id Optional. Blog ID. Default null (current site).
+ * @param string $path Optional. Path relative to the admin url. Default empty.
+ * @param string $scheme Optional. The scheme to use. Accepts 'http' or 'https',
+ * to force those schemes. Default 'admin', which obeys
+ * {@see force_ssl_admin()} and {@see 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">@@ -2896,16 +2903,17 @@
</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">- * Retrieve the home url for the current network.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the home url for the current network.
</ins><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' if
- * is_ssl() and 'http' otherwise. If $scheme is 'http' or 'https', is_ssl() is
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the home url with the appropriate protocol, 'https' {@see is_ssl()}
+ * and 'http' otherwise. If `$scheme` is 'http' or 'https', `is_ssl()` is
</ins><span class="cx" style="display: block; padding: 0 10px"> * overridden.
</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 home url.
- * @param string $scheme (optional) Scheme to give the home url context. Currently 'http', 'https', or 'relative'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Optional. Path relative to the home url. Default empty.
+ * @param string $scheme Optional. Scheme to give the home url context. Accepts
+ * 'http', 'https', or 'relative'. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string Home 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_home_url( $path = '', $scheme = null ) {
</span></span></pre></div>
<a id="trunksrcwpincludesmetaphp"></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/meta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/meta.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/meta.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -840,18 +840,18 @@
</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">- * Given a meta query, generates SQL clauses to be appended to a main query
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given a meta query, generates SQL clauses to be appended to a main query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Meta_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 array $meta_query A meta query
- * @param string $type Type of meta
- * @param string $primary_table
- * @param string $primary_id_column
- * @param object $context (optional) The main query object
- * @return array( 'join' => $join_sql, 'where' => $where_sql )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param array $meta_query A meta query.
+ * @param string $type Type of meta.
+ * @param string $primary_table Primary database table name.
+ * @param string $primary_id_column Primary ID column name.
+ * @param object $context Optional. The main query object
+ * @return array Associative array of `JOIN` and `WHERE` SQL.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function get_meta_sql( $meta_query, $type, $primary_table, $primary_id_column, $context = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_query_obj = new WP_Meta_Query( $meta_query );
</span></span></pre></div>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/user.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2015,14 +2015,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * A simpler way of inserting an user into the database.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Creates a new user with just the username, password, and email. For more
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * complex user creation use wp_insert_user() to specify more information.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * complex user creation use {@see wp_insert_user()} to specify more information.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @see wp_insert_user() More complete way to create a new user
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $username The user's username.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $password The user's password.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $email The user's email (optional).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $email Optional. The user's email. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int The new user's ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_create_user($username, $password, $email = '') {
</span></span></pre></div>
<a id="trunksrcwpincludeswpdbphp"></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/wp-db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/wp-db.php 2014-12-06 21:23:12 UTC (rev 30752)
+++ trunk/src/wp-includes/wp-db.php 2014-12-06 21:23:52 UTC (rev 30753)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -735,8 +735,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 resource $dbh The resource given by mysql_connect
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $charset The character set (optional)
- * @param string $collate The collation (optional)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $charset Optional. The character set. Default null.
+ * @param string $collate Optional. The collation. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function set_charset( $dbh, $charset = null, $collate = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $charset ) )
</span></span></pre>
</div>
</div>
</body>
</html>