https://github.com/frameright/php-image-metadata-parser
PHP image metadata parsing library (XMP, IPTC, Exif)
https://github.com/frameright/php-image-metadata-parser
frameright image image-display-control image-manipulation iptc-metadata metadata metadata-extraction metadata-parser
Last synced: 9 months ago
JSON representation
PHP image metadata parsing library (XMP, IPTC, Exif)
- Host: GitHub
- URL: https://github.com/frameright/php-image-metadata-parser
- Owner: Frameright
- License: mit
- Created: 2022-10-06T14:11:56.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T19:00:42.000Z (about 1 year ago)
- Last Synced: 2025-04-12T08:19:48.843Z (9 months ago)
- Topics: frameright, image, image-display-control, image-manipulation, iptc-metadata, metadata, metadata-extraction, metadata-parser
- Language: PHP
- Homepage: https://docs.frameright.io/php
- Size: 11.3 MB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://packagist.org/packages/frameright/image-metadata-parser)
# Image metadata parsing library (PHP 5.5+)
> **➡️ See this document rendered at [docs.frameright.io/php](https://docs.frameright.io/php)**
> **NOTE**: this is based on
> [dchesterton/image](https://github.com/dchesterton/image). Many thanks to
[dchesterton](https://github.com/dchesterton)!
Supported image types:
- JPEG
- PNG
- ~~WEBP~~
Supported image meta types:
- XMP
- IPTC
- ~~EXIF~~
> **NOTE**: a TypeScript equivalent of this library is available
> [here](https://github.com/Frameright/image-display-control-metadata-parser).
## Installation
Pull the library in your project via [Composer](https://getcomposer.org/)
with the following `composer.json`:
```json
{
"minimum-stability": "dev",
"repositories": [
{
"type": "vcs",
"url": "https://github.com/Frameright/php-image-metadata-parser.git"
}
],
"require": {
"frameright/image-metadata-parser": "dev-master"
}
}
```
**Dependencies**: [`php-xml`](https://www.php.net/manual/en/book.dom.php)
## Usage
:sparkles: [Getting started](https://docs.frameright.io/php/getting-started)
:wrench: [Contributing](https://docs.frameright.io/php/contributing)
:memo: [Tutorial](https://www.frameright.io/post/metadata-in-php)
📝 [Changelog](https://docs.frameright.io/php/changelog)
### Get metadata
```php
$image = Image::fromFile($filename);
$headline = $image->getXmp()->getHeadline();
$camera = $image->getExif()->getCamera();
...
```
### Loading specific image type
When file type is known, you can load the file type directly using the file types' `fromFile` method.
```php
$jpeg = JPEG::fromFile('image.jpg');
$png = PNG::fromFile('image.png');
```
### Instantiate from bytes
If you don't have a file to work with but you do have the image stored in a string (from database, ImageMagick etc.) you can easily instantiate an object from the string.
```php
$data = ...
$jpeg = JPEG::fromString($data);
```
### Instantiate from GD or a stream
You can also create an object from a GD resource or a stream.
```php
$gd = imagecreate(100, 100);
$jpeg = JPEG::fromResource($gd);
```
```php
$stream = fopen('...', 'r+');
$jpeg = JPEG::fromStream($stream);
```
### Aggregate metadata
When just want a piece of metadata and don't care whether it's from XMP, IPTC or EXIF, you can use the aggregate meta object.
```php
$image = Image::fromFile($filename);
$headline = $image->getAggregate()->getHeadline();
```
By default it checks XMP first, then IPTC, then EXIF but you can change the priority:
```php
$aggregate = $image->getAggregate();
$aggregate->setPriority(['exif', 'iptc', 'xmp']);
$aggregate->getHeadline(); // will now check EXIF first, then IPTC, then XMP
```
You can also exclude a metadata type if you do not want to use it:
```php
$aggregate->setPriority(['iptc', 'xmp']);
$aggregate->getHeadline(); // will only check IPTC and XMP
```
#### Get GPS data
```php
$image = ...
$gps = $image->getAggregateMeta()->getGPS(); // checks EXIF and XMP
// or $gps = $image->getExif()->getGPS();
$lat = $gps->getLatitude();
```