https://github.com/fusonic/opengraph
A simple PHP library to read Open Graph data from the web or publish your own resources.
https://github.com/fusonic/opengraph
opengraph php
Last synced: 5 months ago
JSON representation
A simple PHP library to read Open Graph data from the web or publish your own resources.
- Host: GitHub
- URL: https://github.com/fusonic/opengraph
- Owner: fusonic
- License: mit
- Created: 2014-07-19T08:43:36.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2025-01-20T09:27:14.000Z (about 1 year ago)
- Last Synced: 2025-05-08T04:57:03.899Z (11 months ago)
- Topics: opengraph, php
- Language: PHP
- Homepage:
- Size: 234 KB
- Stars: 97
- Watchers: 7
- Forks: 41
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-2.x.md
- License: LICENSE
Awesome Lists containing this project
README
# fusonic/opengraph
[](https://github.com/fusonic/opengraph/releases/latest)
[](https://packagist.org/packages/fusonic/opengraph)
[](https://github.com/fusonic/opengraph/blob/master/LICENSE)
[](https://github.com/fusonic/opengraph/actions/workflows/test.yml)
A simple library to read Open Graph data from the web and generate HTML code to publish your own Open Graph objects. A
fallback mode enables you to read data from websites that do not implement the Open Graph protocol.
Using this library you can easily retrieve stuff like metadata, video information from YouTube or Vimeo or image
information from Flickr without using site-specific APIs since they all implement the Open Graph protocol.
See [ogp.me](https://ogp.me) for information on the Open Graph protocol.
## Requirements
* PHP 8.1+
* [symfony/css-selector](https://github.com/symfony/css-selector)
* [symfony/dom-crawler](https://github.com/symfony/dom-crawler)
* [psr/http-client](https://github.com/php-fig/http-client)
* [psr/http-factory](https://github.com/php-fig/http-factory)
* and compatible implementation such as [symfony/http-client](https://github.com/symfony/http-client)
## Installation
The most flexible installation method is using Composer:
```bash
composer require fusonic/opengraph
```
Install Composer and run the `install` command:
```bash
curl -s http://getcomposer.org/installer | php
php composer.phar install
```
Once installed, include `vendor/autoload.php` in your script.
``` php
require 'vendor/autoload.php';
```
## Usage
### Retrieve Open Graph data from a URL
```php
loadUrl('https://www.youtube.com/watch?v=P422jZg50X4');
// Basic information of the object
echo "Title: " . $object->title; // Getting started with Facebook Open Graph
echo "Site name: " . $object->siteName; // YouTube
echo "Description: " . $object->description; // Originally recorded at the Facebook World ...
echo "Canonical URL: " . $object->url; // https://www.youtube.com/watch?v=P422jZg50X4
// Images
$image = $object->images[0];
echo "Image[0] URL: " . $image->url; // https://i1.ytimg.com/vi/P422jZg50X4/maxresdefault.jpg
echo "Image[0] height: " . $image->height; // null (May return height in pixels on other pages)
echo "Image[0] width: " . $image->width; // null (May return width in pixels on other pages)
// Videos
$video = $object->videos[0];
echo "Video URL: " . $video->url; // https://www.youtube.com/v/P422jZg50X4?version=3&autohide=1
echo "Video height: " . $video->height; // 1080
echo "Video width: " . $video->width; // 1920
echo "Video type: " . $video->type; // application/x-shockwave-flash
```
_There are some more properties but these are the basic and most commonly used ones._
### Publish own Open Graph data
```php
title = "Getting started with Facebook Open Graph";
$object->siteName = "YouTube";
$object->description = "Originally recorded at the Facebook World ..."
$object->url = "https://www.youtube.com/watch?v=P422jZg50X4";
// Images
$image = new Image("https://i1.ytimg.com/vi/P422jZg50X4/maxresdefault.jpg");
$object->images[] = $image;
// Videos
$video = new Video("https://www.youtube.com/v/P422jZg50X4?version=3&autohide=1");
$video->height = 1080;
$video->width = 1920;
$video->type = "application/x-shockwave-flash";
$object->videos[] = $video;
// Generate HTML code
echo $publisher->generateHtml($object);
//
//
//
//
//
//
//
//
//
```
_HTML code is formatted just for displaying purposes. You may choose between HTML5/XHTML output using the ```$publisher->doctype``` property._
## Running tests
You can run the test suite by running `composer test` from the command line.
## FAQ
**I don't get any information from a webpage, but Facebook shows information for the same URL. What do I do wrong?**
It seems that some pages (like Twitter/X) only publish Open Graph information if Facebook's user agent string
`facebookexternalhit/1.1` is used (see [#28](https://github.com/fusonic/opengraph/issues/28)). So you should configure
your PSR-18 client to use this user agent string:
```php
$client = new Psr18Client(new NativeHttpClient(['headers' => ['User-Agent' => 'facebookexternalhit/1.1']]));
```
## License
fusonic/opengraph is licensed under the MIT license. See [LICENSE](LICENSE) for more information.