Contentstack Delivery PHP SDK

Contentstack is a headless CMS with an API-first approach. It is a CMS that developers can use to build powerful cross-platform applications in their favorite languages. Build your application frontend, and Contentstack will take care of the rest. Read More.

To get started with PHP, you will need the following:

• PHP version 5.5.0 or later

To install the PHP SDK, choose either of the following methods:

Method 1: Using Composer

To install the PHP SDK in your project using Composer, fire up the terminal, point it to the project location, and run the following command:

composer require contentstack/contentstack

Method 2: Downloading the zip file

To download the PHP SDK, perform the following steps:

1. Download the PHP SDK.
2. Create the dependencies folder in your project directory and move the downloaded .zip file within the dependencies folder.
3. Download the MabeEnum class.
4. Create a folder named marc-mabe folder inside dependencies, and move the php-enum folder to marc-mabe.

Let's get started with the implementation.

Initialize the SDK by following either of the methods depending on the type of installation.

Method 1: If installed using Composer

To initialize the SDK, specify the API Key, delivery token, and environment name of your stack.

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment');

Method 2: If installed using the zip file

To initialize the SDK, specify the API key, delivery token, and environment name of your stack.

include_once DIR . '/dependencies/contentstack/index.php';

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment');

Once you have initialized the SDK, you can start getting content in your app.

Note By default, the SDK uses the North American region. Configuration changes are not required for North American region users.

To set the Europe (EU), Azure North America(Azure_NA), Azure Europe (Azure_EU), GCP North America (GCP_NA), or GCP Europe (GCP_EU) region, refer to the code below:

use Contentstack\Contentstack;

$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment', array('region' => ContentstackRegion.<<add_your_region>>));

For Setting the Branch.

If you want to initialize SDK in a particular branch use the code given below:

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment', array('region' => Contentstack::Region::<<add_your_region>>, "branch"=>"branch"));

Contentstack SDKs let you interact with the Content Delivery APIs and retrieve content from Contentstack. They are read-only in nature. The SDKs fetch and deliver content from the nearest server via Fastly, our powerful and robust CDN.

To get a single entry, you need to specify the content type and the UID of the entry:

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment');

$result = $stack->ContentType('content_type_uid')->Entry('entry_uid')->toJSON()->fetch();

$result - entry object

To retrieve multiple entries of a content type, specify the content type uid. You can also specify search parameters to filter results:

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment');

$result = $stack->ContentType('content_type_uid')->Query()->toJSON()->includeCount()->includeContentType()->find();

$result[0] - array of entries

$result[1] - content type

$result[2] - count of the entries

These were examples of some of the basic queries of the SDK.

In a single instance, the Get Multiple Entries query will retrieve only the first 100 items of the specified content type. You can paginate and retrieve the rest of the items in batches using the limit parameters in subsequent requests.

use Contentstack\Contentstack;


$stack = Contentstack::Stack('api_key', 'delivery_token', 'environment');

$result = $stack->ContentType('content_type_uid')->Query()->toJSON()->skip(20)->limit(20)->find();