| [ Index ] |
PHP Cross Reference of WordPress |
[Source view] [Print] [Project Stats]
Base WordPress Filesystem
| File Size: | 847 lines (23 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
WP_Filesystem_Base:: (39 methods):
abspath()
wp_content_dir()
wp_plugins_dir()
wp_themes_dir()
wp_lang_dir()
find_base_dir()
get_base_dir()
find_folder()
search_for_folder()
gethchmod()
getchmod()
getnumchmodfromh()
is_binary()
chown()
connect()
get_contents()
get_contents_array()
put_contents()
cwd()
chdir()
chgrp()
chmod()
owner()
group()
copy()
move()
delete()
exists()
is_file()
is_dir()
is_readable()
is_writable()
atime()
mtime()
size()
touch()
mkdir()
rmdir()
dirlist()
Class: WP_Filesystem_Base - X-Ref
Base WordPress Filesystem class which Filesystem implementations extend.| abspath() X-Ref |
| Returns the path on the remote filesystem of ABSPATH. return: string The location of the remote path. since: 2.7.0 |
| wp_content_dir() X-Ref |
| Returns the path on the remote filesystem of WP_CONTENT_DIR. return: string The location of the remote path. since: 2.7.0 |
| wp_plugins_dir() X-Ref |
| Returns the path on the remote filesystem of WP_PLUGIN_DIR. return: string The location of the remote path. since: 2.7.0 |
| wp_themes_dir( $theme = false ) X-Ref |
| Returns the path on the remote filesystem of the Themes Directory. return: string The location of the remote path. param: string|false $theme Optional. The theme stylesheet or template for the directory. since: 2.7.0 |
| wp_lang_dir() X-Ref |
| Returns the path on the remote filesystem of WP_LANG_DIR. return: string The location of the remote path. since: 3.2.0 |
| find_base_dir( $base = '.', $verbose = false ) X-Ref |
| Locates a folder on the remote filesystem. return: string The location of the remote path. param: string $base Optional. The folder to start searching from. Default '.'. param: bool $verbose Optional. True to display debug information. Default false. since: 2.5.0 |
| get_base_dir( $base = '.', $verbose = false ) X-Ref |
| Locates a folder on the remote filesystem. return: string The location of the remote path. param: string $base Optional. The folder to start searching from. Default '.'. param: bool $verbose Optional. True to display debug information. Default false. since: 2.5.0 |
| find_folder( $folder ) X-Ref |
| Locates a folder on the remote filesystem. Assumes that on Windows systems, Stripping off the Drive letter is OK Sanitizes \\ to / in Windows filepaths. return: string|false The location of the remote path, false on failure. param: string $folder the folder to locate. since: 2.7.0 |
| search_for_folder( $folder, $base = '.', $loop = false ) X-Ref |
| Locates a folder on the remote filesystem. Expects Windows sanitized path. return: string|false The location of the remote path, false to cease looping. param: string $folder The folder to locate. param: string $base The folder to start searching from. param: bool $loop If the function has recursed. Internal use only. since: 2.7.0 |
| gethchmod( $file ) X-Ref |
| Returns the *nix-style file permissions for a file. From the PHP documentation page for fileperms(). return: string The *nix-style representation of permissions. param: string $file String filename. since: 2.5.0 |
| getchmod( $file ) X-Ref |
| Gets the permissions of the specified file or filepath in their octal format. return: string Mode of the file (the last 3 digits). param: string $file Path to the file. since: 2.5.0 |
| getnumchmodfromh( $mode ) X-Ref |
| Converts *nix-style file permissions to a octal number. Converts '-rw-r--r--' to 0644 From "info at rvgate dot nl"'s comment on the PHP documentation for chmod() return: string Octal representation of permissions. param: string $mode string The *nix-style file permissions. since: 2.5.0 |
| is_binary( $text ) X-Ref |
| Determines if the string provided contains binary characters. return: bool True if string is binary, false otherwise. param: string $text String to test against. since: 2.7.0 |
| chown( $file, $owner, $recursive = false ) X-Ref |
| Changes the owner of a file or directory. Default behavior is to do nothing, override this in your subclass, if desired. return: bool True on success, false on failure. param: string $file Path to the file or directory. param: string|int $owner A user name or number. param: bool $recursive Optional. If set to true, changes file owner recursively. since: 2.5.0 |
| connect() X-Ref |
| Connects filesystem. return: bool True on success, false on failure (always true for WP_Filesystem_Direct). since: 2.5.0 |
| get_contents( $file ) X-Ref |
| Reads entire file into a string. return: string|false Read data on success, false on failure. param: string $file Name of the file to read. since: 2.5.0 |
| get_contents_array( $file ) X-Ref |
| Reads entire file into an array. return: array|false File contents in an array on success, false on failure. param: string $file Path to the file. since: 2.5.0 |
| put_contents( $file, $contents, $mode = false ) X-Ref |
| Writes a string to a file. return: bool True on success, false on failure. param: string $file Remote path to the file where to write the data. param: string $contents The data to write. param: int|false $mode Optional. The file permissions as octal number, usually 0644. since: 2.5.0 |
| cwd() X-Ref |
| Gets the current working directory. return: string|false The current working directory on success, false on failure. since: 2.5.0 |
| chdir( $dir ) X-Ref |
| Changes current directory. return: bool True on success, false on failure. param: string $dir The new current directory. since: 2.5.0 |
| chgrp( $file, $group, $recursive = false ) X-Ref |
| Changes the file group. return: bool True on success, false on failure. param: string $file Path to the file. param: string|int $group A group name or number. param: bool $recursive Optional. If set to true, changes file group recursively. since: 2.5.0 |
| chmod( $file, $mode = false, $recursive = false ) X-Ref |
| Changes filesystem permissions. return: bool True on success, false on failure. param: string $file Path to the file. param: int|false $mode Optional. The permissions as octal number, usually 0644 for files, param: bool $recursive Optional. If set to true, changes file permissions recursively. since: 2.5.0 |
| owner( $file ) X-Ref |
| Gets the file owner. return: string|false Username of the owner on success, false on failure. param: string $file Path to the file. since: 2.5.0 |
| group( $file ) X-Ref |
| Gets the file's group. return: string|false The group on success, false on failure. param: string $file Path to the file. since: 2.5.0 |
| copy( $source, $destination, $overwrite = false, $mode = false ) X-Ref |
| Copies a file. return: bool True on success, false on failure. 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. param: int|false $mode Optional. The permissions as octal number, usually 0644 for files, since: 2.5.0 |
| move( $source, $destination, $overwrite = false ) X-Ref |
| Moves a file. return: bool True on success, false on failure. 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. since: 2.5.0 |
| delete( $file, $recursive = false, $type = false ) X-Ref |
| Deletes a file or directory. return: bool True on success, false on failure. param: string $file Path to the file or directory. param: bool $recursive Optional. If set to true, deletes files and folders recursively. param: string|false $type Type of resource. 'f' for file, 'd' for directory. since: 2.5.0 |
| exists( $file ) X-Ref |
| Checks if a file or directory exists. return: bool Whether $file exists or not. param: string $file Path to file or directory. since: 2.5.0 |
| is_file( $file ) X-Ref |
| Checks if resource is a file. return: bool Whether $file is a file. param: string $file File path. since: 2.5.0 |
| is_dir( $path ) X-Ref |
| Checks if resource is a directory. return: bool Whether $path is a directory. param: string $path Directory path. since: 2.5.0 |
| is_readable( $file ) X-Ref |
| Checks if a file is readable. return: bool Whether $file is readable. param: string $file Path to file. since: 2.5.0 |
| is_writable( $file ) X-Ref |
| Checks if a file or directory is writable. return: bool Whether $file is writable. param: string $file Path to file or directory. since: 2.5.0 |
| atime( $file ) X-Ref |
| Gets the file's last access time. return: int|false Unix timestamp representing last access time, false on failure. param: string $file Path to file. since: 2.5.0 |
| mtime( $file ) X-Ref |
| Gets the file modification time. return: int|false Unix timestamp representing modification time, false on failure. param: string $file Path to file. since: 2.5.0 |
| size( $file ) X-Ref |
| Gets the file size (in bytes). return: int|false Size of the file in bytes on success, false on failure. param: string $file Path to file. since: 2.5.0 |
| touch( $file, $time = 0, $atime = 0 ) X-Ref |
| Sets the access and modification times of a file. Note: If $file doesn't exist, it will be created. return: bool True on success, false on failure. param: string $file Path to file. param: int $time Optional. Modified time to set for file. param: int $atime Optional. Access time to set for file. since: 2.5.0 |
| mkdir( $path, $chmod = false, $chown = false, $chgrp = false ) X-Ref |
| Creates a directory. return: bool True on success, false on failure. param: string $path Path for new directory. param: int|false $chmod Optional. The permissions as octal number (or false to skip chmod). param: string|int|false $chown Optional. A user name or number (or false to skip chown). param: string|int|false $chgrp Optional. A group name or number (or false to skip chgrp). since: 2.5.0 |
| rmdir( $path, $recursive = false ) X-Ref |
| Deletes a directory. return: bool True on success, false on failure. param: string $path Path to directory. param: bool $recursive Optional. Whether to recursively remove files/directories. since: 2.5.0 |
| dirlist( $path, $include_hidden = true, $recursive = false ) X-Ref |
| Gets details for files in a directory or a specific file. return: array|false { param: string $path Path to directory or file. param: bool $include_hidden Optional. Whether to include details of hidden ("." prefixed) files. param: bool $recursive Optional. Whether to recursively include file details in nested directories. since: 2.5.0 |
| Generated: Sat Nov 23 01:00:02 2024 | Cross-referenced by PHPXref 0.7.1 |