API Reference
TutorialDocsCommunityWebsite
Search…
⌃K
Links

Frontity Embedded Mode

This plugin enables the Embedded Mode implementation of Frontity in a WordPress installation. You can download it from here.
Take a look at the Frontity - Embedded Mode repository 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 template.php in place of any call made to the WordPress template hierarchy.

Table of Contents

The Embedded Mode

In Frontity there are two main modes of implementation: Decoupled Mode and Embedded Mode
In the Decoupled Mode 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 Embedded Mode 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 Vercel.

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
In order to access post previews from the REST API revisions need to be activated. You can read more about revisions on the official WordPress docs. And if you are using custom post types, remember to add support for revisions when you register them.
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)
  • WordPress still needs to go through its bootstrap process on initial page load
  • 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. 1.
    Download the zip file from here.
  2. 2.
    Install the plugin by uploading it to WordPress​
  3. 3.
    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.
In addition it's not always possible to host the static assets with the Frontity deployment - for example, if Frontity is deployed to a serverless function.
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 --public-path option of the npx frontity build command.
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
Want to know more about this feature? The development of this plugin was discussed in this forum thread.
Previous
REST API - Head Tags
Last modified 1yr ago