API Reference
  • Introduction
  • ๐Ÿ’ปCLI Commands
    • Create commands
      • create
      • create-package
    • Run commands
      • dev
      • serve
    • Build commands
      • build
    • Extra commands
  • ๐ŸฑPackages
    • ๐Ÿ’™Core package
      • frontity
    • โšกFeatures packages
      • @frontity/wp-source
      • @frontity/tiny-router
      • @frontity/html2react
      • @frontity/head-tags
      • @frontity/yoast
      • @frontity/google-ad-manager
      • @frontity/smart-adserver
      • analytics packages
        • @frontity/google-analytics
        • @frontity/google-tag-manager-analytics
        • @frontity/comscore-analytics
      • @frontity/wp-comments
    • ๐Ÿ“šCollections packages
      • @frontity/components
      • @frontity/hooks
        • Infinite Scroll Hooks
        • Intersection Observer Hooks
    • ๐ŸŽจThemes Packages
      • @frontity/twentytwenty-theme
      • @frontity/mars-theme
  • ๐Ÿ”ŒWordPress Plugins
    • REST API - Head Tags
    • Frontity Embedded Mode
Powered by GitBook
On this page
  • Table of Contents
  • The Embedded Mode
  • Features of the Embedded Mode
  • Installation
  • Settings
  • Set the URL of the Frontity server
  • Set the static assets public path

Was this helpful?

  1. WordPress Plugins

Frontity Embedded Mode

PreviousREST API - Head Tags

Last updated 3 years ago

Was this helpful?

This plugin enables the implementation of Frontity in a WordPress installation. You can download it from .

Take a look at the to see the code for this plugin.

This Frontity Embedded Mode plugin replaces the active WordPress theme with the Frontity installation. Frontity therefore effectively becomes the WordPress sites' theme. It works by substituting it's own in place of any call made to the .

Table of Contents

The Embedded Mode

In Frontity there are two main modes of implementation: Decoupled Mode and Embedded Mode

Features of the Embedded Mode

Embedded Mode offers several advantages over Decoupled Mode.

  • The WordPress site exists under the primary domain, thus ensuring that:

    • all the SEO benefits already built in to WordPress work as normal

    • existing SEO (for a site transitioning to Frontity) will not be affected

    • sitemaps generated by WordPress/Yoast/All-in-one-SEO work as normal

    • WordPress page cache plugins and hosting CDNs continue to work as normal

  • Content producers/editors continue to have the same experience

    • post/page preview remains available

    • the admin bar is active for logged in users

But there are some things to be taken into account when using this Embedded Mode:

  • Frontity still needs to be hosted on a separate node server/serverless function (albeit on any domain you like including default domains provided by the hosting provider)

  • more routing is involved (WordPress makes a call to Frontity which returns the HTML to WordPress) so a caching plugin is a necessity rather than simply a nice to have.

Installation

Installation is a three step process: Download โ†’ Install โ†’ Activate.

  1. Activate the plugin by locating it in the Plugins list and clicking on 'Activate'.

Settings

In order to use Frontity in embedded mode with this Frontity Embedded Mode plugin you need to:

Set the URL of the Frontity server

This can be configured in a variety of ways:

Editing the pluginโ€™s settings page

Once the plugin has been activated a new 'Frontity Embedded Mode' option appears under 'Settings'.

Select this and enter the URL of the Frontity server in the input field. (During development this can be http://localhost:3000. In production this will be the deployed location of your Frontity site)

Adding an environment variable

It is also possible to use an environment variable instead of changing the URL in the settings.

> FRONTITY_SERVER=https://myfrontityserver.com

Note that the environment variable, if it exists, takes precedence over the setting configured in the settings page.

Adding a WordPress constant

Lastly a PHP constant can be defined. This would usually be done in the wp-config.php file.

define( 'FRONTITY_SERVER', 'https://myfrontityserver.com' );

Note that if the PHP constant exists, it takes precedence over both the environment variable and the settings page setting.

Set the static assets public path

By default Frontity will look for static assets (such as images, fonts, .js or .css files, etc...) in the path https://<YOUR-DOMAIN>/static.

However, since in Embedded mode the primary domain is pointing to the WordPress installation, Frontity will not find the static assets at this location.

The URL (or path) of the static assets will differ depending on the scenario in which you're using this Embedded Mode plugin.

Frontity in the same WordPress server

If you are using the same server for both WordPress and Frontity, and your Frontity project is at /wp-content/frontity, say, then your static folder will be at https://yourdomain.com/wp-content/frontity/build/static.

You can change the folder when you run npx frontity build thus:

> npx frontity build --public-path /wp-content/frontity/build/static

This ensures that Frontity will source it's assets from this location instead of from the default https://<YOUR-DOMAIN>/static.

Frontity in an external server

If you've deployed Frontity to an external hosting service, for example Vercel, then you can use the --public-path option to point directly to the Vercel URL:

> npx frontity build --public-path https://myfrontityapp.vercel.app/static

Local Development

If you want to use the Embedded mode while you are developing in your local environment, you can do so by using the --public-path parameter in the npx frontity dev command as well:

> npx frontity dev --public-path http://localhost:3000/static

In the the primary domain points to the Frontity site, with the WordPress site being on a secondary domain or on a subdomain of the primary domain.

In the the primary domain points to the WordPress site, and the Frontity site can be on another domain - including the default URL provided by a free hosting service such as .

In order to access post previews from the REST API revisions need to be activated. You can read more about revisions on the . And if you are using custom post types, remember to when you register them.

WordPress still needs to go through its on initial page load

Download the zip file from .

Install the plugin by

.

.

In addition it's not always possible to host the static assets with the Frontity deployment - for example, if Frontity is deployed to a .

Therefore, if required, it's possible to change the directory or URL where your static assets are stored at build time. To do this you can use the of the npx frontity build command.

Want to know more about this feature? The development of this plugin was discussed in .

๐Ÿ”Œ
Decoupled Mode
Embedded Mode
Vercel
official WordPress docs
add support for revisions
bootstrap process
here
uploading it to WordPress
serverless function
--public-path option
this forum thread
Embedded Mode
here
Frontity - Embedded Mode repository
template.php
WordPress template hierarchy
The Embedded Mode
Features of the Embedded Mode
Installation
Settings
Set the URL of the Frontity server
Editing the pluginโ€™s settings page
Adding an environment variable
Adding a WordPress constant
Set the static assets public path
Frontity in the same WordPress server
Frontity in an external server
Local Development
Set the URL of the Frontity server
Set the static assets public path of your Frontity deployment
Editing the pluginโ€™s settings page
Adding an environment variable
Adding a WordPress constant