- Why You Should Use The Core APIs
- WordPress Core APIs
- WordPress.org API
- Other Resources
The WordPress Core Application Programming Interface (API) is comprised of several individual APIs, each one covering the functions involved in, and use of, a given set of functionality. Together, these form the project interface which allows plugins and themes to interact with, alter, and extend WordPress core functionality.
Why You Should Use The Core APIs #
Using the core APIs when developing for WordPress is strongly encouraged because:
- Core APIs make building things for WordPress easier by providing hooks, actions, filters, helper functions.
- WordPress does the “heavy lifting” for you (database calls, input validation, security, form building) so you don’t have to.
- Using core APIs ensures your code will be both backward-compatible and future-proof.
- The APIs allow seamless integration into wp-admin for plugin/theme options pages, inline help documentation, etc.
WordPress Core APIs #
The following is an overview of the individual APIs that make up the WordPress Core API. More information on each API can be found on their respective Codex pages.
Dashboard Widgets API #
The Dashboard Widgets API, added in WordPress 2.7, makes it very simple for plugin or theme authors to add new widgets to the admin dashboard. Widgets created using the API will automatically appear on the admin dashboard, will contain all the standard custom features including drag/drop, minimize, and configure, and appear in the screen options so users can hide them, if desired.
Database API #
The Database API, added in WordPress 0.71, provides the correct method for accessing data as named values which are stored in the database layer.
File Header API #
The File Header API, added in WordPress 1.5 and extended in WordPress 2.9 and 3.0, consists of functions and hooks regarding the use of file headers in themes and plugins, and provides the ability to pull meta-information (Name, Version, Author, URI, Description, etc.) from those files.
Filesystem API #
The Filesystem API, added in WordPress 2.6, was originally created for WordPress’ own automatic updates feature. The API abstracts out the functionality needed for reading and writing local files to the filesystem to be done securely, on a variety of host types, using the WP_Filesystem_Base class, and several sub-classes which implement different ways of connecting to the local filesystem, depending on individual host support.
HTTP API #
The HTTP API, added in WordPress 2.7 and extended further in WordPress 2.8, standardizes the HTTP requests for WordPress. The API handles cookies, gzip encoding and decoding, chunk decoding (if HTTP 1.1), and various other HTTP protocol implementations. The API standardizes requests, tests each method prior to sending, and, based on your server configuration, uses the appropriate method to make the request.
Metadata API #
The Metadata API, added in WordPress 2.9, is a simple and standardized way for retrieving and manipulating metadata of various WordPress object types. Metadata for an object is a represented by a simple key-value pair. Objects may contain multiple metadata entries that share the same key, and differ only in their value.
Options API #
The Options API, added in WordPress 1.0 and extended in versions 1.2 and 1.5, is a simple and standardized way of storing data in the database. The API makes it easy to create, access, update, and delete those options. All the data is being stored in the
wp_options table under a given custom name.
Plugin API #
The Plugin API, added in WordPress 1.5, allows for creating actions and filters in hooking functions and methods. The functions or methods will then be run when the action or filter is called. Hooks are provided by WordPress to allow your plugin to hook into the rest of WordPress; that is, to call functions in your plugin at specific times, and set your plugin in motion.
Quicktags API #
The Quicktags API, added in WordPress 3.3, allows you to include additional buttons in the Text (HTML) mode of the WordPress editor.
Rewrite API #
The Rewrite API, added in WordPress 2.1, is used to manage the rewrite rules that allow you to use the Pretty Permalinks feature. It has several methods that generate the rewrite rules from values in the database. It is used internally when updating the rewrite rules, and also to find the URL of a specific post, page, category archive, etc. It also allows theme and plugin developers to specify new, custom rewrite rules.
Settings API #
The Settings API, added in WordPress 2.7, allows admin pages containing settings forms to be created and managed semi-automatically. It lets plugin and theme developers define settings pages, sections within those pages, and fields within the sections. New settings pages can be registered, and new settings sections or fields can be added to existing settings pages.
Shortcode API #
The Shortcode API, added in WordPress 2.5, is a set of functions that create a simple hook used to pull in content. Using the API, plugin developers can create special kinds of content (e.g. forms, content generators, galleries, etc.) that users can add to posts or pages by inserting the corresponding [shortcode] into the content.
Theme Modification API #
The Theme Modification API, added in WordPress 2.1, consists of the functions and hooks related to the use of theme modification values. These functions can be used by theme authors to save and retrieve modifications to their themes as options.
Theme Customization API #
The Theme Customization API, added in WordPress 3.4, allows theme developers to add custom options specific to their theme to the Theme Customization admin screen (aka Theme Customizer).
Transients API #
The Transients API, added in WordPress 2.8, offers a simple and standardized way of storing cached data in the database temporarily by giving it a custom name and a timeframe, after which it will expire and be deleted. The Transients API is very similar to the Options API, but with the added feature of an expiration time, which simplifies the process of using the
wp_options database table to temporarily store cached information.
Widgets API #
The Widgets API, added in WordPress 2.8, allows developers to build custom widgets for use in sidebars and other widgetized areas of a theme. The API simplifies the widget creation process, and makes all widgets multiple instance capable.
XML-RPC WordPress API #
The XML-RPC WordPress API, added in WordPress 1.5, allows other systems to connect to and communicate with WordPress, even remotely, including publishing clients (desktop and mobile), and other software that perform batch tasks like creating multiple posts from a file, etc.
WordPress.org API #
There are also APIs available for the WordPress.org site:
- Secret Key: Secret key and salt generator for
- Stats API: Stats about the systems websites are running WordPress on.
- Version Check API: WordPress version checker.
- Credits API: Details about the various individuals who contribute to the WordPress code base, which are used in the Credits screen in
- Popular Import Plugin API: List of popular import plugins in the WordPress Plugin Directory, which is used by the Tools > Import screen in
- Plugins API: Provides information on plugins hosted on WordPress.org, and allows WordPress to check the repository for updates to those plugins.
- Themes API: Provides information on themes hosted on WordPress.org, and allows WordPress to check the repository for updates to those themes.