zoonman/pixabay-php-api

PixabayClient is a PHP HTTP client library to access Pixabay's API

2.0.0 2023-06-26 16:09 UTC

This package is not auto-updated.

Last update: 2024-11-11 22:28:33 UTC


README

Build Status Code Climate Packagist GitHub license

This is unofficial wrapper for Pixabay RESTful API for searching and retrieving Pixabay public domain images.

Pixabay

Installing via Composer

The recommended way to install Pixabay PHP Client is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

Next, run the Composer command to install the latest stable version of Pixabay PHP Client:

composer require zoonman/pixabay-php-api

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Documentation

Compatible with PHP verisons:

  • 7.2+
  • 8
  • hhvm
  • nightly

See current build status above.

Usage example

<?php
// wire the Composer Autoloader
require_once 'vendor/autoload.php';

// instantiate the API Client
// sign up for Pixabay service to get the correct API key
$pixabayClient = new \Pixabay\PixabayClient([
	'key' => 'yourPixabayKey'
]);

// run simplest possible query against the API
$results = $pixabayClient->get(['q' => 'nature'], true);
// show the results
var_dump($results);

// to get images use
$results = $object->getImages(['q' => 'flowers', 'per_page' => 3], true);
var_dump($results);

// to get videos use
$results = $object->getVideos(['q' => 'smile', 'per_page' => 3], true);
var_dump($results);

To obtain your keys go to https://pixabay.com/api/docs/

More information can be found in the online documentation at https://www.zoonman.com/projects/pixabay/