Documentation API

This documentation includes an enhanced representation of the inline documentation of the latest (3.1) WordPress.org release.

Other than the default PHP Documenter output the version on this site also includes links to the codex and source in the core Trac of WordPress.org.

Where possible it also includes the source code of the function.

Other than that it parses the definitions of filters and actions and tags functions accordingly.

The usage is fairly simple. You can either use the input box on the top of this page to lookup WordPress or PHP functions or simply append the function name you’re looking for to the url. For example: http://lookup.hitchhackerguide.com/wp_insert_category.

If you’re using Panic Coda or other software that provide a manual lookup you can simply implement a lookup url in your IDE. For Coda this is done using the following steps:

Coda HitchHackerGuide WordPress Lookup Setup
  • Select Books from your toolbar
  • Hit the plus-sign at the bottom to add a new book
  • Enter a Book Title and optionally “http://hitchhackerguide.com” as Book Address
  • Select the PHP Mode you’re using to edit PHP and WordPress files. You might want to check out our WordPress Syntax mode
  • Enter the following search url : http://lookup.hitchhackerguide.com/*
  • Hit “Add” to create the book
  • Once this is done you can lookup WordPress and PHP functions by using CMD+Click on a function name.


I hope you enjoy this service and would be happy if you leave us some feedback on the main site.
We’re always looking for ideas and will be happy to fix any issues you might run into.

About these ads

5 Responses to “Documentation API”

  1. Hi,

    I’ve tried a couple of times to add the book but nothing seems to happen – that is, no new books are added along side HTML, CSS, JavaScript and PHP. I have the latest version of Coda but I’m in trial mode at the moment so perhaps that makes a difference.

  2. Is there a way to get this to work with sublime text 2?

    • I’m not using sublime text 2 and don’t know if it’s the best way to solve this but this script seems to be a good start. You would just need to change the documentation url for php in line 78 as it seems.

      • Thank you. When doing it this way it opens my browser window and does indeed take me to the right page on your site. not quite as nice as inline help, but none the less, very very handy!

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

Follow

Get every new post delivered to your Inbox.

Join 179 other followers

%d bloggers like this: