diff options
| author |  Justin Goette <53531335+jcgoette@users.noreply.github.com>
| 2022-10-28 21:30:49 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-10-29 03:30:49 +0200 |
| commit | 85b87b9597fafefa026b9436edb886f9db123ae2 (patch) | |
| tree | 2cee2845543c479c3f781a1eed8e0c081b4d6b28 /docs/06_Helper_functions/index.md | |
| parent | bef6fc5cbd85e945d7c63ece6c9d54a5cb5f5c9f (diff) | |
| download | rss-bridge-85b87b9597fafefa026b9436edb886f9db123ae2.tar.gz rss-bridge-85b87b9597fafefa026b9436edb886f9db123ae2.tar.zst rss-bridge-85b87b9597fafefa026b9436edb886f9db123ae2.zip | |
docs: Document `returnFull` parameter of `getContents` (#3120)
Diffstat (limited to 'docs/06_Helper_functions/index.md')
| -rw-r--r-- | docs/06_Helper_functions/index.md | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/docs/06_Helper_functions/index.md b/docs/06_Helper_functions/index.md index 708155a8..860e8d10 100644 --- a/docs/06_Helper_functions/index.md +++ b/docs/06_Helper_functions/index.md @@ -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'); |