WordPress 4.8 Evans now being parsed
WordPress 4.8, code named “Evans”, was released on 8th June 2017. It is now being re-parsed on wp-a2z.org and sub-domains. [Read more…] about WordPress 4.8 Evans now being parsed
WordPress 4.8, code named “Evans”, was released on 8th June 2017. It is now being re-parsed on wp-a2z.org and sub-domains. [Read more…] about WordPress 4.8 Evans now being parsed
WordPress 4.7.3, a Security and Maintenance Release, was released on 6th March 2017.
WP-a2z is being updated to reflect the new version. [Read more…] about WP-a2z being updated for WordPress 4.7.3
WordPress 4.7.2, a Security Release, was issued on 26th January 2017. It has now been parsed on the following sites:
Note: The changes in WordPress 4.7.1 have also been reflected in the latest parse.
WordPress version 4.7 ( released 6th December 2016), has now been installed on this site and the source code has been re-parsed. [Read more…] about WordPress 4.7 – Vaughan – now parsed
WordPress version 4.6 ( released 17th August 2016), has now been installed on this site and the source code has been re-parsed. [Read more…] about WordPress 4.6 “Pepper” now parsed
Over the last few days this site has been hit by a number of problems. We’ve taken a few steps to resolve each of the issues. We’re continually working to improve the service. [Read more…] about Sorry for the recent outages
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
Hello Dolly [Read more…] about Hello Dolly
Download hello-dolly from wordpress.org
Published: | Last updated:
spam protection [Read more…] about Akismet
Download akismet from wordpress.org
Published: | Last updated:
The Dynamic API reference for WordPress, and the default plugins and themes have been updated to reflect their latest versions.
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.
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.
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
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
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: | Last updated:
The Implementers section displays the APIs which implement the action or filter. [Read more…] about What does “Implementers” show
Published: | Last updated:
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.
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.
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.
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.
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:
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!
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
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? |
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:
See
Cannot find file(s):wp-login.php
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 |
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.
WP-a2z.org and developer.wordpress.org treat action hooks and filters as the same post type.
hookr.io displays hooks in three ways
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 |
Currently only hookr.io displays information about Constants. The codex contains some information about commonly used constants.
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!”
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
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
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: | Last updated:
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: | Last updated:
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
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: | Last updated:
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
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: | Last updated:
The Calls section displays a list of APIs called by the function or file [Read more…] about What does “Calls” show?
Published: | Last updated:
The Invoked by section displays the hook(s) for which the function has been registered. [Read more…] about What does “Invoked by” show
Published: | Last updated:
The Called by section displays a list of APIs or files that invoke the API. [Read more…] about What does “Called by” show?
Published: | Last updated:
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
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