Getting Started

Prerequisites

• Node.js version 18 or higher.
• An accessible Wordpress instance, with API enabled.
• Optional Wordpress Application credentials to use advanced features :
  • Menus
  • Contact form

Installation

Setup

npm

$ npm add -D nuxt-wp

pnpm

$ pnpm add -D nuxt-wp

yarn

$ yarn add -D nuxt-wp

bun

$ bun add -D nuxt-wp

nuxt-config.ts

export default defineNuxtConfig({
  modules: ['nuxt-wp'],
})

Config

In order to work, you need to provide the API endpoint :

.env

WP_API_ENDPOINT=https://your-wordpress-site.com/wp-json

nuxt-config.ts

export default defineNuxtConfig({
  wordpress:{
    apiEndpoint: 'https://your-wordpress-site.com/wp-json',
  },
})

If you want to use advances features, you need to provide Application Credentials too :

.env

WP_API_ENDPOINT=https://your-wordpress-site.com/wp-json
WP_APPLICATION_USER=your-username
WP_APPLICATION_PASSWORD=your-password

nuxt-config.ts

export default defineNuxtConfig({
  wordpress:{
    apiEndpoint: 'https://your-wordpress-site.com/wp-json',
    applicationUser: 'your-username',
    applicationPassword: 'your-password'
  },
})