Changeset 37270

Timestamp:

04/21/2016 02:37:36 AM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add missing return descriptions for WP_Filesystem_SSH2::chown() and WP_Filesystem_SSH2::run_command().

Fixes #30989.

File:

• trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

@@ -194 +194 @@
      * @param string $command
      * @param bool $returnbool
-     * @return bool|string
+     * @return bool|string True on success, false on failure. String if the command was executed, `$returnbool`
+     *                     is false (default), and data from the resulting stream was retrieved.
      */
     public function run_command( $command, $returnbool = false ) {
@@ -331 +332 @@
      * @access public
      *
-     * @param string     $file    Path to the file.
-     * @param string|int $owner   A user name or number.
-     * @param bool       $recursive Optional. If set True changes file owner recursivly. Defaults to False.
-     * @return bool|string Returns true on success or false on failure.
+     * @param string     $file      Path to the file.
+     * @param string|int $owner     A user name or number.
+     * @param bool       $recursive Optional. If set True changes file owner recursivly. Default False.
+     * @return bool True on success or false on failure.
      */
     public function chown( $file, $owner, $recursive = false ) {