Changeset 55205 for trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php

Timestamp:

02/03/2023 01:57:31 AM (3 years ago)

Author:

azaozz

Message:

Docs: Document directory support in FTP/SSH2 filesystem ::move() methods.

Props: costdev, flixos90, audrasjb.
Fixes: #57604.

File:

• trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php (modified) (1 diff)

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

@@ -359 +359 @@
 
     /**
-     * Moves a file.
-     *
-     * @since 2.5.0
-     *
-     * @param string $source      Path to the source file.
-     * @param string $destination Path to the destination file.
-     * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.
+     * Moves a file or directory.
+     *
+     * After moving files or directories, OPcache will need to be invalidated.
+     *
+     * If moving a directory fails, `copy_dir()` can be used for a recursive copy.
+     *
+     * Use `move_dir()` for moving directories with OPcache invalidation and a
+     * fallback to `copy_dir()`.
+     *
+     * @since 2.5.0
+     *
+     * @param string $source      Path to the source file or directory.
+     * @param string $destination Path to the destination file or directory.
+     * @param bool   $overwrite   Optional. Whether to overwrite the destination if it exists.
      *                            Default false.
      * @return bool True on success, false on failure.