{"id":15292288,"url":"https://github.com/pronamic/wp-file-header","last_synced_at":"2025-10-07T04:32:25.120Z","repository":{"id":60381331,"uuid":"542613055","full_name":"pronamic/wp-file-header","owner":"pronamic","description":"A library that makes the management of WordPress file headers easier.","archived":true,"fork":false,"pushed_at":"2022-09-28T19:32:51.000Z","size":25,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-16T07:12:06.912Z","etag":null,"topics":["deploy","deployment","file-header","file-headers","pronamic","readme","wordpress","wordpress-deployment","wordpress-development","wordpress-plugin","wordpress-theme","wp-cli"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pronamic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-28T13:46:30.000Z","updated_at":"2023-02-09T15:57:54.000Z","dependencies_parsed_at":"2022-09-28T20:50:27.323Z","dependency_job_id":null,"html_url":"https://github.com/pronamic/wp-file-header","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pronamic%2Fwp-file-header","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pronamic%2Fwp-file-header/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pronamic%2Fwp-file-header/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pronamic%2Fwp-file-header/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pronamic","download_url":"https://codeload.github.com/pronamic/wp-file-header/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235593342,"owners_count":19015137,"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":["deploy","deployment","file-header","file-headers","pronamic","readme","wordpress","wordpress-deployment","wordpress-development","wordpress-plugin","wordpress-theme","wp-cli"],"created_at":"2024-09-30T16:17:17.120Z","updated_at":"2025-10-07T04:32:19.828Z","avatar_url":"https://github.com/pronamic.png","language":"PHP","readme":"\u003ch1 align=\"center\"\u003ePronamic WordPress File Header\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n\tMany WordPress plugins contain bash scripts with \u003ccode\u003esed\u003c/code\u003e and \u003ccode\u003eawk\u003c/code\u003e commands to update WordPress file headers. Because \u003ccode\u003esed\u003c/code\u003e and \u003ccode\u003eawk\u003c/code\u003e commands are difficult to read and can be error prone we have developed this library. This library makes it easy to read and/or edit WordPress file headers in for example \u003ccode\u003eplugin.php\u003c/code\u003e, \u003ccode\u003estyle.css\u003c/code\u003e or \u003ccode\u003ereadme.txt\u003c/code\u003e.\n\u003c/p\u003e\n\n## Table of contents\n\n- [Getting Started](#getting-started)\n- [Command Line Usage](#command-line-usage)\n  - [Examples](#examples)\n- [Alternatives](#alternatives)\n- [Links](#links)\n\n## Getting Started\n\n### Installation\n\nTo start documenting your WordPress filters and actions, require Pronamic WordPress Documentor in Composer:\n\n```\ncomposer require pronamic/wp-file-header --dev\n```\n\n## Command Line Usage\n\n### Examples\n\n```\nvendor/bin/pronamic-wp-file-header get Version plugin.php\n```\n\n```\nvendor/bin/pronamic-wp-file-header get 'Stable tag' readme.txt\n```\n\n```\nvendor/bin/pronamic-wp-file-header get Version style.css\n```\n\n```\nvendor/bin/pronamic-wp-file-header set Version 1.0.0 plugin.php\n```\n\n```\nvendor/bin/pronamic-wp-file-header set 'Stable tag' 4.3 readme.txt\n```\n\n```\nvendor/bin/pronamic-wp-file-header set Version 1.3 style.css\n```\n\n## Alternatives\n\nHere is a list of alternatives that we found. However, none of these satisfied our requirements.\n\n*If you know other similar projects, feel free to edit this section!*\n\n- [wp-file-header-metadata](https://github.com/ahmadawais/wp-file-header-metadata) by [Ahmad Awais](https://github.com/ahmadawais)\n\n## Links\n\n- https://codex.wordpress.org/File_Header\n- https://codex.wordpress.org/File_Header_API\n- https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields\n- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/\n- https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/\n- https://docs.npmjs.com/cli/v7/commands/npm-pkg\n- https://developer.wordpress.org/reference/functions/get_plugin_data/\n- https://developer.wordpress.org/reference/functions/get_file_data/\n- https://github.com/wp-cli/i18n-command/blob/v2.4.0/src/FileDataExtractor.php\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpronamic%2Fwp-file-header","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpronamic%2Fwp-file-header","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpronamic%2Fwp-file-header/lists"}