![[Warning]](/media/com_docimport/admonition/warning.png) | Warning |
|---|---|
|
DEPRECATED - This method will be removed in Akeeba Backup for Joomla 10, Akeeba Backup for WordPress 8, and Akeeba Solo 8. Versions of our software released after September 2023 may no longer include this method even if their major version is below those specified in this message. |
Returns the list of subdirectories and directory information for a requested folder. Used to implement directory browsers, e.g. for the output directory.
Available since API version 340.
Request Data expected
- folder
-
String. The absolute folder to list. Empty to list the site's root.
- processfolder
-
Integer. 1 to process folder variables, e.g. [DEFAULT_OUTPUT], in the folder name.
Response Data returned
A JSON object with the following keys:
- folder
-
String. The path to the folder.
- folder_raw
-
String. The path to the folder before replacing folder variables.
- parent
-
String. The path to the folder's parent.
- exists
-
Boolean. Does the folder really exist?
- inRoot
-
Boolean. Is this folder under the site's root? False means that the folder is above the site's root.
- openbasedirRestricted
-
Boolean. Is this folder restricted by open_basedir?
- writable
-
Boolean. Is the folder writable?
- subfolders
-
Array of String. The names of the folder's subdirectories. Does NOT include the current (.) and parent (..) items.
- breadcrumbs
-
Array of Array. Breadcrumbs leading to the folder. Each breadcrumb has the following keys:
- label
-
The breadcrumb part to display (name of the breadcrumb folder).
- folder
-
The absolute path to the folder this breadcrumb points to. You can use that as the folder argument in a follow-up browse API call.