• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
WordPress a2z

WordPress a2z

WordPress Dynamic API Reference

  • Home
  • Plugins
  • Themes
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / Blog

Blog

WordPress core, plugins and themes updated to latest versions

The latest versions of WordPress core, and the default plugins and themes have been parsed at their latest levels. [Read more…] about WordPress core, plugins and themes updated to latest versions

Published: 10th July 2016 | Last updated: 20th March 2017

Filed Under: status

Hello Dolly

Hello Dolly [Read more…] about Hello Dolly

Download hello-dolly from wordpress.org

Published: 5th April 2016 | Last updated: 17th November 2019

Akismet

spam protection [Read more…] about Akismet

Download akismet from wordpress.org

Published: 5th April 2016 | Last updated: 17th November 2019

WordPress core and plugins re-parsed

The Dynamic API reference for WordPress, and the default plugins and themes have been updated to reflect their latest versions.

WordPress core a2z

Published: 5th November 2015 | Last updated: 20th March 2017

Filed Under: status

oik-plugins updated to v1.15.4

The version of oik-plugins used on this site has been updated to v1.15.4. You will notice that the Shortcodes tab is not yet populated. This will be addressed soon.

Published: 17th October 2015 | Last updated: 20th March 2017

Filed Under: status

Wp-core-a2z now at v4.2

WordPress v4.2 was released on 23rd April 2015. Wp-core-a2z now reflects the latest level of code.

Other sites will be updated in due course.

Published: 27th April 2015 | Last updated: 20th March 2017

Filed Under: status Tagged With: 4.2

Updates for WordPress 4.1and latest plugin versions

The WP-a2z Dynamic API Reference has been updated for WordPress 4.1 and recent versions of the plugins. See the table for details. . [Read more…] about Updates for WordPress 4.1and latest plugin versions

Published: 28th December 2014 | Last updated: 20th March 2017

Filed Under: status

WP-a2z upgraded to oik-shortcodes v1.26

WP-a2z.org is now running the latest version of the oik-shortcodes plugin. [Read more…] about WP-a2z upgraded to oik-shortcodes v1.26

Published: 12th November 2014 | Last updated: 20th March 2017

Filed Under: status

How is the Long description from the docblock formatted?

The Long description is the part of the PHP docblock between the short description and other tags. Formatting of this can be tricky. WP-a2z does not yet contain the logic to do a good job.

We’re working on it. [Read more…] about How is the Long description from the docblock formatted?

Published: 3rd November 2014 | Last updated: 3rd November 2014

What does “Implementers” show

The Implementers section displays the APIs which implement the action or filter. [Read more…] about What does “Implementers” show

Published: 3rd November 2014 | Last updated: 3rd November 2014

Comparing WP-a2z.org with hookr.io and developer.wordpress.org

In addition to the parallel project of WP-Parser for developer.wordpress.org there is another API reference called hookr.io. I first became aware of it through WP Tavern’s announcement earlier in the year Introducing Hookr.io: A New Resource For WordPress Developers.

After I wrote to WP Tavern to publicise WP-a2z.org, Jeff Chandler quite correctly asked “How does your reference differ from hookr.io” and “Is it any better you think than the one on developer.wordpress.org?”.

So I’ve had a good look at the latest incarnation of hookr.io and compared it with my own WP-a2z.org and developer.wordpress.org.

Brief overview of WP-a2z.org

WP-a2z implements a dynamic API reference for WordPress core, plugins and themes, with drill down navigation and called by or invoked by links.

It provides reference information for the PHP Files, Classes and APIs ( Functions and Methods ), plus the action hooks and filters.

In an attempt to reduce information overload the results that aid navigation are paginated.

While the name of the site suggests that pagination would be through links labelled A to Z, this hasn’t (yet) been implemented; it’s probably not the best way to navigate the code.

For more information see the Press release and a series of FAQ’s.

Quick review of hookr.io

Hookr.io seems to have come along in leaps and bounds. Initially restricted to a subset of WordPress, it now covers all hook invocations, actions and filters. It also displays classes, functions and shortcode invocations.

When viewing the source of a function you can drill down into other WordPress functions. But you can’t go up the call tree.

Hookr.io has an advanced AJAX user interface that takes a bit of learning and getting used to.

For example, it has some interesting JavaScript effects that blurs the code when you hover over it and some fancy colour coding beside links.

I’m glad to see that hookr.io has added plugins. Lots of them, if you know where to look: hookr.io/plugins.

There are parts of the function display that I particularly like e.g. links from signature parameters to the parameters table. But there are also other bits that are missing. e.g. the long description.

I don’t know what parser Christopher Sanford has used to build his solution but it would appear he’s had to deal with similar challenges to those faced by myself and the WP-Parser team.

  • hookr.io does not yet parse classes into their methods.
  • Nor does it actually display the files.

Given the complexity of the code and the slightly different approaches taken to parsing it, it’s no surprise that our results sets are slightly different.

Quick review of developer.wordpress.org

The Code reference part of WordPress.org is tucked away inside developer.wordpress.org at developer.wordpress.org/reference. There’s no direct link from WordPress.org.

The User Interface doesn’t seem to have improved much in the last few months.

Although we’re invited to “Search the codebase for documentation”, once you’ve found something the Code Reference search box disappears. You have to use breadcrumbs or the back button to perform another search.

In my opinion, developer.wordpress.org:

  • doesn’t help you navigate the code,
  • hasn’t really attempted to crack the mega data problem,
  • nor is it nicely linked to or from the codex.

I know that a lot of good work has gone into formatting the parameters in the docblocks ( see register_post_type() ) , but until visitors to the codex see these automatically generated results, there will be little benefit.

Although WP-Parser is now being developed by a whole team of people, I feel that the results on developer.wordpress.org are still only usable as a reference when you don’t have the source code in front of you.

developer.wordpress.org also supports User Contributed Notes, though I have no idea how these are added!

Comparison of WP-a2z.org, hookr.io and developer.wordpress.org

Feature WP-a2z hookr.io developer. wordpress. org See also
WordPress versions 4.0 Up to 3.9.1 4.0  
Plugins some many none
Themes 3 None yet?
Dynamic docblock parsing  
Dynamic source parsing  
A to Z selection method? paginated list
paged
nicely implemented paged  
Search ?s=  
AJAX UI  
Responsive  

Reference information

Implemented as post types or taxonomies /

Feature WP-a2z hookr.io developer. wordpress. org
Files
Classes
Methods
Functions
Hooks
Constants
Since

None of the solutions provide

  • An API reference for jQuery/JavaScript code
  • The processing flow in common scenarios
  • Where used trees for files
  • Reference for global variable or class properties

In-source navigation

Feature WP-a2z.org hookr.io developer. wordpress. org
Syntax highlighting
In-source navigation
Method links
Hook invocation
PHP links
new Class links
Dynamically parsed
if necessary?

See also

File documentation

Only WP-a2z.org treats files as a separate post type.

When viewed the source file is dynamically parsed to determine the functions and classes implemented. These are stripped out and replaced by comments with links. The remaining code is then treated as an API, displaying:

  • Syntax highlighted source with in-source navigation
  • Called by – tbc
  • Invoked by – tbc
  • Calls
  • Call hooks

See

Cannot find file(s):wp-login.php

Class documentation

Feature WP-a2z hookr.io developer. wordpress. org
Post type class class class
Long description – well formatted
Source
Properties
Method list see source
Extends / Interfaces see source
Extended by – not working? see source
Since

Method documentation

Feature WP-a2z.org hookr.io developer. wordpress. org
Post type APIs n/a method

For both WP-a2z and developer.wordpress.org the content displayed is the same as for Functions.

Function documentation

Feature WP-a2z hookr.io developer. wordpress. org See also
Post type APIs functions functions  
Long description
Signature: usage parameters and returns
array @param formatting  
In-source navigation
Called by
Invoked by
Calls
Call hooks
Changelog “Since”  
User Contributed Notes  

Hook documentation

WP-a2z.org and developer.wordpress.org treat action hooks and filters as the same post type.

hookr.io displays hooks in three ways

  1. Hooks
  2. Actions
  3. Filters

It uses headings of Defined and Related to show where calls to add_action(), do_action(), apply_filters() are implemented. It also shows where remove_filter() is used.

These are similar to, but not quite the same as Invokers and Implementers.

Feature wp-a2z.org hookr.io developer. wordpress. org
Post type hook hook action filter hook
Long description
Invokers
Implementers

See also and .

Constants

Currently only hookr.io displays information about Constants. The codex contains some information about commonly used constants.

Anything else?

The above tables reflect my understanding as of 3rd November 2014. Please advise any errors or omissions.

I’m sure there are many more properties that could be compared..

But the most important test of the API reference is a question you can ask yourself…

Does it help me to do my job?

My honest answer, for all three solutions combined is “No. Not yet!”

Published: 3rd November 2014 | Last updated: 20th March 2017

Filed Under: status Tagged With: comparison, developer.wordpress.org, hookr.io

oik20120 theme’s mobile Menu working once more

The theme used on this site is a simple child theme of Twenty Twelve. When the parent theme was updated to v1.5 the mobile menu stopped working. This has now been fixed with a new version of the child theme – oik20120 v0.30. [Read more…] about oik20120 theme’s mobile Menu working once more

Published: 27th October 2014 | Last updated: 20th March 2017

Filed Under: status Tagged With: oik20120, Twenty Twelve

WooCommerce now at v2.2.7, Easy-Digital-Downloads at 2.1.7

The WP-a2z Dynamic API Reference has been updated for WooCommerce and Easy-Digital-Downloads. [Read more…] about WooCommerce now at v2.2.7, Easy-Digital-Downloads at 2.1.7

Published: 25th October 2014 | Last updated: 20th March 2017

Filed Under: status Tagged With: Easy-Digital-Downloads, WooCommerce

Which themes are included in the WP-a2z Dynamic API reference?

Q. Which themes are included in the WP-a2z Dynamic API reference? A. The themes vary by sub-domain. Each sub-domain contains the API reference for WordPress core, plus a selected set of themes and/or plugins. [Read more…] about Which themes are included in the WP-a2z Dynamic API reference?

Published: 24th October 2014 | Last updated: 24th October 2014

Which plugins are used by WP-a2z?

Q. What are the plugins used in WP-a2z and what are the dependencies? A. WP-a2z is driven by a number of plugins. The plugin that defines the APIs, Classes, Files and Hooks is oik-shortcodes. See the diagram for the plugins upon which oik-shortcodes is dependent. [Read more…] about Which plugins are used by WP-a2z?

Published: 24th October 2014 | Last updated: 24th October 2014

Press Release: WordPress a2z – the Dynamic API Reference

In this article I introduce WP-a2z: Dynamic API Reference for WordPress, plugins and themes.

What it is, what it’s for, how you can use it today and future plans.

[Read more…] about Press Release: WordPress a2z – the Dynamic API Reference

Published: 24th October 2014 | Last updated: 20th March 2017

Filed Under: status, TODO

What custom post type relationships are used?

Q. How is the information stored in the WordPress database? What post types are used and what are the relationships between them? A. There are many post types with links between them. See the diagram. [Read more…] about What custom post type relationships are used?

Published: 24th October 2014 | Last updated: 24th October 2014

Where are the FAQ’s

The Frequently Asked Questions are in the root site ( wp-a2z.org ). Other sites create links to the FAQ using MultiSite capability. [Read more…] about Where are the FAQ’s

Published: 24th October 2014 | Last updated: 20th March 2017

Filed Under: status

What does “Call hooks” show?

The Call hooks section displays the action hooks and filters invoked by the function or file [Read more…] about What does “Call hooks” show?

Published: 25th September 2014 | Last updated: 25th September 2014

What does “Calls” show?

The Calls section displays a list of APIs called by the function or file [Read more…] about What does “Calls” show?

Published: 25th September 2014 | Last updated: 25th September 2014

What does “Invoked by” show

The Invoked by section displays the hook(s) for which the function has been registered. [Read more…] about What does “Invoked by” show

Published: 24th September 2014 | Last updated: 24th September 2014

What does “Called by” show?

The Called by section displays a list of APIs or files that invoke the API. [Read more…] about What does “Called by” show?

Published: 24th September 2014 | Last updated: 24th September 2014

woocommerce.wp-a2z.org for WooCommerce v2.2.4

This afternoon we started creating the Dynamic API Reference for WooCommerce v2.2.4. [Read more…] about woocommerce.wp-a2z.org for WooCommerce v2.2.4

Published: 22nd September 2014 | Last updated: 20th March 2017

Filed Under: status Tagged With: WooCommerce

WP-a2z.org – home of the WordPress Dynamic API Reference

WP-a2z.org is a WordPress Multisite implementation with sub-domains for popular WordPress plugins. [Read more…] about WP-a2z.org – home of the WordPress Dynamic API Reference

Published: 8th July 2014 | Last updated: 10th April 2017

Filed Under: status

Hello world!

Welcome to WordPress. This is your first post. Edit or delete it, then start blogging!

Published: 8th July 2014 | Last updated: 8th July 2014

Filed Under: Uncategorized

Is this site self documenting?

In other words, where’s the API Reference for the code that makes this site work? Answer: See oik-shortcodes [Read more…] about Is this site self documenting?

Published: 3rd June 2014 | Last updated: 3rd June 2014

What’s this website about?

wp-a2z.org provides a Dynamic API Reference for WordPress. Watch this silent video for a brief introduction. [Read more…] about What’s this website about?

Published: 2nd June 2014 | Last updated: 2nd June 2014

How do I report a bug in WP-A2Z?

Answer: If you’ve found what appears to be a bug in the Dynamic API Reference then please let us know, using the contact form. [Read more…] about How do I report a bug in WP-A2Z?

Published: 2nd June 2014 | Last updated: 2nd June 2014

What does Dynamic API Reference (DAR) mean?

Answer: You’ve got it in one. It’s an API Reference that is Dynamic. [Read more…] about What does Dynamic API Reference (DAR) mean?

Published: 2nd June 2014 | Last updated: 2nd June 2014

What does a2z mean?

a2z – Represents the vision… 

WP-a2z… The complete reference for the WordPress Application Programming Interface

[Read more…] about What does a2z mean?

Published: 2nd June 2014 | Last updated: 2nd June 2014

  • « Go to Previous Page
  • Go to page 1
  • Go to page 2
  • Go to page 3
  • Go to Next Page »

Footer

WordPress a2z
WordPress a2z
WordPress Dynamic API Reference
WordPress 5.9.3. PHP: 8.0.19
WordPress a2z
WordPress core a2z
Genesis Theme Framework a2z
Jetpack a2z
WordPress develop tests
Easy Digital Downloads a2z
WooCommerce a2z
Yoast SEO a2z
WordPress Blocks

Site:  wp-a2z.org
© Copyright WordPress a2z 2014-2022. All rights reserved.


Website designed and developed by Herb Miller
Proudly powered by WordPress and oik plugins

  • Home
  • Blog
  • Sitemap
  • Sites