https://github.com/mitogh/random-image
:camera: Wordpress - Retrieve random images from the attachments library..
https://github.com/mitogh/random-image
Last synced: about 1 month ago
JSON representation
:camera: Wordpress - Retrieve random images from the attachments library..
- Host: GitHub
- URL: https://github.com/mitogh/random-image
- Owner: mitogh
- License: mit
- Created: 2014-05-14T02:30:07.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2016-01-02T19:01:20.000Z (over 10 years ago)
- Last Synced: 2025-01-02T15:49:56.439Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Random Image [](https://travis-ci.org/mitogh/Random-Image)
===================
> Easily random image generation from the library of attachments or from
a post, page or custom post type ID.
## Description
Whith this small utility you can easy and fast access to the group of
random images from the library or from a post using the ID of the post,
you can access to the IDs of this images or the `src` of each image by
size.
## Requirements.
- WordPress
- PHP 5.3 >=
## Installation
You can add this library into your theme or plugin by using composer,
and adding this library as a dependency, just by running:
```php
composer require mitogh/random-image
```
After that make sure you include the library using the autoload file
from composer:
```php
include './vendor/autoload.php';
```
Or by using directly the file.
```php
include 'vendor/mitogh/random-image/src/RandomImage.php';
```
## Usage
In order to access to the public functions you need to create an
instance of `RandomImage` class as follows:
```php
$randomImage = new mitogh\RandomImage();
```
Optionally you can pass an array of arguments to update some arguments
before to retrieve the random images, the arguments are:
- count: you can specify the number of images to be searched, default is 1.
- parent_ID: you can specify the ID of the page, post, post type from
where to search the images if you don't want to search on the entiry
library of attachments, default is null and searches the entiry library.
So for example if you want to have 3 random images from the page with
the ID: 2.
```php
$args = array(
'count' => 3,
'parent_ID' => 2,
);
$randomImage = new mitogh\RandomImage( $args );
```
**Filters**
Aditionally you can update the default mime of the searched files, using
the filter `mitogh_rand_image_mime_type`, by default the mime types are:
```php
image/jpeg
image/gif
image/png
image/bmp
image/tiff
```
You can update this by using the filter and returning an array with the
type, for example to search only gif images:
```php
add_filter( 'mitogh_rand_image_mime_type', function( $default_types ) ) {
return array(
'image/gif',
);
});
```
## Public methods
You have access to 2 methods with the instance to `RandomImage`, the
methods are:
**get_ids**
With this method you can access to the ID of each image, and by having
the ID of the image you can use another functions to operate over each
image as follows:
```php
$randomImage = new mitogh\RandomImage();
$images_id = $randomImage->get_ids();
// Now images_id has an array with the id of each image, and you can use
// each id to operate over each image.
```
**get_srcs**
This method will return an array with the src attribute of each image so
you can use each value in a `![]()
` tag. Aditionally you can specify the
size of the images (all of them) before returned.
```php
$randomImage = new mitogh\RandomImage();
$images_src = $randomImage->get_srcs( 'full' );
// Now images_src has an array with the src value of the images with the
// full size.
```