WordPress Core
WordPress core and canonical plugin documentation generated and maintained from source code.
WordPress Core HTTP Streaming Analysis
Full Call Chain wp_remote_get($url, $args) # wp-includes/http.php └─► _wp_http_get_object()->get($url, $args) # WP_Http singleton └─► WP_Http::request($url, $args) # wp-includes/class-wp-http.php │ ├─...
User Docs Generation Plan
Goal Build a non-technical WordPress documentation lane for people using WordPress in the editor, admin, and site-building UI. This lane...
Project Direction
Purpose wp-docs uses docs-agent to generate WordPress core and canonical plugin documentation from public source material. The project should become...
Full-Coverage Generation Plan
Goal Build a full-coverage WordPress documentation system that starts as an internal Automattic docs site and can later generate high-quality...
Recipes
This directory holds project-specific WP Codebox recipes for reproducible generation and review runs. WP Codebox owns the recipe schema, sandbox...
Script Modules Pilot Recipe
This recipe defines the first bounded WP Docs generation pass. It is intentionally narrow so the output can be reviewed...
Sources
This directory tracks project-specific source inventories and generation targets. Do not vendor WordPress core, canonical plugins, Gutenberg, or related source...
Content
This directory holds generated and reviewed documentation content. Planned lanes: raw/ — disposable generated drafts. user/ — user-facing documentation. developer/...
Content Metadata
This directory is for metadata that belongs with the generated documentation corpus. Examples: Content indexes. Review ledgers. Page status schemas....
Provenance
This directory holds lightweight project-level provenance notes and schemas. Large execution artifacts, screenshots, logs, and previews should stay with the...
Agent Configuration
This directory holds WP Docs project-specific agent inputs. Reusable documentation agent behavior belongs in Automattic/docs-agent. This repo should only define...
WordPress XML-RPC API Overview
WordPress provides XML-RPC functionality for remote publishing and content management. This API allows external applications to interact with WordPress for...
wp_xmlrpc_server Class Reference
File: wp-includes/class-wp-xmlrpc-server.php Since: 1.5.0 WordPress XMLRPC server implementation providing compatibility for Blogger API, MetaWeblog API, MovableType, pingback, and WordPress-native methods....
WordPress XML-RPC Hooks Reference
All hooks available in the WordPress XML-RPC server implementation. Filters xmlrpc_enabled Controls whether XML-RPC methods requiring authentication are enabled. add_filter(...
Security Settings
WordPress security constants protect your site through authentication tokens, file access controls, and SSL/HTTPS enforcement. Security Keys and Salts Security...
Update Settings
WordPress provides granular control over automatic updates for core, plugins, themes, and translations. Core Update Constants WP_AUTO_UPDATE_CORE define( 'WP_AUTO_UPDATE_CORE', true...
wp-config.php Overview
The wp-config.php file is WordPress's primary configuration file. It contains the essential settings WordPress needs to connect to the database...
Multisite Settings
WordPress Multisite (formerly WPMU) allows running multiple sites from a single WordPress installation. These constants configure and control the network....
Path Settings
WordPress allows customization of directory locations and URLs through constants. These are useful for non-standard installations, security, or organizational preferences....
Performance Settings
WordPress provides several constants to control memory usage, caching, cron behavior, and script handling for optimal performance. Memory Limits WP_MEMORY_LIMIT...
Tools
tools.php URL: /wp-admin/tools.php Capability required: Varies by tool; base page is available to admins. Import section requires import; category/tag conversion...
Users
users.php URL: /wp-admin/users.php Capability required: list_users (and related caps like edit_users, delete_users, promote_users, remove_users). What it does: Lists users, handles...
Admin Pages
WordPress admin (wp-admin/) page files. Source: wp-admin/*.php Page Categories Category Description core.md Dashboard, profile, about posts.md Post management screens pages.md...
Pages (Post Type: page)
Pages use the same core files as posts, with post_type=page in the URL and page-specific capabilities. edit.php (Pages list) URL:...
Plugins
plugins.php URL: /wp-admin/plugins.php Capability required: activate_plugins (and related caps like deactivate_plugins, delete_plugins, update_plugins). What it does: Lists installed plugins, handles...
Posts (Post Type: post)
edit.php (Posts list) URL: /wp-admin/edit.php Capability required: $post_type_object->cap->edit_posts (typically edit_posts). What it does: Lists posts for the post post type,...
Widgets API
Framework for creating dynamic sidebars and registering widgets in WordPress. Since: 2.2.0 Source: wp-includes/widgets.php, wp-includes/class-wp-widget.php, wp-includes/class-wp-widget-factory.php, wp-includes/widgets/ Components Component Description...
Widget Functions
Core functions for registering and managing widgets and sidebars. Source: wp-includes/widgets.php Widget Registration register_widget() Registers a widget class with WordPress....
Widget Hooks
Actions and filters for the Widgets API. Source: wp-includes/widgets.php, wp-includes/class-wp-widget.php Actions widgets_init Fires after all default WordPress widgets have been...
WP_Widget
Base class for creating widgets. Must be extended. Source: wp-includes/class-wp-widget.php Since: 2.8.0 Class Synopsis #[AllowDynamicProperties] class WP_Widget { // Properties...
WP_Widget_Factory
Singleton that registers and manages WP_Widget classes. Source: wp-includes/class-wp-widget-factory.php Since: 2.8.0 Global: $wp_widget_factory Class Synopsis #[AllowDynamicProperties] class WP_Widget_Factory { //...
Walker (Base Class)
Abstract class for displaying hierarchical tree structures. Since: 2.1.0 Source: wp-includes/class-wp-walker.php Class Synopsis #[AllowDynamicProperties] class Walker { // Properties public...
Walker Hooks
Filters available in WordPress Walker classes. Category Walkers list_cats Filters the category name for display. apply_filters( 'list_cats', string $cat_name, WP_Term...
Walker Classes
Abstract pattern for traversing and rendering hierarchical tree structures. Since: 2.1.0 Source: wp-includes/class-wp-walker.php, wp-includes/class-walker-*.php Components Component Description class-wp-walker.md Base abstract...
Walker_Comment
Creates an HTML list of threaded comments. Since: 2.7.0 Source: wp-includes/class-walker-comment.php Used by: wp_list_comments() Class Synopsis class Walker_Comment extends Walker...
Walker_PageDropdown
Creates an HTML dropdown (<option> elements) for hierarchical pages. Since: 2.1.0 Source: wp-includes/class-walker-page-dropdown.php Used by: wp_dropdown_pages() Class Synopsis class Walker_PageDropdown...
Walker_Page
Creates an HTML list of hierarchical pages. Since: 2.1.0 Source: wp-includes/class-walker-page.php Used by: wp_list_pages() Class Synopsis class Walker_Page extends Walker...
WP_Session_Tokens
Abstract class for managing user session tokens. Source: wp-includes/class-wp-session-tokens.php Since: 4.0.0 Overview WordPress uses session tokens to track authenticated user...
Utility Hooks
Actions and filters for WordPress utility classes. Session Token Hooks session_token_manager Filters the session token manager class. apply_filters( 'session_token_manager', string...
Speculative Loading
Prefetch and prerender API using the Speculation Rules API. Source: wp-includes/speculative-loading.php Since: 6.8.0 Overview Speculative loading allows browsers to prefetch...
Utility Classes
Core utility classes for common operations in WordPress. Source: wp-includes/ Components Component Description class-wp-list-util.md Array/object list operations (filter, pluck, sort)...
WP_Duotone
Manages duotone block supports and global styles. Source: wp-includes/class-wp-duotone.php Since: 6.3.0 Access: Private/Internal Overview Duotone applies a two-color gradient effect...
WP_List_Util
Utility class for performing operations on arrays of objects or arrays. Source: wp-includes/class-wp-list-util.php Since: 4.7.0 Properties Property Type Visibility Description...
WordPress Users API
Core system for managing users, authentication, roles, and capabilities. Since: 2.0.0 Source: wp-includes/user.php, wp-includes/capabilities.php, wp-includes/class-wp-*.php Components Component Description functions.md User...
WP_User Class
Core class representing a WordPress user with their data and capabilities. Since: 2.0.0 Source: wp-includes/class-wp-user.php Overview WP_User represents an individual...
User Functions
Core functions for user management, authentication, metadata, and utilities. Source: wp-includes/user.php, wp-includes/capabilities.php, wp-includes/pluggable.php User Retrieval get_user() Retrieves user by ID....
User Hooks
Actions and filters for user management, authentication, roles, and capabilities. Source: wp-includes/user.php, wp-includes/capabilities.php, wp-includes/class-wp-*.php Authentication Actions wp_authenticate Fires before user...
WP_User_Query Class
Core class for querying users with flexible filtering, sorting, and pagination. Since: 3.1.0 Source: wp-includes/class-wp-user-query.php Overview WP_User_Query provides a powerful...
WP_Role Class
Core class representing a single user role with its capabilities. Since: 2.0.0 Source: wp-includes/class-wp-role.php Overview WP_Role represents an individual role...
WordPress Update System
Source: wp-includes/update.php Since: WordPress 2.3.0 Purpose The Update system checks for available updates to WordPress core, plugins, and themes by...
Update Functions
Source: wp-includes/update.php Core Update Functions wp_version_check() Checks WordPress version against the newest version available on WordPress.org. wp_version_check( array $extra_stats =...
Update Hooks
Source: wp-includes/update.php Filters core_version_check_locale Filters the locale requested for WordPress core translations. apply_filters( 'core_version_check_locale', string $locale ) Parameters: $locale (string)...
WordPress Themes API Overview
The Themes API provides comprehensive functionality for theme management, template loading, global styles, and the transition from classic to block-based...
WordPress Theme Functions Reference
Complete reference for WordPress theme-related functions. Theme Information Functions wp_get_theme() Gets a WP_Theme object for a theme. wp_get_theme( string $stylesheet...
WordPress Theme Hooks Reference
Complete reference for theme-related action hooks and filters. Template Loading Actions template_redirect Fires before determining which template to load. do_action(...
WP_Theme Class Reference
The WP_Theme class encapsulates theme data and provides methods for accessing theme information, files, and configuration. Class Overview final class...
WP_Theme_JSON & WP_Theme_JSON_Resolver Reference
These classes handle the processing of theme.json configuration files, providing a structured way to manage global styles and settings. WP_Theme_JSON...
Template Parts
Complete reference for templateParts in theme.json. Overview The templateParts array registers reusable template sections like headers, footers, and sidebars. {...
theme.json
Global settings and styles configuration for WordPress block themes. Since: 5.8.0 Current Schema Version: 3 Source: wp-includes/class-wp-theme-json.php Purpose theme.json provides...
Spacing Settings
Complete reference for settings.spacing in theme.json. Overview { "settings": { "spacing": { "blockGap": null, "customSpacingSize": true, "defaultSpacingSizes": true, "margin": false,...
Typography Settings
Complete reference for settings.typography in theme.json. Overview { "settings": { "typography": { "customFontSize": true, "defaultFontSizes": true, "dropCap": true, "fluid": false,...
Styles Configuration
Complete reference for styles in theme.json. Overview The styles section defines CSS styling rules that WordPress applies globally and per-block....
Color Settings
Complete reference for settings.color in theme.json. Overview { "settings": { "color": { "background": true, "custom": true, "customDuotone": true, "customGradient": true,...
footer.php
Fallback footer template for themes that do not provide their own. Source: wp-includes/theme-compat/footer.php Deprecated: 3.0.0 Subpackage: Theme_Compat Purpose Loaded by...
header-embed.php
Embed header template — HTML document opening for oEmbed iframes. Source: wp-includes/theme-compat/header-embed.php Since: 4.5.0 Subpackage: Theme_Compat Purpose Loaded by get_header(...
header.php
Fallback header template for themes that do not provide their own. Source: wp-includes/theme-compat/header.php Deprecated: 3.0.0 Subpackage: Theme_Compat Purpose Loaded by...
sidebar.php
Fallback sidebar template for themes that do not provide their own. Source: wp-includes/theme-compat/sidebar.php Deprecated: 3.0.0 Subpackage: Theme_Compat Purpose Loaded by...
embed-404.php
Embed 404 template — displayed when an embedded post cannot be found. Source: wp-includes/theme-compat/embed-404.php Since: 4.5.0 Subpackage: Theme_Compat Purpose Loaded...
embed-content.php
Embed content template — renders a post's content within an oEmbed iframe. Source: wp-includes/theme-compat/embed-content.php Since: 4.5.0 Subpackage: Theme_Compat Purpose Loaded...
Template Tags System
Template tags are WordPress functions designed for use in theme template files. They output dynamic content, generate HTML markup, and...
Template Tag Hooks
Template tags provide extensive hooks for customization. This documents the key actions and filters available. Template Loading Hooks Action: get_header...
Template Tag Functions
Template Part Functions get_header() Loads the header template file. function get_header( $name = null, $args = array() ) Parameters: $name...
Taxonomy API
Framework for classifying and organizing WordPress content through hierarchical and non-hierarchical term groupings. Since: 2.3.0 Source: wp-includes/taxonomy.php, wp-includes/class-wp-taxonomy.php, wp-includes/class-wp-term.php, wp-includes/class-wp-term-query.php...
Taxonomy API Functions
Core functions for taxonomy and term registration, retrieval, and management. Source: wp-includes/taxonomy.php Taxonomy Registration register_taxonomy() Creates or modifies a taxonomy...
Taxonomy API Hooks
Actions and filters for the Taxonomy API. Taxonomy Registration registered_taxonomy Fires after a taxonomy is registered. do_action( 'registered_taxonomy', string $taxonomy,...
WP_Term
Core class used to implement the WP_Term object. Represents a single taxonomy term. Source: wp-includes/class-wp-term.php Since: 4.4.0 Class Declaration #[AllowDynamicProperties]...
WP_Taxonomy
Core class used for interacting with taxonomies. Represents a registered taxonomy and its configuration. Source: wp-includes/class-wp-taxonomy.php Since: 4.7.0 Class Declaration...
WP_Term_Query
Class used for querying terms from the database. Source: wp-includes/class-wp-term-query.php Since: 4.6.0 Class Declaration #[AllowDynamicProperties] class WP_Term_Query Properties Property Type...
WP_Style_Engine_Processor
Compiles styles from stores or collections of CSS rules into a stylesheet. Source: wp-includes/style-engine/class-wp-style-engine-processor.php Since: 6.1.0 Properties Property Type Visibility...
WP_Style_Engine
Core class for parsing block styles and compiling CSS. This is a low-level internal API. Source: wp-includes/style-engine/class-wp-style-engine.php Since: 6.1.0 Access:...
Style Engine Functions
Public API functions for generating and compiling CSS styles. Source: wp-includes/style-engine.php wp_style_engine_get_styles() Generates styles from a block style object (e.g.,...
Style Engine
Consistent API for rendering CSS styles for blocks across client-side and server-side applications. Since: 6.1.0 Source: wp-includes/style-engine.php, wp-includes/style-engine/ Components Component...
WP_Style_Engine_CSS_Declarations
Holds, sanitizes, processes, and prints CSS declarations for the style engine. Source: wp-includes/style-engine/class-wp-style-engine-css-declarations.php Since: 6.1.0 Properties Property Type Visibility Description...
WP_Style_Engine_CSS_Rule
Represents a CSS rule with selector, declarations, and optional rules group (for nested CSS). Source: wp-includes/style-engine/class-wp-style-engine-css-rule.php Since: 6.1.0 Properties Property...
WP_Sitemaps
Main sitemap controller integrating all sitemap components. Source: wp-includes/sitemaps/class-wp-sitemaps.php Since: 5.5.0 Overview The main class that orchestrates sitemap functionality including...
Sitemaps API Functions
Core functions for sitemap management and registration. Source: wp-includes/sitemaps.php wp_sitemaps_get_server() Retrieves the current Sitemaps server instance. wp_sitemaps_get_server(): WP_Sitemaps Returns WP_Sitemaps...
Sitemaps API Hooks
Actions and filters for the Sitemaps API. Actions wp_sitemaps_init Fires when initializing the Sitemaps object. Register additional providers here. do_action(...
Sitemaps API
Framework for generating XML sitemaps in WordPress. Since: 5.5.0 Source: wp-includes/sitemaps.php, wp-includes/sitemaps/ Components Component Description functions.md Core retrieval and registration...
WP_Sitemaps_Provider
Abstract base class for sitemap providers. Source: wp-includes/sitemaps/class-wp-sitemaps-provider.php Since: 5.5.0 Overview Base class that all sitemap providers must extend. Provides...
WP_Sitemaps_Registry
Registry for managing sitemap providers. Source: wp-includes/sitemaps/class-wp-sitemaps-registry.php Since: 5.5.0 Overview Manages registration and retrieval of sitemap providers. Accessed via WP_Sitemaps::$registry....
Site Health & Transients API
WordPress Site Health provides diagnostic tests and debugging info. Transients offer temporary cached data storage with automatic expiration. Since: Site...
Transients API
Temporary data storage with automatic expiration. Uses database or object cache. Since: 2.8.0 Source: wp-includes/option.php Core Functions get_transient() Retrieves a...
WP_Site_Health
Main class for Site Health diagnostic tests and status display. Since: 5.2.0 Source: wp-admin/includes/class-wp-site-health.php Properties private static $instance = null;...
Site Health & Transients Hooks
Actions and filters for Site Health and Transients APIs. Transient Hooks Actions delete_transient_{$transient} Fires before a specific transient is deleted....
WP_Site_Health_Auto_Updates
Tests automatic update capabilities and configuration. Since: 5.2.0 Source: wp-admin/includes/class-wp-site-health-auto-updates.php Constructor Requires wp-admin/includes/class-wp-upgrader.php. Methods run_tests() Executes all auto-update tests and...
WP_REST_Site_Health_Controller
REST API endpoints for asynchronous Site Health tests. Since: 5.6.0 Source: wp-includes/rest-api/endpoints/class-wp-rest-site-health-controller.php Properties private $site_health; // WP_Site_Health instance Namespace: wp-site-health/v1...
Scripts & Styles API
System for registering, enqueueing, and outputting JavaScript and CSS assets in WordPress. Since: 2.1.0 (scripts), 2.6.0 (styles) Source: wp-includes/script-loader.php, wp-includes/functions.wp-scripts.php,...
WP_Styles
Core class for registering and outputting CSS stylesheets. Source: wp-includes/class-wp-styles.php Since: 2.6.0 Extends: WP_Dependencies Properties Public Properties Property Type Since...
Scripts & Styles Functions
Core functions for managing JavaScript and CSS assets. Source: wp-includes/functions.wp-scripts.php, wp-includes/functions.wp-styles.php, wp-includes/script-loader.php Script Functions wp_scripts() Initializes and returns the global...
Scripts & Styles Hooks
Actions and filters for the WordPress scripts and styles system. Actions wp_enqueue_scripts Primary hook for enqueueing front-end scripts and styles....
WP_Dependencies
Base class for managing dependencies. Extended by WP_Scripts and WP_Styles. Source: wp-includes/class-wp-dependencies.php Since: 2.6.0 Properties Public Properties Property Type Since...
WP_Scripts
Core class for registering and outputting JavaScript files. Source: wp-includes/class-wp-scripts.php Since: 2.1.0 Extends: WP_Dependencies Properties Public Properties Property Type Since...
WordPress Shortcodes API Overview
The Shortcodes API provides a bbcode-like tag system for WordPress. It allows developers to create custom macros that users can...
WordPress Shortcodes API Functions
Complete reference for all functions in the WordPress Shortcodes API. Registration Functions add_shortcode() Registers a new shortcode handler. add_shortcode( string...
WordPress Shortcodes API Hooks
Filters and actions available in the WordPress Shortcodes API. Filters pre_do_shortcode_tag Short-circuits shortcode processing before the callback is called. apply_filters(...
Script Modules API
Native support for ES Modules and Import Maps in WordPress. Since: 6.5.0 Source: wp-includes/script-modules.php, wp-includes/class-wp-script-modules.php Components Component Description functions.md Core...
Script Modules Hooks
Actions and filters for customizing script module behavior. Source: wp-includes/class-wp-script-modules.php Filters script_module_loader_src Filters the script module source URL. apply_filters( 'script_module_loader_src',...
WP_Script_Modules Class
Core class for registering and managing script modules. Since: 6.5.0 Source: wp-includes/class-wp-script-modules.php Properties Private Properties Property Type Description $registered array<string,...
Script Modules Functions
Global functions for registering and managing script modules. Source: wp-includes/script-modules.php wp_script_modules() Retrieves the main WP_Script_Modules instance. function wp_script_modules(): WP_Script_Modules Since:...
xmlrpc.php
Purpose XML-RPC endpoint for remote publishing and legacy APIs (MetaWeblog, Blogger, MovableType, etc.). Flow Defines XMLRPC_REQUEST and clears cookies. Reads...
wp-login.php
Purpose Handles authentication-related flows: login, logout, registration, password reset, and admin email confirmation. Flow Loads WordPress via wp-load.php and enforces...
wp-mail.php
Purpose Implements Post by Email: pulls messages from a configured POP3 mailbox and turns them into posts. Flow Loads WordPress...
wp-settings.php
Purpose Core bootstrap that initializes WordPress: loads core libraries, sets constants, configures DB/cache, loads plugins and themes, and fires the...
wp-signup.php
Purpose Multisite signup handler for new users and/or new sites, including validation and form rendering. Flow Loads WordPress (wp-load.php) and...
wp-trackback.php
Purpose Handles incoming trackbacks/pingbacks, validates data, and creates trackback comments. Flow Loads WordPress and runs wp( array( 'tb' => '1'...
WordPress Rewrite API Overview
The WordPress Rewrite API transforms human-readable URLs (permalinks) into query parameters that WordPress can process. It's the foundation of "pretty...
WordPress Rewrite Hooks
Filters and actions for customizing URL rewriting and permalink generation. Actions generate_rewrite_rules Fires after rewrite rules are generated. do_action_ref_array( 'generate_rewrite_rules',...
WP_Rewrite Class
Core class implementing the WordPress rewrite component API. Handles permalink structures, rewrite rules, and URL pattern matching. class WP_Rewrite {...
WordPress Rewrite Functions
Functions for managing URL rewrite rules, tags, endpoints, and permalink structures. add_rewrite_rule() Adds a rewrite rule that transforms a URL...
Robots API
Controls robots.txt generation and meta robots directives for search engine crawlers. Since: 2.1.0 (robots.txt), 5.7.0 (meta robots) Source: wp-includes/robots-template.php, wp-includes/functions.php,...
Robots Functions
Conditional Functions is_robots() Determines whether the query is for the robots.txt file. function is_robots(): bool Since: 2.1.0 Returns: bool —...
Robots Hooks
Filters wp_robots Filters the directives to be included in the robots meta tag. apply_filters( 'wp_robots', array $robots ): array Since:...
`/wp/v2/types`
Namespace: wp/v2 Route: /wp/v2/types Routes Collection: /wp/v2/types Single: /wp/v2/types/{type} HTTP Methods Collection methods: GET Single methods: GET Request Parameters Collection...
`/wp/v2/users/me`
Namespace: wp/v2 Route: /wp/v2/users/me Routes Collection: /wp/v2/users/me HTTP Methods Collection methods: GET, POST, PUT, PATCH, DELETE Request Parameters Collection GET...
`/wp/v2/users`
Namespace: wp/v2 Route: /wp/v2/users Routes Collection: /wp/v2/users Single: /wp/v2/users/{id} HTTP Methods Collection methods: GET, POST Single methods: GET, POST, PUT,...
`/wp/v2/widget-types`
Namespace: wp/v2 Route: /wp/v2/widget-types Routes Collection: /wp/v2/widget-types Single: /wp/v2/widget-types/{id} HTTP Methods Collection methods: GET Single methods: GET Request Parameters Collection...
`/wp/v2/widgets`
Namespace: wp/v2 Route: /wp/v2/widgets Routes Collection: /wp/v2/widgets Single: /wp/v2/widgets/{id} HTTP Methods Collection methods: GET, POST Single methods: GET, POST, PUT,...
`/wp/v2/tags`
Namespace: wp/v2 Route: /wp/v2/tags Routes Collection: /wp/v2/tags Single: /wp/v2/tags/{id} HTTP Methods Collection methods: Unknown Single methods: GET, POST, PUT, PATCH,...
REST API Hooks
Actions and filters for the REST API. Actions rest_api_init Fires when the REST API server is initialized. Register routes here....
REST API
WordPress REST API for building and consuming HTTP-based JSON endpoints. Since: 4.4.0 Source: wp-includes/rest-api.php, wp-includes/rest-api/ Components Component Description functions.md Core...
WP_REST_Server
Core class implementing the WordPress REST API server. Handles route registration, request dispatch, and response formatting. Source: wp-includes/rest-api/class-wp-rest-server.php Since: 4.4.0...
REST API Functions
Core functions for route registration, URL handling, and utilities. Source: wp-includes/rest-api.php Route Registration register_rest_route() Registers a REST API route. Must...
WP_REST_Response
Core class implementing a REST response object. Extends WP_HTTP_Response with link handling and route matching. Source: wp-includes/rest-api/class-wp-rest-response.php Since: 4.4.0 Extends:...
WP_REST_Request
Core class implementing a REST request object. Contains request data passed to endpoint callbacks. Source: wp-includes/rest-api/class-wp-rest-request.php Since: 4.4.0 Implements ArrayAccess...
REST API Controller Hooks
Overview REST API controllers fire numerous hooks for filtering and action purposes. Most hooks include a dynamic portion based on...
WordPress REST API Controllers Overview
Architecture WordPress REST API controllers follow a consistent object-oriented architecture based on the abstract WP_REST_Controller class. Each controller manages a...
WP_REST_Posts_Controller
Core class to access posts via the REST API. The most comprehensive controller, serving as the basis for many other...
WP_REST_Revisions_Controller
Core class used to access revisions via the REST API. Provides read-only access to post revisions plus deletion capability. Class...
WP_REST_Terms_Controller
Core class used to manage terms associated with a taxonomy via the REST API. Class Synopsis class WP_REST_Terms_Controller extends WP_REST_Controller...
WP_REST_Users_Controller
Core class used to manage users via the REST API. Class Synopsis class WP_REST_Users_Controller extends WP_REST_Controller { protected $meta; protected...
Requests Library Overview
The Requests library is an HTTP client for PHP, bundled with WordPress. It provides a clean API for making HTTP...
Requests Utility Classes
Utility classes for the Requests library. Source files: wp-includes/Requests/src/Utility/CaseInsensitiveDictionary.php wp-includes/Requests/src/Utility/FilteredIterator.php wp-includes/Requests/src/Utility/InputValidator.php WpOrgRequestsUtilityCaseInsensitiveDictionary Case-insensitive dictionary, suitable for HTTP headers. Namespace: WpOrgRequestsUtility...
WpOrgRequestsRequests
Main entry point for the Requests HTTP library. This is a purely static class — it cannot be instantiated. Source:...
Requests Interfaces
All interfaces defined in the Requests library. Source files: wp-includes/Requests/src/Auth.php wp-includes/Requests/src/Capability.php wp-includes/Requests/src/HookManager.php wp-includes/Requests/src/Proxy.php wp-includes/Requests/src/Transport.php WpOrgRequestsAuth Authentication provider interface. Source: wp-includes/Requests/src/Auth.php...
WpOrgRequestsSession
Session handler for persistent requests with shared default parameters. Source: wp-includes/Requests/src/Session.php Namespace: WpOrgRequests Overview Session allows setting a base URL,...
WpOrgRequestsSsl
SSL certificate verification utilities for the Requests library. Source: wp-includes/Requests/src/Ssl.php Namespace: WpOrgRequests Package: RequestsUtilities Modifier: final Overview A collection of...
Recovery Mode
Error protection system that detects fatal errors from plugins/themes and allows administrators to safely access the site. Since: 5.2.0 Source:...
WP_Recovery_Mode_Key_Service
Service class for generating, storing, and validating recovery mode keys. Source: wp-includes/class-wp-recovery-mode-key-service.php Since: 5.2.0 Properties Property Type Visibility Description $option_name...
WP_Recovery_Mode_Link_Service
Service class for generating and handling recovery mode links. Source: wp-includes/class-wp-recovery-mode-link-service.php Since: 5.2.0 Constants Constant Value Description LOGIN_ACTION_ENTER 'enter_recovery_mode' Login...
WP_Recovery_Mode
Core class implementing Recovery Mode functionality. Orchestrates cookie, key, link, and email services. Source: wp-includes/class-wp-recovery-mode.php Since: 5.2.0 Constants Constant Value...
Error Protection Functions
Core functions for the error protection and recovery mode system. Source: wp-includes/error-protection.php wp_recovery_mode() Accesses the global WordPress Recovery Mode instance....
Recovery Mode Hooks
Actions and filters for the error protection and recovery mode system. Source: Various recovery mode files Actions generate_recovery_mode_key Fires when...
WordPress Query API
The Query API is the backbone of WordPress content retrieval, powering The Loop and determining what content displays on every...
Query Functions
Functions for querying posts, managing The Loop, and checking query conditions. Source: wp-includes/query.php Loop Functions have_posts() Determines whether current WordPress...
Query API Hooks
Actions and filters for modifying WordPress queries. Source: wp-includes/class-wp-query.php, wp-includes/query.php Actions Query Lifecycle pre_get_posts Fires after the query variable object...
WP_Query Class
The main WordPress query class. Handles post retrieval, The Loop, and query state. Source: wp-includes/class-wp-query.php Since: 1.5.0 Basic Usage $query...
WP_Date_Query Class
Generates SQL clauses for filtering queries by date columns. Source: wp-includes/class-wp-date-query.php Since: 3.7.0 Overview WP_Date_Query is a helper class used...
WordPress Privacy Hooks
This document covers all actions and filters related to WordPress's privacy and GDPR compliance system. Actions user_request_action_confirmed Fires when a...
WordPress Privacy System Overview
WordPress includes a comprehensive privacy and GDPR compliance system introduced in version 4.9.6. This system enables sites to handle personal...
WP_User_Request Class
The WP_User_Request class represents a user data privacy request loaded from a WP_Post object. It provides a structured interface for...
WordPress Privacy Functions
This document covers the core privacy-related functions in WordPress for handling personal data requests, exports, erasures, and anonymization. Request Management...
WordPress Posts Overview
Core documentation for WordPress post/content management system. Source Files /wp-includes/post.php - Core post API (CRUD, meta, statuses) /wp-includes/post-template.php - Template...
WordPress Post Functions Reference
Complete reference of all WordPress post/content functions. CRUD Functions get_post() Retrieves post data given a post ID or post object....
WordPress Post Hooks Reference
Complete reference of hooks related to posts, content, revisions, and featured images. Post CRUD Hooks Insertion Hooks (Create) pre_post_insert Fires...
Post Types API Hooks
Actions and filters for post type registration and management. Source: wp-includes/post.php, wp-includes/class-wp-post-type.php Actions registered_post_type Fires after a post type is...
Post Types API
Framework for registering and managing WordPress post types. Since: 2.9.0 Source: wp-includes/post.php, wp-includes/class-wp-post-type.php Components Component Description functions.md Core registration and...
Post Types API Functions
Core functions for post type registration and management. Source: wp-includes/post.php register_post_type() Registers a new post type. Must be called during...
WP_Post_Type Class
Core class for interacting with post types. Since: 4.6.0 Source: wp-includes/class-wp-post-type.php final class WP_Post_Type { // ... } Properties $name...
Translation_Entry
Encapsulates a single translatable string with its translations, metadata, and context. Source: wp-includes/pomo/entry.php Since: 2.8.0 Properties Property Type Default Description...
Translations
Base class for a set of translation entries and their associated headers. Provides the core translation lookup interface. Source: wp-includes/pomo/translations.php...
POMO — PO/MO Translation File Handling
WordPress gettext-based internationalization subsystem for reading, writing, and managing PO and MO translation files. Since: 2.8.0 Source: wp-includes/pomo/ Components Component...
Stream Readers
Classes for reading streams of data, used by the MO file parser. Handles byte-level I/O with endian-aware integer reading and...
NOOP_Translations
Provides the same interface as Translations but performs no actual translation. All lookups return the original string. Used as a...
Plural_Forms
A gettext Plural-Forms expression parser and evaluator. Converts C-like plural expressions (e.g., n != 1, n%10==1 && n%100!=11 ? 0...
WordPress Pluggable Functions
Pluggable functions are core WordPress functions that can be completely overridden by plugins. They are defined conditionally in wp-includes/pluggable.php using...
WordPress Plugin API Overview
The Plugin API is WordPress's system for extending core functionality through modular code packages. It encompasses plugin loading, activation lifecycle,...
WordPress Plugin Functions
Core functions for plugin management, URLs, lifecycle hooks, and utilities. Plugin Path & URL Functions plugin_basename( $file ) Extracts the...
WordPress Plugin-Specific Hooks
This document covers hooks specifically related to plugin lifecycle, management, and pluggable function customization. For the general action/filter system, see...
Options API
Framework for storing and retrieving site-wide configuration data in WordPress. Since: 1.0.0 Source: wp-includes/option.php Components Component Description functions.md Core option...
Options API Functions
Core functions for option and transient management. Source: wp-includes/option.php Core Option Functions get_option() Retrieves an option value based on option...
Options API Hooks
Actions and filters for the Options API. Option Filters pre_option_{$option} Short-circuits option retrieval. Return non-false to bypass database lookup. apply_filters(...
Plugin Dependencies API
Framework for declaring and resolving plugin dependencies in WordPress. Since: 6.5.0 Source: wp-includes/class-wp-plugin-dependencies.php Components Component Description class-wp-plugin-dependencies.md Static class for...
WP_Plugin_Dependencies
Static class for resolving plugin dependencies declared via the Requires Plugins header. Source: wp-includes/class-wp-plugin-dependencies.php Since: 6.5.0 Overview All methods are...
Plugin Dependencies Hooks
Filters for the Plugin Dependencies API. Filters wp_plugin_dependencies_slug Filters a dependency slug before validation against WordPress.org slug format. apply_filters( 'wp_plugin_dependencies_slug',...
WordPress Navigation Menus API Overview
The Navigation Menus API, introduced in WordPress 3.0, provides a comprehensive system for creating, managing, and displaying navigation menus. It...
Navigation Menu Hooks
Comprehensive reference for all action and filter hooks in the WordPress Navigation Menus API. Display Filters wp_nav_menu_args Filters arguments passed...
Walker_Nav_Menu Class
The Walker_Nav_Menu class is responsible for rendering navigation menu HTML. It extends the base Walker class and traverses menu items...
Navigation Menu Functions
Complete reference for WordPress navigation menu functions. Display Functions wp_nav_menu() Displays a navigation menu. wp_nav_menu( array $args = array() ):...
Multisite Settings
WordPress Multisite settings are managed at two levels: network-wide (Super Admin) and per-site (Site Admin). Understanding which settings live where...
WordPress Multisite Architecture
WordPress Multisite enables running multiple sites from a single WordPress installation. This document covers the core architecture, terminology, and fundamental...
Network Admin (Multisite)
The Network Admin dashboard is the Super Admin control center for managing all sites, users, themes, and plugins across a...
WordPress Multisite Hooks Reference
Complete reference for all WordPress Multisite actions and filters. Site Lifecycle Hooks wp_insert_site Fires once a site has been inserted...
WordPress Multisite Functions Reference
Complete reference for all WordPress Multisite API functions. Site Retrieval Functions get_site() Retrieves site data given a site ID or...
Metadata API
Framework for storing and retrieving key-value metadata for WordPress objects. Since: 2.9.0 Source: wp-includes/meta.php, wp-includes/class-wp-metadata-lazyloader.php Components Component Description functions.md Core...
Metadata API Hooks
Actions and filters for the Metadata API. All hooks use dynamic names where {$meta_type} is replaced with the object type...
WP_Metadata_Lazyloader
Lazy-loads object metadata for improved performance. Since: 4.5.0 Source: wp-includes/class-wp-metadata-lazyloader.php Description When loading many objects of a given type (e.g.,...
Metadata API Functions
Core functions for metadata CRUD operations and registration. Source: wp-includes/meta.php CRUD Functions add_metadata() Adds metadata for the specified object. add_metadata(...
WordPress Media API
Comprehensive system for managing media files including image manipulation, upload handling, and attachment management. Source: wp-includes/media.php, wp-includes/class-wp-image-editor.php, wp-includes/media-template.php Components Component...
Media API Hooks
Actions and filters for media processing, image manipulation, and attachment handling. Source: wp-includes/media.php, wp-includes/class-wp-image-editor.php Image Size Filters editor_max_image_size Filters maximum...
WP_Image_Editor Classes
Abstract base class and implementations for image manipulation in WordPress. Source: wp-includes/class-wp-image-editor.php, wp-includes/class-wp-image-editor-gd.php, wp-includes/class-wp-image-editor-imagick.php Class Hierarchy WP_Image_Editor (abstract) ├── WP_Image_Editor_GD...
Media API Functions
Core functions for attachment retrieval, image sizing, and media output. Source: wp-includes/media.php Attachment Retrieval wp_get_attachment_image() Returns an HTML <img> element...
WordPress Links & URL API Overview
WordPress provides a comprehensive URL generation system that handles permalinks, site URLs, admin URLs, and canonical URL management. The system...
WordPress Links & URL Hooks Reference
Site URL Filters home_url Filters the home URL. add_filter( 'home_url', function( $url, $path, $orig_scheme, $blog_id ) { return $url; },...
WordPress Links & URL Functions Reference
Site URL Functions home_url( $path = '', $scheme = null ) Returns the URL for the site's front-end. home_url(); //...
WordPress Localization Hooks Reference
Filters and actions for customizing translation behavior. Translation Filters gettext Filters translated text after translation lookup. apply_filters( 'gettext', string $translation,...
WordPress Localization (i18n/l10n) API Overview
WordPress internationalization (i18n) and localization (l10n) system for translating text strings. Core Concepts Internationalization (i18n) The process of developing software...
WordPress Translation Functions Reference
Complete reference for WordPress internationalization functions. Basic Translation Functions __( $text, $domain = 'default' ) Retrieves the translation of a...
WP_Locale Class Reference
Stores translated locale-specific data including weekdays, months, date formats, and text direction. File: wp-includes/class-wp-locale.php Since: WordPress 2.1.0 Global: Available as...
@wordpress/hooks
Hook system for filters and actions in JavaScript. Filters addFilter( hookName, namespace, callback, priority? ) Registers a filter. hookName string...
@wordpress/i18n
Internationalization utilities for translating strings. Key APIs __( text, domain? ) Translate a string. _x( text, context, domain? ) Translate...
JavaScript Packages
Core @wordpress/* JavaScript packages bundled with WordPress. Source: wp-includes/js/dist/ Packages Package Description blocks.md Block registration and serialization block-editor.md Block editor...
@wordpress/scripts
Build tooling for WordPress block development. CLI Commands Run via wp-scripts (installed by @wordpress/scripts). wp-scripts start — dev build with...
@wordpress/url
URL utilities for query strings and path handling. Key APIs addQueryArgs( url, args ) Adds/updates query arguments and returns a...
@wordpress/blocks
Block registration and serialization utilities. Key APIs registerBlockType( name, settings ) Registers a block type. name string (namespace/block) settings object...
WP_Token_Map
High-performance data structure for string key-to-value lookups with optimized memory layout. Source: wp-includes/class-wp-token-map.php Since: 6.6.0 Overview WP_Token_Map provides efficient string...
WP_URL_Pattern_Prefixer
Prefixes URL patterns with base paths for WordPress installations. Source: wp-includes/class-wp-url-pattern-prefixer.php Since: 6.8.0 Access: private Overview This class handles URL...
Internals
Internal WordPress classes not intended for direct plugin use. Source: wp-includes/class-wp-*.php Components Component Description class-wp-meta-query.md Meta query SQL generation class-wp-tax-query.md...
WP_Tax_Query
SQL generator for taxonomy term queries. Source: wp-includes/class-wp-tax-query.php Since: 3.1.0 Overview WP_Tax_Query generates SQL JOIN and WHERE clauses for filtering...
WP_Textdomain_Registry
Registry for managing translation file locations. Source: wp-includes/class-wp-textdomain-registry.php Since: 6.1.0 Overview The WP_Textdomain_Registry class manages the mapping between text domains...
WP_MatchesMapRegex
Helper class for replacing $matches[] references in query strings without using eval(). Source: wp-includes/class-wp-matchesmapregex.php Since: 2.9.0 Overview This class provides...
Interactivity API Functions
Global wrapper functions for the Interactivity API. Source: wp-includes/interactivity-api/interactivity-api.php wp_interactivity() Retrieves the main WP_Interactivity_API instance. function wp_interactivity(): WP_Interactivity_API Since: 6.5.0...
Interactivity API Hooks
Filters for customizing Interactivity API behavior. Source: wp-includes/interactivity-api/class-wp-interactivity-api.php Filters script_module_data_@wordpress/interactivity Filters the data passed to the @wordpress/interactivity script module. apply_filters(...
Interactivity API
Server-side processing of interactive directives for WordPress blocks. Since: 6.5.0 Source: wp-includes/interactivity-api/ Components Component Description functions.md Global wrapper functions class-wp-interactivity-api.md...
Interactivity API Directives
All data-wp-* directive attributes processed by the Interactivity API. Source: wp-includes/interactivity-api/class-wp-interactivity-api.php Since: 6.5.0 Directive Syntax data-wp-{directive}[--{suffix}][---{unique-id}]="[namespace::]{value}" directive: The directive name...
WP_Interactivity_API
Main class for server-side Interactivity API processing. Source: wp-includes/interactivity-api/class-wp-interactivity-api.php Since: 6.5.0 final class WP_Interactivity_API Properties $directive_processors private static array $directive_processors...
WordPress HTTP API Overview
The WordPress HTTP API provides a standardized interface for making HTTP requests. It abstracts away the complexity of different PHP...
WP_Http Class
Core class used for managing HTTP transports and making HTTP requests. File: wp-includes/class-wp-http.php Since: 2.7.0 Overview WP_Http is the primary...
WordPress HTTP API Functions
Request Functions wp_remote_request() Performs an HTTP request and returns its response. wp_remote_request( string $url, array $args = array() ): array|WP_Error...
WordPress HTTP API Hooks
This document covers all filters and actions available in the WordPress HTTP API. Request Filters http_request_timeout Filters the timeout value...
WP_HTTP_Response Class
Core class used to prepare HTTP responses. File: wp-includes/class-wp-http-response.php Since: 4.4.0 Overview WP_HTTP_Response is a simple container class for HTTP...
WP_Http_Streams Class
Core class used to integrate PHP Streams as an HTTP transport. File: wp-includes/class-wp-http-streams.php Since: 2.7.0 Since: 3.7.0 - Combined with...
HTTPS Detection & Migration
Framework for detecting HTTPS support and migrating sites from HTTP to HTTPS. Since: 5.7.0 Source: wp-includes/https-detection.php, wp-includes/https-migration.php Components Component Description...
HTTPS Functions
Detection and migration functions for WordPress HTTPS support. Source: wp-includes/https-detection.php, wp-includes/https-migration.php Detection Functions wp_is_using_https() Checks whether the website is using...
HTTPS Hooks
Filters for customizing HTTPS detection and migration behavior. Filters pre_wp_get_https_detection_errors Short-circuits the HTTPS detection process. apply_filters( 'pre_wp_get_https_detection_errors', null|WP_Error $pre )...