PHPackages                             tkijewski/reddit-php-sdk - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. tkijewski/reddit-php-sdk

ActiveLibrary[API Development](/categories/api)

tkijewski/reddit-php-sdk
========================

Fork of jcleblanc/reddit-php-sdk with improvements

08.3k3PHP

Since May 15Pushed 7y agoCompare

[ Source](https://github.com/tkthundr/reddit-php-sdk)[ Packagist](https://packagist.org/packages/tkijewski/reddit-php-sdk)[ RSS](/packages/tkijewski-reddit-php-sdk/feed)WikiDiscussions master Synced 4w ago

READMEChangelogDependenciesVersions (1)Used By (0)

Reddit PHP SDK
==============

[](#reddit-php-sdk)

The Reddit SDK is a wrapper around the Reddit OAuth 2 API:

Installation
============

[](#installation)

The preferred way to install this extension is through .

```
composer require tkijewski/reddit-php-sdk:*
```

Initiating Your Login Session & Simple Example
--------------------------------------------------

[](#initiating-your-login-session--simple-example)

Before making requests to any of the methods of the Reddit SDK, you first need to instantiate a new OAuth 2 session by using your client id and client secret. You may obtain these keys by creating a new app at

### Before redirect

[](#before-redirect)

```
$reddit = new \reddit($client_id,$client_secret);
$callbackUrl = "http://www.mysite.com/reddit-auth";
$url = $reddit->getLoginUrl($callbackUrl);
header("Location: $url");
```

### After redirect

[](#after-redirect)

```
$reddit = new \reddit($client_id,$client_secret);
$callbackUrl = "http://www.mysite.com/reddit-auth"; //THIS URL MUST BE THE SAME AS ABOVE
//AS OF NOW THIS REQUEST USES duration=permanent WHICH INCLUDES A REFRESH TOKEN!
$token = $reddit->getOAuthToken($_REQUEST['code'],$oauth_callbackUrl);
$reddit->setOAuthToken($token->access_token);
$info = $reddit->getUser();
```

How to Build the Fullname Parameters
------------------------------------

[](#how-to-build-the-fullname-parameters)

Frequently within these SDK methods, you will see parameters that reference the fullname or id of a message, comment, account, etc (e.g. values like t4\_1kuinv). The Reddit API uses identifiers that consist of a prefix to identify the type of the fullname (e.g. t3\_ or t4\_), and the identifier of that thing (e.g. 1kuinv). To build a fullname of a thing, you must take its id, and add the prefix to the front.

The following is a list of prefixes that the Reddit API uses, and the type of thing that they reference:

- t1\_ : Comment
- t2\_ : Account
- t3\_ : Link
- t4\_ : Message
- t5\_ : Subreddit
- t6\_ : Award
- t8\_ : PromoCampaign

SDK Methods
-----------

[](#sdk-methods)

Once you are authenticated, you may then make requests to any of the methods in the SDK.

**Getting an OAuth Login URL**
Generates a login url for generating an OAuth code
@link
@param string $callbackUrl The callback URL that reddit will send the user to after authorization
@return string $url A clickable url ready for use

```
$callbackUrl = "http://www.mysite.com/reddit-auth
$url = $reddit->getLoginUrl($callbackUrl);
```

**Getting a token from a code**
Generates a token from a code. Note the callbackUrl is still required
@link
@param string $code The code returned by reddit
@param string $callbackUrl The same callback url provided for the getLoginUrl function
@return object $token

```
$token = $reddit->getOAuthToken($_REQUEST['code'],$callbackUrl);
```

**Setting a token**
Sets the token for the session
@link
@param string $access\_token The token provided by the getOAuthToken function

```
$reddit->setOAuthToken($access_token);
```

**Needs CAPTCHA**
Checks whether CAPTCHAs are needed for API endpoints
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_needs\_captcha.json](http://www.reddit.com/dev/api/oauth#GET_api_needs_captcha.json)

```
$response = $reddit->getCaptchaReqs();
```

**Get New CAPTCHA**
Gets the iden of a new CAPTCHA, if the user cannot read the current one
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_new\_captcha](http://www.reddit.com/dev/api/oauth#POST_api_new_captcha)

```
$response = $reddit->getNewCaptcha();
$iden = $response->json->data->iden;
```

**Get CAPTCHA Image**
Fetches a new CAPTCHA image from a given iden value
@link [http://www.reddit.com/dev/api/oauth#GET\_captcha\_{iden}](http://www.reddit.com/dev/api/oauth#GET_captcha_{iden})
@param string $iden The iden value of a new CAPTCHA from getNewCaptcha method

```
$response = $reddit->getNewCaptcha();
$iden = $response->json->data->iden;
$image = $reddit->getCaptchaImg($iden);
$im = imagecreatefromstring($image);
if ($im !== false){
    header('Content-Type: image/png');
    imagepng($im);
    imagedestroy($im);
} else {
    echo 'An error occurred';
}
```

**Creating a New Story**
Creates a new story on a particular subreddit
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_submit](http://www.reddit.com/dev/api/oauth#POST_api_submit)
@param string $title The title of the story
@param string $link The link that the story should forward to
@param string $subreddit The subreddit where the story should be added

```
$title = "MakerBot Releases IPad App For Easy 3D Printing";
$link = "http://makezine.com/2014/07/01/makerbot-realeases-ipad-app-for-easy-3d-printing/";
$subreddit = "technology";
$response = $reddit->createStory($title, $link, $subreddit);
```

**Get User Information**
Get data for the current user
@link [http://www.reddit.com/dev/api#GET\_api\_v1\_me](http://www.reddit.com/dev/api#GET_api_v1_me)

```
$userData = $reddit->getUser();
```

**Get User Preferences**
Get preference data for the current user based on fields provided
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_v1\_me\_prefs](http://www.reddit.com/dev/api/oauth#GET_api_v1_me_prefs)
@param string $fields A comma separated list of pref data to return. Full list at
 [http://www.reddit.com/dev/api/oauth#GET\_api\_v1\_me\_prefs](http://www.reddit.com/dev/api/oauth#GET_api_v1_me_prefs).

```
$userPrefs = $reddit->getUserPrefs("num_comments,min_comment_score,private_feeds");
```

**Get User Trophies**
Get current user trophies
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_v1\_me\_trophies](http://www.reddit.com/dev/api/oauth#GET_api_v1_me_trophies)

```
$userTrophies = $reddit->getUserTrophies();
```

**Get User Karma Information**
Get breakdown of karma for the current user
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_v1\_me\_karma](http://www.reddit.com/dev/api/oauth#GET_api_v1_me_karma)

```
$karma = $reddit->getKarma();
```

**Get Friend Information**
Get information about a specified friend
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_v1\_me\_friends\_{username}](http://www.reddit.com/dev/api/oauth#GET_api_v1_me_friends_{username})
@param string $username The username of a friend to search for details on

```
$response = $reddit->getFriendInfo("jcleblanc");
```

**Get Subreddit Relationship Information**
Get relationship information for subreddits that user belongs to
@link [http://www.reddit.com/dev/api/oauth#GET\_subreddits\_mine\_{where}](http://www.reddit.com/dev/api/oauth#GET_subreddits_mine_{where})
@param string $where The subreddit relationship to search for. One of
 subscriber, contributor, or moderator
@param int $limit The number of results to return. Default = 25, Max = 100.
@param string $after The fullname of a thing to return results after
@param string $before The fullname of a thing to return results before

```
$subRel = $reddit->getSubRel("subscriber", 15);
```

**Get Messages (inbox / unread / sent)**
Get messages (inbox / unread / sent) for the current user
@link [http://www.reddit.com/dev/api/oauth#GET\_message\_inbox](http://www.reddit.com/dev/api/oauth#GET_message_inbox)
@param string $where The message type to return. One of inbox, unread, or sent

```
$response = $reddit->getMessages("inbox");  //get inbox messages
$response = $reddit->getMessages("unread"); //get unread messages
$response = $reddit->getMessages("sent");   //get sent messages
```

**Send a Message to Another User**
Send a message to another user, from the current user
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_compose](http://www.reddit.com/dev/api/oauth#POST_api_compose)
@param string $to The name of a existing user to send the message to
@param string $subject The subject of the message, no longer than 100 characters
@param string $text The content of the message, in raw markdown

```
$response = $reddit->sendMessage("jcleblanc", "Look at this message!", "Hey!\n\n**[search!](http://www.google.com/)**");
```

**Set the Read/Unread State of a Series of Messages**
Sets the read and unread state of a comma separates list of messages
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_read\_message](http://www.reddit.com/dev/api/oauth#POST_api_read_message)
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_unread\_message](http://www.reddit.com/dev/api/oauth#POST_api_unread_message)
@param string $state The state to set the messages to, either read or unread
@param string $subject A comma separated list of message fullnames (t4\_ and the message id – e.g. t4\_1kuinv).

```
$response = $reddit->setMessageState("read", "t4_1kuinv,t4_1kriyc");
$response = $reddit->setMessageState("unread", "t4_1kuinv,t4_1kriyc");
```

**Block Content via Inbox**
Sets a given piece of content to a blocked state via the inbox
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_block](http://www.reddit.com/dev/api/oauth#POST_api_block)
@param string $id The full name of the content to block (e.g. t4\_ and the message id – t4\_1kuinv).

```
$response = $reddit->setContentBlock("t4_1kuinv");
```

**Delete Link or Comment**
Deletes a given link or comment created by the user
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_del](http://www.reddit.com/dev/api/oauth#POST_api_del)
@param string $id The fullname of the link or comment to delete (e.g. t3\_1kuinv for link, t1\_1kuinv for comment).

```
$response = $reddit->deleteContent("t1_1kuinv");  //comment
$response = $reddit->deleteContent("t3_1kuinv");  //link
```

**Edit Comment or Self Post**
Edits the content of a self post or comment created by the user
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_editusertext](http://www.reddit.com/dev/api/oauth#POST_api_editusertext)
@param string $id The fullname of the link or comment to delete (e.g. t3\_1kuinv for link, t1\_1kuinv for comment).
@param string $text The raw markdown text to replace the content with.

```
$response = $reddit->editContent("t1_cj9qdna", "test\n\n**[test link](http://www.google.com/)**");
```

**Set Link Reply State**
Enable or disable inbox replies for a link
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_sendreplies](http://www.reddit.com/dev/api/oauth#POST_api_sendreplies)
@param string $id The fullname of the link to set the inbox reply state for.
@param bool $state The state to set the link to. true = enable inbox replies, false = disable inbox replies.

```
$response = $reddit->setReplyState("t3_2bxop3", true);
```

**Get User Subscriptions**
Get the subscriptions that the user is subscribed to, has contributed to, or is moderator of
@link [http://www.reddit.com/dev/api#GET\_subreddits\_mine\_contributor](http://www.reddit.com/dev/api#GET_subreddits_mine_contributor)
@param string $where The subscription content to obtain. One of subscriber, contributor, or moderator

```
$subscriptions = $reddit->getSubscriptions();
```

**Get Page Information**
Get information on a URLs submission on Reddit
@link [http://www.reddit.com/dev/api#GET\_api\_info](http://www.reddit.com/dev/api#GET_api_info)
@param string $url The URL to get information for

```
$pageInfo = $reddit->getPageInfo("http://i.imgur.com/QxdCd.jpg");
```

**Get Subreddit Text**
Get the submission text for a given subreddit
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_submit\_text.json](http://www.reddit.com/dev/api/oauth#GET_api_submit_text.json)
@param string $sr The subreddit to get submission text for

```
$subText = $reddit->getSubText("politics");
```

**Save Story**
Save a post to your account. Save feeds:

@link [http://www.reddit.com/dev/api#POST\_api\_save](http://www.reddit.com/dev/api#POST_api_save)
@param string $name the full name of the post to save (name parameter
 in the getSubscriptions() return value)
@param string $category the categorty to save the post to (Reddit gold only)

```
$response = $reddit->savePost("t3_n6ocq");
```

**Unsave Story**
Unsave a saved post from your account
@link [http://www.reddit.com/dev/api#POST\_api\_unsave](http://www.reddit.com/dev/api#POST_api_unsave)
@param string $name the full name of the post to unsave (name parameter
 in the getSubscriptions() return value)

```
$response = $reddit->unsavePost("t3_n6ocq");
```

**Get Saved Categories (Reddit gold only)**
Get a list of categories in which things are currently saved
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_saved\_categories.json](http://www.reddit.com/dev/api/oauth#GET_api_saved_categories.json)

```
$savedCats = $reddit->getSavedCats();
```

**Hide, Unhide, or Report Post**
Hide or unhide a post on your account
Hide, unhide, or report a post on your account
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_hide](http://www.reddit.com/dev/api/oauth#POST_api_hide)
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_unhide](http://www.reddit.com/dev/api/oauth#POST_api_unhide)
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_report](http://www.reddit.com/dev/api/oauth#POST_api_report)
@param string $state The state to set the post to, either hide, unhide, or report
@param string $name The fullname of the post to hide, unhide, or report (name
 parameter in the getSubscriptions() return value)

```
$response = $reddit->setPostReportState("hide", "t3_n6ocq");
$response = $reddit->setPostReportState("unhide", "t3_n6ocq");
$response = $reddit->setPostReportState("report", "t3_n6ocq");
```

**Get Posts**
Get the listing of submissions from a subreddit
@link [http://www.reddit.com/dev/api#GET\_listing](http://www.reddit.com/dev/api#GET_listing)
@param string $sr The subreddit name. Ex: technology, limit (integer): The number of posts to gather
@param int $limit The number of listings to return

```
$response = $reddit->getListing("technology", 5);
```

**Get Historic User Data**
Get the historical data of a user
@link [http://www.reddit.com/dev/api/oauth#scope\_history](http://www.reddit.com/dev/api/oauth#scope_history)
@param string $username the desired user. Must be already authenticated.
@param string $where the data to retrieve. One of overview,submitted,comments,liked,disliked,hidden,saved,gilded

```
$response = $reddit->getHistory("USERNAME", "liked");
```

**Get Raw JSON**
Get Raw JSON for a reddit permalink
@param string $permalink permalink to get raw JSON for

```
$response = $reddit->getRawJSON("/r/funny/comments/12ma0a/this_guy_showed_up_at_our_party_last_night_didnt/");
```

```
//get the JSON for the top technology post
$response1 = $reddit->getListing("technology", 1);
$response2 = $reddit->getRawJSON($response1->data->children[0)]->data->permalink);
```

**Search Content Within Subreddit**
Get the listing of submissions from a subreddit
@link [https://www.reddit.com/dev/api#GET\_search](https://www.reddit.com/dev/api#GET_search)
@param string $query The query to search for
@param int $count The number of results to return
@param string $t The timeframe of results to return, one of (hour, day, week, month, year, all)
@param string $after The fullname of a thing to search for results after
@param string $before The fullname of a thing to search for results before

```
$response = $reddit->search("cat", "pics", 20);
```

**Search Subreddits**
Get the listing of subreddit from a search
@link [http://www.reddit.com/dev/api/oauth#GET\_subreddits\_search](http://www.reddit.com/dev/api/oauth#GET_subreddits_search)
@param string $query The query to search for
@param int $count The number of results to return
@param string $after The fullname of a thing to search for results after
@param string $before The fullname of a thing to search for results before

```
$response = $reddit->search_sr("penguins", 20);
```

**Get All Subreddits**
Get results for all subreddits combined, sorted by new / popular
@link [http://www.reddit.com/dev/api/oauth#GET\_subreddits\_{where}](http://www.reddit.com/dev/api/oauth#GET_subreddits_{where})
@param string $where The fetch method, either new or popular
@param int $limit The number of results to return (max 100)
@param string $after The fullname of a post which results should be returned after
@param string $before The fullname of a post which results should be returned before

```
$response = $reddit->getAllSubs("new", 5);
$response = $reddit->getAllSubs("popular", 45);
```

**Add Comment**
Add a new comment to a story
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_comment](http://www.reddit.com/dev/api/oauth#POST_api_comment)
@param string $name The full name of the post to comment (name parameter
 in the getSubscriptions() return value)
@param string $text The comment markup

```
$response = $reddit->addComment("t3_jp2k7", "Hey!\n\n**[search!](http://www.google.com/)**");
```

**Add Vote**
Adds a vote (up / down / neutral) on a story
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_vote](http://www.reddit.com/dev/api/oauth#POST_api_vote)
@param string $name The full name of the post to vote on (name parameter
 in the getSubscriptions() return value)
@param int $vote The vote to be made (1 = upvote, 0 = no vote,
 -1 = downvote)

```
$response = $reddit->addVote("t3_n6ocq", 1);
```

**Set or Clear a User’s Flair in a Subreddit**
Set or clear a user’s flair in a subreddit
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_flair](http://www.reddit.com/dev/api/oauth#POST_api_flair)
@param string $subreddit The subreddit to use
@param string $user The name of the user
@param string $text Flair text to assign
@param string $cssClass CSS class to assign to the flair text

```
$response = $reddit->setFlair("motorcycles", "jcleblanc", "ZZR600", "kawasaki");
```

**Download the Flair Assignments of a Subreddit**
Download the flair assignments of a subreddit
@link [http://www.reddit.com/dev/api/oauth#GET\_api\_flairlist](http://www.reddit.com/dev/api/oauth#GET_api_flairlist)
@param string $subreddit The subreddit to use
@param int $limit The maximum number of items to return (max 1000)
@param string $after Return entries starting after this user
@param string $before Return entries starting before this user

```
$response = $reddit->getFlairList("motorcycles", 100, "t2_39qab", "t2_39qab");
```

**Post a CSV File of Flair Settings to a Subreddit**
Post a CSV file of flair settings to a subreddit
@link [http://www.reddit.com/dev/api/oauth#POST\_api\_flaircsv](http://www.reddit.com/dev/api/oauth#POST_api_flaircsv)
@param string $subreddit The subreddit to use
@param string $flairCSV CSV file contents, up to 100 lines

```
$response = $reddit->setFlairCSV("motorcycles", "jcleblanc,ZZR600,kawasaki\n...");
```

Other Resources
---------------

[](#other-resources)

The following are additional resources available for this SDK

- [Drupal Module](https://github.com/ethanteague/redditview) (created by [@ethanteague](https://github.com/ethanteague)): A Drupal module that wraps this SDK

License
-------

[](#license)

Copyright © 2015 Jonathan LeBlanc ()

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

###  Health Score

26

—

LowBetter than 41% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity21

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity41

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

### Community

Maintainers

![](https://www.gravatar.com/avatar/f7f1e80fceb7f978e6648ed1dd83983418347d53478a7b811a6abbf2d781ddc6?d=identicon)[tkthundr](/maintainers/tkthundr)

---

Top Contributors

[![jcleblanc](https://avatars.githubusercontent.com/u/104491?v=4)](https://github.com/jcleblanc "jcleblanc (66 commits)")[![sticktrk](https://avatars.githubusercontent.com/u/3043754?v=4)](https://github.com/sticktrk "sticktrk (20 commits)")[![FutileFreedom](https://avatars.githubusercontent.com/u/1073018?v=4)](https://github.com/FutileFreedom "FutileFreedom (3 commits)")[![StuartFeldt](https://avatars.githubusercontent.com/u/427126?v=4)](https://github.com/StuartFeldt "StuartFeldt (2 commits)")[![deadfish2000](https://avatars.githubusercontent.com/u/3580193?v=4)](https://github.com/deadfish2000 "deadfish2000 (2 commits)")[![nsideras](https://avatars.githubusercontent.com/u/722463?v=4)](https://github.com/nsideras "nsideras (1 commits)")[![Brobin](https://avatars.githubusercontent.com/u/6194619?v=4)](https://github.com/Brobin "Brobin (1 commits)")[![samnabi](https://avatars.githubusercontent.com/u/1731536?v=4)](https://github.com/samnabi "samnabi (1 commits)")

### Embed Badge

![Health badge](/badges/tkijewski-reddit-php-sdk/health.svg)

```
[![Health](https://phpackages.com/badges/tkijewski-reddit-php-sdk/health.svg)](https://phpackages.com/packages/tkijewski-reddit-php-sdk)
```

###  Alternatives

[exsyst/swagger

A php library to manipulate Swagger specifications

35916.4M7](/packages/exsyst-swagger)[hubspot/api-client

Hubspot API client

24016.2M18](/packages/hubspot-api-client)[pocketmine/bedrock-protocol

An implementation of the Minecraft: Bedrock Edition protocol in PHP

172437.8k11](/packages/pocketmine-bedrock-protocol)[botman/driver-telegram

Telegram driver for BotMan

93459.5k6](/packages/botman-driver-telegram)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)