WP Parser

WP-Parser is the parser for creating the new code reference at developer.wordpress.org. It parses the inline documentation and produces custom post type entries in WordPress.

We are currently looking for contributors to help us complete the work on the parser.

There is a guide to developing for developer.wordpress.org in the WordPress documentation handbook.

Requirements

• PHP 7.4+
• Composer
• WP CLI

Development

Clone the repository and set up the development environment:

git clone https://github.com/WordPress/phpdoc-parser.git
cd phpdoc-parser
npm ci
composer install
npm run setup

WordPress is available at http://localhost:8888.

Tests

For a test-only setup:

composer install
npm run test:phpunit:setup
npm test

If the development environment was set up with npm run setup, only npm test is needed.

Running the parser

Activate the plugin first:

wp plugin activate phpdoc-parser

In your site's directory:

wp parser create /path/to/source/code --user=<id|login>