Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tutv/wp-package-parser
Parsing WordPress plugin and theme metadata.
https://github.com/tutv/wp-package-parser
metadata parse parsing-wordpress-plugin php plugins theme theme-metadata themes wordpress
Last synced: 2 months ago
JSON representation
Parsing WordPress plugin and theme metadata.
- Host: GitHub
- URL: https://github.com/tutv/wp-package-parser
- Owner: tutv
- License: mit
- Created: 2017-06-15T04:55:16.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-05-26T03:03:43.000Z (8 months ago)
- Last Synced: 2024-10-06T17:47:55.973Z (3 months ago)
- Topics: metadata, parse, parsing-wordpress-plugin, php, plugins, theme, theme-metadata, themes, wordpress
- Language: PHP
- Size: 2.39 MB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
WP Package Parser [](https://travis-ci.org/tutv/wp-package-parser) [](https://github.com/tutv/wp-package-parser/issues) [](https://raw.githubusercontent.com/tutv/wp-package-parser/master/LICENSE)
========================
A PHP library for parsing WordPress plugin and theme metadata. Point it at a ZIP package and it will:
- Tell you whether it contains a plugin or a theme.
- Give you the metadata from the comment header (Version, Description, Author URI, etc).
- Parse readme.txt into a list of headers and sections.
- Convert readme.txt contents from Markdown to HTML.
Installation
-----------
Include `wp-package-parser.php` or [install the composer package](https://packagist.org/packages/tutv95/wp-package-parser).
Basic usage
-----------
### Extract plugin metadata:
```php
require 'wp-package-parser/wp-package-parser.php';
$package = new Max_WP_Package('/var/path/plugin.zip');
print_r($package->get_metadata());
```
Sample output:
```
Array
(
[name] => Hello Dolly
[plugin_uri] => https://wordpress.org/plugins/hello-dolly/
[version] => 1.6
[description] => This is not just a plugin, it symbolizes the hope and enthusiasm of an entire generation summed up in two words sung most famously by Louis Armstrong: Hello, Dolly. When activated you will randomly see a lyric from Hello, Dolly in the upper right of your admin screen on every page.
[author] => Matt Mullenweg
[author_profile] => http://ma.tt/
[text_domain] => hello-dolly
[domain_path] =>
[network] =>
[plugin] => hello-dolly/hello.php
[contributors] => Array
(
[0] => matt
)
[donate] =>
[tags] => Array
(
)
[requires] => 4.6
[tested] => 4.7
[stable] => 1.6
[short_description] => This is not just a plugin, it symbolizes the hope and enthusiasm of an entire generation summed up in two words sung most famously by Louis Armstrong.
[sections] => Array
(
[description] =>
This is not just a plugin, it symbolizes the hope and enthusiasm of an entire generation summed up in two words sung most famously by Louis Armstrong: Hello, Dolly. When activated you will randomly see a lyric from Hello, Dolly in the upper right of your admin screen on every page.
)
[readme] => 1
[slug] => hello-dolly
)
```
### Extract theme metadata:
```php
require 'wp-package-parser/wp-package-parser.php';
$package = new Max_WP_Package('/var/path/theme.zip');
print_r($package->get_metadata());
```
Sample output:
```
Array
(
[name] => Twenty Sixteen
[theme_uri] => https://wordpress.org/themes/twentysixteen/
[description] => Twenty Sixteen is a modernized take on an ever-popular WordPress layout — the horizontal masthead with an optional right sidebar that works perfectly for blogs and websites. It has custom color options with beautiful default color schemes, a harmonious fluid grid using a mobile-first approach, and impeccable polish in every detail. Twenty Sixteen will make your WordPress look beautiful everywhere.
[author] => the WordPress team
[author_uri] => https://wordpress.org/
[version] => 1.3
[template] =>
[status] =>
[tags] => Array
(
[0] => one-column
[1] => two-columns
[2] => right-sidebar
[3] => accessibility-ready
[4] => custom-background
[5] => custom-colors
[6] => custom-header
[7] => custom-menu
[8] => editor-style
[9] => featured-images
[10] => flexible-header
[11] => microformats
[12] => post-formats
[13] => rtl-language-support
[14] => sticky-post
[15] => threaded-comments
[16] => translation-ready
[17] => blog
)
[text_domain] => twentysixteen
[domain_path] =>
[slug] => twentysixteen
)
```
Requirements
------------
PHP 5.4.
Credits
-------
Partially based on plugin header parsing code from the WordPress core.