PHPackages dimadin/wp-code-reference - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. dimadin/wp-code-reference ActiveWordpress-theme[Utility & Helpers](/categories/utility) dimadin/wp-code-reference ========================= wporg-developer child theme with adjustments to use it for code reference of any WordPress project. 401CSS Since Sep 15Pushed 7y ago1 watchersCompare [ Source](https://github.com/dimadin/wp-code-reference)[ Packagist](https://packagist.org/packages/dimadin/wp-code-reference)[ RSS](/packages/dimadin-wp-code-reference/feed)WikiDiscussions master Synced 6d ago READMEChangelogDependenciesVersions (1)Used By (0) WP Code Reference ================= [](#wp-code-reference) WP Code Reference is a theme used for displaying code reference of WordPress project (plugin or any WordPress library or theme that follows inline [WordPress PHP documentation standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/)). Requirements ------------ [](#requirements) Yu will need Composer and WP-CLI, and PHP 5.4+. Setup ----- [](#setup) There are two ways for setting everything up. ### 1. [](#1) If you manage your WordPress install and plugins with Composer (for example, with help of [Bedrock](https://roots.io/bedrock/)), you just need to require [`dimadin/wp-plugin-code-reference` package](https://packagist.org/packages/dimadin/wp-plugin-code-reference) and it will install all necessary dependencies. ### 2. [](#2) In other case, you will need to manually setup all required dependencies. #### Install parent theme [](#install-parent-theme) Checkout the [developer.wordpress.org theme](https://meta.svn.wordpress.org/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/) from the meta svn repository inside themes directory (usually `/wp-content/themes`). ``` svn checkout https://meta.svn.wordpress.org/sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/ ``` #### Install child theme [](#install-child-theme) This repository contain child theme, WP Code Reference. Clone this repository inside themes directory. #### Install WP-Parser [](#install-wp-parser) Inside plugins directory (usually `/wp-content/plugins`), clone [WP-Parser](https://github.com/WordPress/phpdoc-parser) and inside of it install its dependencies with `composer install`. #### Install SyntaxHighlighter Evolved [](#install-syntaxhighlighter-evolved) This is not required, but it's recommended to install [SyntaxHighlighter Evolved](https://wordpress.org/plugins/syntaxhighlighter/) plugin for nicer code display. Usage ----- [](#usage) When you have installed everything, activate WP-Parser and SyntaxHighlighter Evolved plugins, and WP Code Reference theme. Then, you will need to install or clone repository of WordPress project you want to have code reference for. You can do it in its standard location (for example, if it's plugin inside plugins directory). Finally, you need to run indexing command from WP-Parser. Go to project's directory and run ``` wp parser create . --user=1 ``` where `.` stands for the current directory and `--user=1` is for ID of a user that posts will be attributed to. If you want link "View on GitHub" to work, you will also have to run ``` wp option update wp_parser_gh_repository 'user/repo' ``` where `'user/repo'` is a path to your GitHub repository. If link is still not shown, run ``` wp option update wp_parser_imported_wp_version 'x.y.z' ``` where `'x.y.z'` is a tag that you based on your code reference. Notes ----- [](#notes) - In one WordPress site, you can have code reference for just one project. If you want to have references for multiple projects, you either need to install separate WordPress instances and follow procedure from above, or have a WordPress multisite installation where each site in a network is for one project. - For every new version of your project, you will need to run parser as explained in section *[Usage](#usage)*. However, note that previously parsed resources that are no longer getting parsed (for example removed from the new version), are not removed from the database because of limitations of [WP-Parser](https://github.com/WordPress/phpdoc-parser/issues/147). You will need to reset database or do something else to remove them. - Directories `/tests` and `/vendor` are skipped and it will not be shown in code reference. ### Health Score 20 — LowBetter than 14% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity5 Limited adoption so far Community8 Small or concentrated contributor base Maturity40 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/54c4bd393dafccafaf09bf6441bbd933db30b4d4fd153211f79636e8838cdac5?d=identicon)[dimadin](/maintainers/dimadin) --- Top Contributors [![dimadin](https://avatars.githubusercontent.com/u/2678421?v=4)](https://github.com/dimadin "dimadin (1 commits)") ### Embed Badge ![Health badge](/badges/dimadin-wp-code-reference/health.svg) ``` [![Health](https://phpackages.com/badges/dimadin-wp-code-reference/health.svg)](https://phpackages.com/packages/dimadin-wp-code-reference) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)