aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/03_Backend/05_Extensions.md
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2025-04-07 08:47:42 +0200
committerGravatar GitHub <noreply@github.com> 2025-04-07 08:47:42 +0200
commit0c33d2713957eaf6cc0222150df7ebbcb53beaed (patch)
treea9a011c370e2d8ecf3c3290dfb1afd86c9cea0bc /docs/en/developers/03_Backend/05_Extensions.md
parentd3d9acca9f905fc03d6151f6ad75567256310831 (diff)
Secure serving of user files from extensions (#7495)
* Secure serving of user files from extensions fix https://github.com/FreshRSS/FreshRSS/issues/4930 * More fixes * Typo
Diffstat (limited to 'docs/en/developers/03_Backend/05_Extensions.md')
-rw-r--r--docs/en/developers/03_Backend/05_Extensions.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/en/developers/03_Backend/05_Extensions.md b/docs/en/developers/03_Backend/05_Extensions.md
index cf0fa3386..aeb693cba 100644
--- a/docs/en/developers/03_Backend/05_Extensions.md
+++ b/docs/en/developers/03_Backend/05_Extensions.md
@@ -116,7 +116,9 @@ The `Minz_Extension` abstract class defines a set of methods that can be overrid
The `Minz_Extension` abstract class defines another set of methods that should not be overridden:
* the `getName`, `getEntrypoint`, `getPath`, `getAuthor`, `getDescription`, `getVersion`, and `getType` methods return the extension internal properties. Those properties are extracted from the `metadata.json` file.
-* the `getFileUrl` returns the URL of the selected file. The file must exist in the `static` folder of the extension.
+* `getFileUrl(string $filename, bool $isStatic = true): string` will return the URL to a file in the `static` directory.
+ The first parameter is the name of the file (without `static/`).
+ Set `$isStatic` to true for user-independent files, and to `false` for files saved in a user’s own directory.
* the `registerController` method register an extension controller in FreshRSS. The selected controller must be defined in the extension *Controllers* folder, its file name must be `\<name\>Controller.php`, and its class name must be `FreshExtension_\<name\>_Controller`.
* the `registerViews` method registers the extension views in FreshRSS.
* the `registerTranslates` method registers the extension translation files in FreshRSS.