This plugin hasn’t been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues when used with more recent versions of WordPress.

This plugin has been closed and is no longer available for download.

Codex Generator

Description

Creating page of function reference in Codex involves looking up information about function and dealing with complicated wiki markup.

This plugin automates much of the process by reading function’s inline documentation and converting to wiki markup:

  • short and long function descriptions
  • parameters and their default values
  • version of WordPress function was added in
  • source file that contains a function

You can also navigate, search, sort and filter functions by much of that information in plugin’s interface.

Screenshots

  • Using plugin's page in administration area.
  • Generating markup for wiki page.
  • Resulting page in Codex.

Installation

  1. Upload codex-generator folder to the /wp-content/plugins/ directory
  2. Activate the plugin through the Plugins menu in WordPress
  3. Use plugin’s page in WordPress admin area under Tools > Codex Generator

Note that this plugin won’t work properly with opcode caching enabled. Opcode caching mechanisms (such as APC or eAccelerator) discard PHPDoc data and make it unavailable to plugin.

FAQ

Does it list every single WordPress function?

Plugin draws data from currently defined functions. It cannot see functions from files that are only loaded in specific cases and inactive plugins.

Why does it complain about opcode caching?

Opcode caching makes things run snappier and discards non-essential information while at it. So PHPDoc (documentation embedded in source) is not available in that case. And this plugin needs it.

Should I ask my hosting to disable opcode caching?

Absolutely not! This plugin is mostly meant to be used in development environment. You can run it in production, but you should not compromise performance because of it.

Contributors & Developers

“Codex Generator” is open source software. The following people have contributed to this plugin.

Contributors

Translate “Codex Generator” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.2

  • (enhancement) added searchable and sortable table of functions to interface
  • (bug fix) added spaces when merging multiline short description
  • (internal) moved parser to separate class
  • (internal) added utility class
  • (internal) added function query class

1.1

  • (enhancement) implemented suggest for function names
  • (enhancement) added notice when PHPDoc is not available for a function
  • (enhancement) added link to plugin’s page in plugin list
  • (bug fix) fixed and improved type and value conversion into strings
  • (bug fix) changed piped parameter types from “mixed” to joined with pipe HTML entity
  • (internal) refactored parser

1.0

  • Initial release.