Better WordPress Code Reference

Discussions have been ongoing about better code reference for WordPress. Here’s where we are so far:

  • @rmccue, @duck_, and @djpaul have been developing the parser, which isn’t far off
  • we need to have a discussion about how be are going to do user contributions. Are we going to use WP comments functionality? I thought it would be cool if we attach a taxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. to the comments we could tag them as explanation or example and they could be spat out in the right place. This would require a Code Reference Moderator, so someone would need to take on that role (and get all of the glory that entails)
  • We have three wireframes which @melchoyce is going to turn into a design. We will need designs for the following pages:
  • landing page
  • individual function page
  • archive page

We also may need:

  • standard narrative page
  • APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. pages (though @nacin suggested that these would live in the PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the Plugin Directory or can be cost-based plugin from a third-party Dev Handbook)

Here are the wireframes thus far:

Landing Page
Landing Page

Function Page


Archive Page


Please feel free to comment on these, however please focus on the following questions:

  • are there any navigation elements you feel are missing from the landing page?
  • are there any other developer resources you feel should be featured on the landing page?
  • are there any navigational elements missing from the individual function page?
  • are there any content elements missing from the function page?
  • would it be useful to have a page that lists every function, like:
  • as a developer, are their any elements of a code reference that you would love to see included but that we haven’t allowed for yet?