A PHP client for the Unsplash API.
Unsplash-PHP uses Composer. To use it, require the library
composer require crewlabs/unsplash
Before using, configure the client with your application ID and secret. If you don't have an application ID and secret, follow the steps from the Unsplash API to register your application.
Note that if you're just using actions that require the public permission scope, only the applicationId is required.
Crew\Unsplash\HttpClient::init([
'applicationId' => 'YOUR APPLICATION ID',
'secret' => 'YOUR APPLICATION SECRET',
'callbackUrl' => 'https://your-application.com/oauth/callback'
]);The current permission scopes defined by the Unsplash API are:
public(Access a user's public data)read_user(Access a user's private data)write_user(Edit and create user data)read_photos(Access private information from a user's photos)write_photos(Post and edit photos for a user)write_likes(Like a photo for a user)
If you're only using the public permissions scope (i.e. nothing requiring a specific logged-in user), you're ready to go!
To access actions that are non-public (i.e. uploading a photo to a specific account), you'll need a user's permission to access their data. Direct them to an authorization URL (configuring any scopes before generating the authorization URL):
$scopes = ['public', 'write_user']
Crew\Unsplash\HttpClient::$connection->getConnectionUrl($scopes);Upon authorization, Unsplash will return to you an authentication code via your OAuth callback handler. Use it to generate an access token:
Crew\Unsplash\HttpClient::$connection->generateToken($code);With the token you can now access any additional non-public actions available for the authorized user.
For more information about the the responses for each call, refer to the official documentation.
Some parameters are identical across all methods:
| param | Description |
|---|---|
$per_page |
Defines the number of objects per page. Default 10 |
$page |
Defines the offset page. Default 1 |
Note: The methods that return multiple objects return an ArrayObject, which acts like a normal array.
Retrieve category information:
Crew\Unsplash\Category::all($page, $per_page);Crew\Unsplash\Category::find(integer $id);$category = Crew\Unsplash\Category::find(integer $id);
$photos = $category->photos($page, $per_page)Retrieve curated batch information:
Crew\Unsplash\CuratedBatch::all($page, $per_page);Crew\Unsplash\CuratedBatch::find(integer $id);$batch = Crew\Unsplash\CuratedBatch::find(integer $id);
$photos = $batch->photos($page, $per_page);Retrieve photo information:
Crew\Unsplash\Photo::all($page, $per_page);Crew\Unsplash\Photo::search(string $search, integer $category_id, $page, $per_page);Crew\Unsplash\Photo::find(string $id);Crew\Unsplash\Photo::create(string $file_path);$photo = Crew\Unsplash\Photo::find(string $id);
$photo->photographer();Crew\Unsplash\Photo::random();
// Or apply some optional filters by passing a key value array of filters
$filters = [
'category' => [3, 6], // string|array Retrieve photos matching the category ID/IDs.
'featured' => true, // boolean Limit selection to featured photos.
'username' => 'andy_brunner', // string Limit selection to a single user.
'query' => 'coffee', // string Limit selection to photos matching a search term..
'w' => 100, // integer Image width in pixels.
'h' => 100, // integer Image height in pixels.
];
Crew\Unsplash\Photo::random($filters);For more information regarding filtering, refer to the Offical documentation.
$photo = Crew\Unsplash\Photo::find(string $id);
$photo->like();
$photo->unlike();Retrieve user information:
Crew\Unsplash\User::find($username)$user = Crew\Unsplash\User::find($username);
$user->photos($page, $per_page);$user = Crew\Unsplash\User::current();
$user->update([$key => value]);Bug reports and pull requests are welcome on GitHub at https://github.com/CrewLabs/Unsplash-PHP. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.