chore: add fiels param in readme and phpdoc (#8)

Yizack · Jul 22, 2024 · af00cb3 · af00cb3
1 parent e583e7f
commit af00cb3
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -43,6 +43,13 @@ foreach ($feed->getFeed() as $value) {
 }
 ```
 
+The `getFeed()` function also accepts a comma-separated list of fields to be returned.
+```php
+$array = $feed->getFeed("username,permalink,timestamp,caption,media_url");
+```
+
+For a list of all available fields see: https://developers.facebook.com/docs/instagram-basic-display-api/reference/media#fields
+
 ## About the code
 ### `InstagramFeed` constructor arguments
 

diff --git a/src/InstagramFeed.php b/src/InstagramFeed.php
@@ -37,6 +37,14 @@ protected function refreshToken() {
         }
     }
 
+    /**
+     * Get Instagram feed
+     * 
+     * For a list of all available fields see: https://developers.facebook.com/docs/instagram-basic-display-api/reference/media#fields
+     * 
+     * @param string|null $fields Comma-separated list of fields to retrieve. Defaults to 'username,permalink,timestamp,caption'.
+     * @return array The Instagram feed data.
+     */
     function getFeed($fields = null) {
         $fields = $fields ?? 'username,permalink,timestamp,caption';
         $this->refreshToken();