herb miller

• Introducing WP-a2z – WordPress Dynamic API Reference

  

  I’m just completing the finishing touches to phase 7 of a project first demoed in the Lake District, in July 2013, at Human Made’s pre WordCamp Lancaster retreat.

  The vision of the project is to be

  the complete reference for the WordPress Application Programming Interface

  

  It’s taken a long time but the effort is beginning to pay off. I hope many others will benefit.

  Phases to date

  1. oik shortcodes and APIs server ( first released – November 2012 )
  2. API call tree navigation ( March 2013 )
  3. oik shortcodes server for action/filter hooks ( v1.05 – Oct 2013 )
  4. oik shortcodes server for PHP classes and methods ( v1.11 – May 2014 )
  5. oik-batch for documenting “wordpress” ( v0.4 – May 2014)
  6. oik-shortcode server for “files” ( v1.16 – May 2014 )
  7. Create and populate wp-a2z.com – a site within oik-plugins.eu ( 31 May – 2 Jun 2014 )

Future phases

• Add support for creating Dynamic API Reference for themes
• Add support for navigating file inclusion
• Add support for other dynamic calls including callbacks
• Add support for other file types: jQuery, CSS, etcetera
• Add links to developer.wordpress.org

See also

• wp-a2z.com
• oik-shortcodes
• Developing dynamic documentation for WordPress, plugins, APIs and hooks
• Example: demonstrating the [bw_api] shortcode
• Comparing wp-a2z.com with developer.wordpress.org and WP-Parser