1
0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-01-17 14:18:35 +01:00

docs: Document returnFull parameter of getContents (#3120)

This commit is contained in:
Justin Goette 2022-10-28 21:30:49 -04:00 committed by GitHub
parent bef6fc5cbd
commit 85b87b9597
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -15,6 +15,7 @@ The `getContents` function uses [cURL](https://secure.php.net/manual/en/book.cur
| `url` | string | *required* | The URL of the contents to acquire
| `header` | array | *optional* | An array of HTTP header fields to set, in the format `array('Content-type: text/plain', 'Content-length: 100')`, see [CURLOPT_HTTPHEADER](https://secure.php.net/manual/en/function.curl-setopt.php)
| `opts` | array | *optional* | An array of cURL options in the format `array(CURLOPT_POST => 1);`, see [curl_setopt](https://secure.php.net/manual/en/function.curl-setopt.php) for a complete list of options.
| `returnFull` | boolean | *optional* | Specifies whether to return the response body from cURL (default) or the response body, code, headers, etc.
```PHP
$header = array('Content-type:text/plain', 'Content-length: 100');