<!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>[38138] trunk/src/wp-admin/includes: Filesystem API: Change the default value for the `$context` parameter of `get_filesystem_method()` and `request_filesystem_credentials()` to an empty string.</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/38138">38138</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/38138","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-07-22 12:09:55 +0000 (Fri, 22 Jul 2016)</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'>Filesystem API: Change the default value for the `$context` parameter of `get_filesystem_method()` and `request_filesystem_credentials()` to an empty string.
`$context` is a full path to the directory that is tested for being writable. A path shouldn't be a boolean value.
This also updates `WP_Upgrader_Skin::request_filesystem_credentials()` and `Automatic_Upgrader_Skin::request_filesystem_credentials()` and adds missing docs.
Props DrewAPicture, ocean90.
Fixes <a href="https://core.trac.wordpress.org/ticket/37412">#37412</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclassautomaticupgraderskinphp">trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php</a></li>
<li><a href="#trunksrcwpadminincludesclasswpupgraderskinphp">trunk/src/wp-admin/includes/class-wp-upgrader-skin.php</a></li>
<li><a href="#trunksrcwpadminincludesfilephp">trunk/src/wp-admin/includes/file.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclassautomaticupgraderskinphp"></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-automatic-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php 2016-07-22 11:43:36 UTC (rev 38137)
+++ trunk/src/wp-admin/includes/class-automatic-upgrader-skin.php 2016-07-22 12:09:55 UTC (rev 38138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,11 +22,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $messages = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines whether the upgrader needs FTP/SSH details in order to connect
+ * to the filesystem.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $error
- * @param string $context
- * @param bool $allow_relaxed_file_ownership
- * @return bool
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.7.0
+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
+ *
+ * @see request_filesystem_credentials()
+ *
+ * @param bool $error Optional. Whether the current request has failed to connect.
+ * Default false.
+ * @param string $context Optional. Full path to the directory that is tested
+ * for being writable. Default empty.
+ * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
+ * @return bool True on success, false on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $context ) {
</span></span></pre></div>
<a id="trunksrcwpadminincludesclasswpupgraderskinphp"></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-upgrader-skin.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-upgrader-skin.php 2016-07-22 11:43:36 UTC (rev 38137)
+++ trunk/src/wp-admin/includes/class-wp-upgrader-skin.php 2016-07-22 12:09:55 UTC (rev 38138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,13 +66,22 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Displays a form to the user to request for their FTP/SSH details in order
+ * to connect to the filesystem.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $error
- * @param string $context
- * @param bool $allow_relaxed_file_ownership
- * @return type
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.8.0
+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
+ *
+ * @see request_filesystem_credentials()
+ *
+ * @param bool $error Optional. Whether the current request has failed to connect.
+ * Default false.
+ * @param string $context Optional. Full path to the directory that is tested
+ * for being writable. Default empty.
+ * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
+ * @return bool False on failure, true on success.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function request_filesystem_credentials( $error = false, $context = false, $allow_relaxed_file_ownership = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function request_filesystem_credentials( $error = false, $context = '', $allow_relaxed_file_ownership = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $url = $this->options['url'];
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $context ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $context = $this->options['context'];
</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 2016-07-22 11:43:36 UTC (rev 38137)
+++ trunk/src/wp-admin/includes/file.php 2016-07-22 12:09:55 UTC (rev 38138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -957,12 +957,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Optional. Connection details. Default empty array.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $context Optional. Full path to the directory that is tested
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * for being writable. Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * for being writable. Default empty.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string The transport to use, see description for valid return values.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function get_filesystem_method( $args = array(), $context = false, $allow_relaxed_file_ownership = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function get_filesystem_method( $args = array(), $context = '', $allow_relaxed_file_ownership = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $method = defined('FS_METHOD') ? FS_METHOD : false; // Please ensure that this is either 'direct', 'ssh2', 'ftpext' or 'ftpsockets'
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $context ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1027,15 +1027,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Displays a form to the user to request for their FTP/SSH details in order
</span><span class="cx" style="display: block; padding: 0 10px"> * to connect to the filesystem.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * All chosen/entered details are saved, Excluding the Password.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * All chosen/entered details are saved, excluding the password.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Hostnames may be in the form of hostname:portnumber (eg: wordpress.org:2467)
</span><span class="cx" style="display: block; padding: 0 10px"> * to specify an alternate FTP/SSH port.
</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 override this form by returning true|false via the
- * {@see 'request_filesystem_credentials'} filter.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Plugins may override this form by returning true|false via the {@see 'request_filesystem_credentials'} filter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @since 2.5.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 2.5.0
+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global string $pagenow
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1043,16 +1043,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $type Optional. Chosen type of filesystem. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param bool $error Optional. Whether the current request has failed to connect.
</span><span class="cx" style="display: block; padding: 0 10px"> * Default false.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $context Optional. Full path to the directory that is tested
- * for being writable. Default false.
- * @param array $extra_fields Optional. Extra POST fields which should be checked for
- * to be included in the post. Default null.
- * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable.
- * Default false.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $context Optional. Full path to the directory that is tested for being
+ * writable. Default empty.
+ * @param array $extra_fields Optional. Extra `POST` fields to be checked for inclusion in
+ * the post. Default null.
+ * @param bool $allow_relaxed_file_ownership Optional. Whether to allow Group/World writable. Default false.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool False on failure, true on success.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = false, $extra_fields = null, $allow_relaxed_file_ownership = false ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function request_filesystem_credentials( $form_post, $type = '', $error = false, $context = '', $extra_fields = null, $allow_relaxed_file_ownership = false ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $pagenow;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1062,6 +1061,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * output of the filesystem credentials form, returning that value instead.
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $output Form output to return instead. Default empty.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $form_post The URL to post the form to.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1160,6 +1160,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the connection types to output to the filesystem credentials form.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.6.0 The `$context` parameter default changed from `false` to an empty string.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $types Types of connections.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $credentials Credentials to connect with.
</span></span></pre>
</div>
</div>
</body>
</html>