WP_Filesystem_Base
class WP_Filesystem_Base
// Constructor: function Object() { [native code] } Base WordPress Filesystem class which Filesystem implementations extend.
Methods 39 methods
| Method / Return | Description |
|---|---|
| abspath() string | Returns the path on the remote filesystem of ABSPATH. |
| wp_content_dir() string | Returns the path on the remote filesystem of WP_CONTENT_DIR. |
| wp_plugins_dir() string | Returns the path on the remote filesystem of WP_PLUGIN_DIR. |
| wp_themes_dir() string | Returns the path on the remote filesystem of the Themes Directory.
Parameters: $theme: mixed |
| wp_lang_dir() string | Returns the path on the remote filesystem of WP_LANG_DIR. |
| find_base_dir() string | Locates a folder on the remote filesystem.
Parameters: $base: mixed, $verbose: mixed |
| get_base_dir() string | Locates a folder on the remote filesystem.
Parameters: $base: mixed, $verbose: mixed |
| find_folder() (string | Locates a folder on the remote filesystem.
Parameters: $folder: mixed |
| search_for_folder() (string | Locates a folder on the remote filesystem.
Parameters: $folder: mixed, $base: mixed, $loop: mixed |
| gethchmod() string | Returns the *nix-style file permissions for a file.
Parameters: $file: mixed |
| getchmod() string | Gets the permissions of the specified file or filepath in their octal format.
Parameters: $file: mixed |
| getnumchmodfromh() string | Converts *nix-style file permissions to an octal number.
Parameters: $mode: mixed |
| is_binary() bool | Determines if the string provided contains binary characters.
Parameters: $text: mixed |
| chown() bool | Changes the owner of a file or directory.
Parameters: $file: mixed, $owner: mixed, $recursive: mixed |
| connect() bool | Connects filesystem. |
| get_contents() (string | Reads entire file into a string.
Parameters: $file: mixed |
| get_contents_array() (array | Reads entire file into an array.
Parameters: $file: mixed |
| put_contents() bool | Writes a string to a file.
Parameters: $file: mixed, $contents: mixed, $mode: mixed |
| cwd() (string | Gets the current working directory. |
| chdir() bool | Changes current directory.
Parameters: $dir: mixed |
| chgrp() bool | Changes the file group.
Parameters: $file: mixed, $group: mixed, $recursive: mixed |
| chmod() bool | Changes filesystem permissions.
Parameters: $file: mixed, $mode: mixed, $recursive: mixed |
| owner() (string | Gets the file owner.
Parameters: $file: mixed |
| group() (string | Gets the file's group.
Parameters: $file: mixed |
| copy() bool | Copies a file.
Parameters: $source: mixed, $destination: mixed, $overwrite: mixed, $mode: mixed |
| move() bool | Moves a file.
Parameters: $source: mixed, $destination: mixed, $overwrite: mixed |
| delete() bool | Deletes a file or directory.
Parameters: $file: mixed, $recursive: mixed, $type: mixed |
| exists() bool | Checks if a file or directory exists.
Parameters: $path: mixed |
| is_file() bool | Checks if resource is a file.
Parameters: $file: mixed |
| is_dir() bool | Checks if resource is a directory.
Parameters: $path: mixed |
| is_readable() bool | Checks if a file is readable.
Parameters: $file: mixed |
| is_writable() bool | Checks if a file or directory is writable.
Parameters: $path: mixed |
| atime() (int | Gets the file's last access time.
Parameters: $file: mixed |
| mtime() (int | Gets the file modification time.
Parameters: $file: mixed |
| size() (int | Gets the file size (in bytes).
Parameters: $file: mixed |
| touch() bool | Sets the access and modification times of a file.
Parameters: $file: mixed, $time: mixed, $atime: mixed |
| mkdir() bool | Creates a directory.
Parameters: $path: mixed, $chmod: mixed, $chown: mixed, $chgrp: mixed |
| rmdir() bool | Deletes a directory.
Parameters: $path: mixed, $recursive: mixed |
| dirlist() (array | Gets details for files in a directory or a specific file.
Parameters: $path: mixed, $include_hidden: mixed, $recursive: mixed |
Properties
| Property / Type | Description |
|---|---|
| $verbose mixed public | No description available. |
| $cache mixed public | No description available. |
| $method mixed public | No description available. |
| $errors mixed public | No description available. |
| $options mixed public | No description available. |