DOCSEARCHbyAlgolia
Submit Docs

WP Engine Headless Platform Documentation

website·Indexed 18 days ago

https://developers.wpengine.com/docs

Technical documentation for the WP Engine Headless Platform, including the wpe CLI reference for managing applications, environments, builds, and logs. Covers platform guides for Smart Cache optimization, custom Node.js/npm/Yarn build configurations, and framework-specific deployment guides for Nuxt.js and Remix.

Tokens
158.1K
Snippets
677
Records
1.1K
Agent score
99%

What's inside WP Engine Headless Platform

  1. Overview of MediaPress Workflow functionality

    MediaPress Workflow enables the creation of draft 'versions' of published content. These versions can be worked on independently and will override the original post's data when published. This supports creating multiple isolated drafts or scheduling a sequence of updates. By default, the system copies and merges the post title, excerpt, content, and post meta (specifically meta registered with revisions_enabled set to true).

  2. Overview of WP Engine AI Toolkit capabilities

    The WP Engine AI Toolkit provides several core capabilities for WordPress and headless sites:

    • Smart Search & AI-Powered Hybrid Search: A replacement for native WordPress search offering Full-Text, Semantic (NLP-driven), and Hybrid modes. It automatically indexes Posts, Pages, Custom Post Types, ACF fields, and WooCommerce products.
    • Managed Vector Database: Automatically manages vector storage and real-time updates as content is published/edited, enabling millisecond nearest-neighbor lookups for semantic similarity.
    • Headless Integration: Exposes Smart Search querying, vector indexing, and hybrid ranking via GraphQL for front-end applications.
    • Recommendations: AI-driven discovery for surfacing related or trending content.

  3. Overview of wpe builds CLI command group

    The wpe builds command group is used to retrieve information regarding application builds within the WP Engine Headless Platform. It provides two primary operations: retrieving detailed information for a specific build and listing all builds associated with a specific app environment.

  4. Overview of MediaPress Ads for WordPress

    MediaPress Ads provides an interface for managing display ads in WordPress, specifically geared towards Google Publisher Tag (GPT). The plugin handles GPT configuration following best practices for performance and viewability. Ads are pre-fetched and lazy-loaded, appearing automatically when they enter the viewport.

  5. Overview of WP Engine Headless Platform CLI (WPE) commands

    The wpe command line client is used to manage WP Engine's Headless Platform. The top-level commands provide the following functionality:

    • wpe apps: Manage headless applications.
    • wpe auth: Handle authentication with the Headless CLI.
    • wpe builds: Retrieve build results for headless applications.
    • wpe context: Configure the active account or application context.
    • wpe envs: Manage environments for headless applications.
    • wpe logs: Access logs for headless applications.
    • wpe completion: Load shell completion scripts for the CLI.

  6. Overview of Local for WordPress development

    Local is a specialized development tool designed to simplify the management of local WordPress environments. It replaces manual stack configurations with a streamlined interface, allowing developers to build, test, and debug sites on their own machines without managing complex DevOps setups.

  7. Overview of Headless Platform preview environments

    Preview environments allow developers to dynamically create temporary environments to test changes when opening a pull request (PR), eliminating the need for manual configuration in the User Portal.

    When enabled, any PR opened against the 'source branch' (the branch linked to the Headless Platform environment) automatically triggers the creation of a preview environment based on the PR's branch code. The environment is automatically shut down once the PR is closed or merged. This feature is supported for GitHub, GitLab, and Bitbucket.

  8. Overview of the WP Engine AI Toolkit

    The WP Engine AI Toolkit is a developer-centric suite of tools that transforms WordPress into an intelligent content engine. It provides managed infrastructure for semantic processing and vectorization, enabling the implementation of AI features like natural language search and conversational assistants without requiring the developer to manage external vector databases or custom data pipelines.

  9. Overview of NitroPack Automated Performance Optimization

    NitroPack is an all-in-one automated performance engine designed to replace fragmented optimization plugins. It provides a 'zero-touch' infrastructure that automates over 60 front-end enhancements to improve Core Web Vitals and Lighthouse scores. Key capabilities include:

    • Code Optimization: Automatic removal of unused CSS, HTML normalization, and resource loading prioritization.
    • Media Handling: Integrated image optimization stack with adaptive sizing.
    • Script Management: Prioritization of critical human interactions and management of heavy scripts (e.g., Google Tag Manager) to reduce lag.

  10. Overview of the WP Engine Headless Platform

    The WP Engine Headless Platform provides a decoupled architecture that separates content management (WordPress) from the frontend presentation layer. It combines a dedicated Node.js environment with WordPress hosting, allowing developers to use WordPress as a headless CMS while building with modern JavaScript frameworks to create composable digital experiences.

  11. Overview of MediaPress Fields

    MediaPress Fields integrates custom field management directly into the WordPress block editor. It allows developers to register post meta and custom taxonomies via a JSON configuration file. These fields are accessible in the block editor by navigating to the Options menu (top right) and selecting 'MediaPress Fields'.

    Supported Field Types

    • Attributes/Meta: text, textarea, toggle, select, multi_select, checkbox, tag, image, number, radio.
    • Taxonomies: checkbox, select, multi_select, tag, radio.

  12. Overview of WP Engine Newsroom capabilities

    WP Engine Newsroom is an all-in-one platform for media teams to create, manage, publish, and analyze content within a single system. It centralizes the digital publishing workflow by integrating the following into the WordPress editor:

    • Asset Integration: Integrated Digital Asset Management (DAM) via Bynder or Cloudinary.
    • Enterprise Infrastructure: WordPress hosting with 99.99% uptime.
    • Content Discovery: Smart Search AI for recommendations and discoverability.
    • Editorial Operations: Direct integration of tools like MediaPress and Advanced Custom Fields (ACF).