@frontity/head-tags
API reference of `@frontity/head-tags` package
Last updated
Was this helpful?
API reference of `@frontity/head-tags` package
Last updated
Was this helpful?
This package is designed to get automatically all the metadata that the exposes in the REST API (SEO metadata from plugins like Yoast SEO or All in One SEO), and add them as meta tags in the <head> section of the rendered page.
This package won't work without installed and activated in your WordPress backend, so make sure you have it before using this package.
Add the head-tags package to your project:
Do this in your root and include it in your frontity.settings.js file:
As it works automatically, It doesn't have settings itself, but it requires two Frontity parameters to work:
state.frontity.url : The URL of your site. Usually defined in the frontity.settings.js file.
It needs @frontity/wp-source installed and updated to at least the 1.5.0 version.
This package will automatically add all the meta tags defined in WordPress for the page (through plugins like Yoast SEO or All in One SEO) in the <head> section of the rendered page. So there are no additional steps to do. Just install the package and everything will work out of the box.
headTags.getIt is a function that accepts a linkas parameter and it returns an array with the head_tags field of that link.
will return something like
If you have an existing project make sure your package is at least on the 1.5.0 version. If not, update it using this command: > npm install @frontity/wp-source@latest.
state.source.url or state.source.api: The API where your project is pointing. Defined at if you haven't changed your Source.
Remember that you'll need the installed in your WordPress. With that, this package will take care of the rest.
If you want to access the metadata available for a specific link you can use the method.