{"id":19639529,"url":"https://github.com/tutv/wp-package-parser","last_synced_at":"2025-04-28T10:31:09.814Z","repository":{"id":57073797,"uuid":"94401143","full_name":"tutv/wp-package-parser","owner":"tutv","description":"Parsing WordPress plugin and theme metadata.","archived":false,"fork":false,"pushed_at":"2024-05-26T03:03:43.000Z","size":2504,"stargazers_count":9,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"develop","last_synced_at":"2025-04-23T04:43:07.155Z","etag":null,"topics":["metadata","parse","parsing-wordpress-plugin","php","plugins","theme","theme-metadata","themes","wordpress"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tutv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-15T04:55:16.000Z","updated_at":"2024-05-22T15:27:33.000Z","dependencies_parsed_at":"2022-08-24T14:54:47.948Z","dependency_job_id":null,"html_url":"https://github.com/tutv/wp-package-parser","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tutv%2Fwp-package-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tutv%2Fwp-package-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tutv%2Fwp-package-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tutv%2Fwp-package-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tutv","download_url":"https://codeload.github.com/tutv/wp-package-parser/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251295278,"owners_count":21566429,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["metadata","parse","parsing-wordpress-plugin","php","plugins","theme","theme-metadata","themes","wordpress"],"created_at":"2024-11-11T13:01:40.506Z","updated_at":"2025-04-28T10:31:04.804Z","avatar_url":"https://github.com/tutv.png","language":"PHP","readme":"WP Package Parser [![Travis](https://img.shields.io/travis/tutv/wp-package-parser.svg)](https://travis-ci.org/tutv/wp-package-parser) [![GitHub issues](https://img.shields.io/github/issues/tutv/wp-package-parser.svg)](https://github.com/tutv/wp-package-parser/issues) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/tutv/wp-package-parser/master/LICENSE) \n========================\n\nA PHP library for parsing WordPress plugin and theme metadata. Point it at a ZIP package and it will:\n\n- Tell you whether it contains a plugin or a theme.\n- Give you the metadata from the comment header (Version, Description, Author URI, etc).\n- Parse readme.txt into a list of headers and sections.\n- Convert readme.txt contents from Markdown to HTML.\n\nInstallation\n-----------\n\nInclude `wp-package-parser.php` or [install the composer package](https://packagist.org/packages/tutv95/wp-package-parser).\n\n\nBasic usage\n-----------\n\n### Extract plugin metadata:\n\n```php\nrequire 'wp-package-parser/wp-package-parser.php';\n$package = new Max_WP_Package('/var/path/plugin.zip');\nprint_r($package-\u003eget_metadata());\n```\n\nSample output:\n\n```\nArray\n(\n    [name] =\u003e Hello Dolly\n    [plugin_uri] =\u003e https://wordpress.org/plugins/hello-dolly/\n    [version] =\u003e 1.6\n    [description] =\u003e 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.\n    [author] =\u003e Matt Mullenweg\n    [author_profile] =\u003e http://ma.tt/\n    [text_domain] =\u003e hello-dolly\n    [domain_path] =\u003e \n    [network] =\u003e \n    [plugin] =\u003e hello-dolly/hello.php\n    [contributors] =\u003e Array\n        (\n            [0] =\u003e matt\n        )\n\n    [donate] =\u003e \n    [tags] =\u003e Array\n        (\n        )\n\n    [requires] =\u003e 4.6\n    [tested] =\u003e 4.7\n    [stable] =\u003e 1.6\n    [short_description] =\u003e 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.\n    [sections] =\u003e Array\n        (\n            [description] =\u003e \nThis 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.\n\n\n        )\n\n    [readme] =\u003e 1\n    [slug] =\u003e hello-dolly\n)\n```\n\n### Extract theme metadata:\n\n```php\nrequire 'wp-package-parser/wp-package-parser.php';\n$package = new Max_WP_Package('/var/path/theme.zip');\nprint_r($package-\u003eget_metadata());\n```\n\nSample output:\n\n```\nArray\n(\n    [name] =\u003e Twenty Sixteen\n    [theme_uri] =\u003e https://wordpress.org/themes/twentysixteen/\n    [description] =\u003e 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.\n    [author] =\u003e the WordPress team\n    [author_uri] =\u003e https://wordpress.org/\n    [version] =\u003e 1.3\n    [template] =\u003e \n    [status] =\u003e \n    [tags] =\u003e Array\n        (\n            [0] =\u003e one-column\n            [1] =\u003e two-columns\n            [2] =\u003e right-sidebar\n            [3] =\u003e accessibility-ready\n            [4] =\u003e custom-background\n            [5] =\u003e custom-colors\n            [6] =\u003e custom-header\n            [7] =\u003e custom-menu\n            [8] =\u003e editor-style\n            [9] =\u003e featured-images\n            [10] =\u003e flexible-header\n            [11] =\u003e microformats\n            [12] =\u003e post-formats\n            [13] =\u003e rtl-language-support\n            [14] =\u003e sticky-post\n            [15] =\u003e threaded-comments\n            [16] =\u003e translation-ready\n            [17] =\u003e blog\n        )\n\n    [text_domain] =\u003e twentysixteen\n    [domain_path] =\u003e \n    [slug] =\u003e twentysixteen\n)\n```\n\nRequirements\n------------\nPHP 5.4. \n\nCredits\n-------\nPartially based on plugin header parsing code from the WordPress core.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftutv%2Fwp-package-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftutv%2Fwp-package-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftutv%2Fwp-package-parser/lists"}