PHP library for the Contentful Content Delivery API and Content Preview API. It helps you to easily access your Content stored in Contentful with your PHP applications.
Contentful provides content infrastructure for digital teams to power websites, apps, and devices. Unlike a CMS, Contentful was built to integrate with the modern software stack. It offers a central hub for structured content, powerful management and delivery APIs, and a customizable web app that enable developers and content creators to ship their products faster.
Table of contents
- contentful.php — Contentful PHP Delivery library
- What is Contentful?
- Core Features
- Getting started
- Installation
- Your first request
- Using this library with the Preview API
- Authentication
- Documentation & References
- Configuration
- Reference documentation
- Tutorials & other resources
- Upgrade
- Reach out to us
- You have questions about how to use this library?
- You found a bug or want to propose a feature?
- You need to share confidential information or have other questions?
- Get involved
- License
- Code of Conduct
- Content retrieval through the Content Delivery API and Content Preview API.
- Synchronization
- Localization support
- Link resolution
In order to get started with the Contentful PHP library you'll need not only to install it, but also to get credentials which will allow you to have access to your content in Contentful. This package requires PHP 7.2 or higher or PHP 8.0 or higher.
Install the library using Composer:
composer require contentful/contentfulThe following code snippet is the most basic one you can use to get some content from Contentful with this library:
All interactions with the library go through Contentful\Delivery\Client. To create a new client an access token and a space ID have to be passed to the constructor.
$client = new \Contentful\Delivery\Client(
'b4c0n73n7fu1', # This is the access token for this space. Normally you get both ID and the token in the Contentful web app
'cfexampleapi' # This is the space ID. A space is like a project folder in Contentful terms
);
try {
$entry = $client->getEntry('nyancat');
} catch (\Contentful\Core\Exception\NotFoundException $exception) {
// Entry does not exist
}This library can also be used with the Preview API. In order to do so, you need to use the Preview API access token, available on the same page where you get the Delivery API token, and tell the client to use the different API:
$options = \Contentful\Delivery\ClientOptions::create()
->usingPreviewApi();
$client = new \Contentful\Delivery\Client($accessToken, $spaceId, $environmentId, $options);You can find all available methods of our client in our reference documentation.
To get your own content from Contentful, an app should authenticate with an OAuth bearer token.
You can create API keys using the Contentful web interface. Go to the app, open the space that you want to access (top left corner lists all the spaces), and navigate to the APIs area. Open the API Keys section and create your first token. Done.
Don't forget to also get your Space ID.
For more information, check the Contentful REST API reference on Authentication.
The ClientOptions class allows you to configure the client in a variety of different ways:
$options = \Contentful\Delivery\ClientOptions::create()
->usingPreviewApi()
->withDefaultLocale(string $defaultLocale = null)
->withHost(string $host)
->withLogger(Psr\Log\LoggerInterface $logger)
->withCache(Psr\Cache\CacheItemPoolInterface $cache, bool $autoWarmup = false, bool $cacheContent = false)
->withHttpClient(GuzzleHttp\Client $client)
->withoutMessageLogging()
->withQueryCache(Psr\Cache\CacheItemPoolInterface $queryCacheItemPool, int $queryCacheLifetime = 0)
;
$client = new \Contentful\Delivery\Client(
string $accessToken,
string $spaceId,
string $environmentId = 'master',
ClientOptions $options = null
);| Client parameter | Default | Description |
|---|---|---|
$accessToken |
Required. Your access token | |
$spaceId |
Required. Your space ID | |
$environmentId |
'master' |
Your environment ID |
$options |
null |
A ClientOptions object |
| ClientOptions method | Parameters | Description |
|---|---|---|
usingPreviewApi() |
- | Use the Preview API host (preview.contentful.com) |
withDefaultLocale() |
string $locale |
Set a locale to be automatically used for all requests |
withHost() |
string $host |
A string to override the default Contentful API URL, useful if you have a proxy between your application and the Contentful API |
withLogger() |
Psr\Log\LoggerInterface $logger |
A PSR-3 logger. Two types of logs are written: a generic one using either the INFO or ERROR level (depending on the response status code) with a brief summary, and a complete dump of request and response using the DEBUG level. We suggest to configure the logger minimum level according to your needs. |
withCache() |
Psr\Cache\CacheItemPoolInterface $cache |
A PSR-6 cache item pool. This will be used to stored data such as content types and locales, which are always needed but don't change often |
withCache() |
bool $autoWarmup = false |
When using a cache pool, set this to true to automatically fill the cache during regular use |
withCache() |
bool $cacheContent = false |
When using a cache pool with $autoWarmup set to true, se this to true to fill the cache with entries and assets during runtime. This may speed up execution when calling $client->getEntry($entryId) and $client->getAsset($assetId), but not when calling the getEntries() and getAssets() methods, as the client can't reliably know which entries or assets will be returned by the API, and for this reason the cache can't intercept the call. |
withHttpClient() |
GuzzleHttp\Client $client |
A Guzzle client instance, which can be configured with custom middleware |
withoutMessageLogging() |
- | Do not store API requests and responses (which can use a lot of memory). If messages are not stored, they will not be retrievable from Client::getMessages() for debugging and inspection purposes |
withQueryCache() |
Psr\Cache\CacheItemPoolInterface $queryCacheItemPool |
A PSR-6 cache item pool. This will be used to cache items retrieved with queries when calling $client->getEntries($query). |
withQueryCache() |
int $queryCacheLifetime = 0 |
The number of seconds of lifetime for $client->getEntries($query) cache items. There's no invalidation mechanism on these cache items so consider to set a low lifetime (for example 60 seconds). |
The PHP library reference documents what objects and methods are exposed by this library, what arguments they expect and what kind of data is returned.
Most methods also have examples which show you how to use them.
- This library is a wrapper around our Contentful Delivery REST API. Some more specific details such as search parameters and pagination are better explained on the REST API reference, and you can also get a better understanding of how the requests look under the hood.
- Check the Contentful for PHP page for Tutorials, Demo Apps, and more information on using PHP with Contentful.
For details about how to upgrade from version 3.x to version 4, please check the changelog entry for version 4.0.0 and the upgrade to version 4 guide.
For details about how to upgrade from version 2.x to version 3, please check the changelog entry for version 3.0.0 and the upgrade to version 3 guide.
- Reach out to our community forum:
- Jump into our community slack channel:
- File an issue here on GitHub:
. Make sure to remove any credential from your code before sharing it.
- File a support ticket at our Contentful Customer Support:
Important: Right now, the API has php-vcr as a development dependency, which does not officially support PHP8 yet. If you want to develop on PHP8, you will need to install the dependencies with composer install --ignore-platform-reqs to overwrite this requirement.
This repository is published under the MIT license.
We want to provide a safe, inclusive, welcoming, and harassment-free space and experience for all participants, regardless of gender identity and expression, sexual orientation, disability, physical appearance, socioeconomic status, body size, ethnicity, nationality, level of experience, age, religion (or lack thereof), or other identity markers.