Many WordPress plugins contain bash scripts with sed and awk commands to update WordPress file headers. Because sed and awk 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 plugin.php, style.css or readme.txt.
To start documenting your WordPress filters and actions, require Pronamic WordPress Documentor in Composer:
composer require pronamic/wp-file-header --dev
vendor/bin/pronamic-wp-file-header get Version plugin.php
vendor/bin/pronamic-wp-file-header get 'Stable tag' readme.txt
vendor/bin/pronamic-wp-file-header get Version style.css
vendor/bin/pronamic-wp-file-header set Version 1.0.0 plugin.php
vendor/bin/pronamic-wp-file-header set 'Stable tag' 4.3 readme.txt
vendor/bin/pronamic-wp-file-header set Version 1.3 style.css
Here is a list of alternatives that we found. However, none of these satisfied our requirements.
If you know other similar projects, feel free to edit this section!
- https://codex.wordpress.org/File_Header
- https://codex.wordpress.org/File_Header_API
- https://developer.wordpress.org/plugins/plugin-basics/header-requirements/#header-fields
- https://developer.wordpress.org/plugins/wordpress-org/how-your-readme-txt-works/
- https://developer.wordpress.org/themes/basics/main-stylesheet-style-css/
- https://docs.npmjs.com/cli/v7/commands/npm-pkg
- https://developer.wordpress.org/reference/functions/get_plugin_data/
- https://developer.wordpress.org/reference/functions/get_file_data/
- https://github.com/wp-cli/i18n-command/blob/v2.4.0/src/FileDataExtractor.php