From 85b87b9597fafefa026b9436edb886f9db123ae2 Mon Sep 17 00:00:00 2001 From: Justin Goette <53531335+jcgoette@users.noreply.github.com> Date: Fri, 28 Oct 2022 21:30:49 -0400 Subject: [PATCH] docs: Document `returnFull` parameter of `getContents` (#3120) --- docs/06_Helper_functions/index.md | 1 + 1 file changed, 1 insertion(+) 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');