Configuration

WP-Node provides a flexible configuration system to support both single-site and multi-site WordPress environments. It also allows customization of Taxonomy, Post Type, and Post Status via CLI.

---

Global Configuration

At a minimum, WP-Node requires a staticAssetsPath configuration. If using WordPress in multi-site mode, additional fields are needed.

🧩 Single-Site Configuration

{
  "staticAssetsPath": "public"
}

🧩 Multi-Site Configuration

{
  "staticAssetsPath": "public",
  "multisite": {
    "enabled": true,
    "defaultBlogId": 1,
    "defaultSiteId": 1
  }
}

Once initialized, WP-Node will enrich this configuration internally. You can inspect the full config via:

const context = await Application.getContext();
console.log(context.config.config);

⚠️ Note: WP-Node Core does not interact with or modify media files such as images or uploads on the file system. Its focus is on interacting with the WordPress database.

staticAssetsPath setting is still required because WordPress stores metadata (e.g., _wp_attached_file in postmeta) that references file paths. WP-Node uses this metadata to work with attachments, but it does not read, write, or serve the actual media files.

Taxonomy Configuration

WP-Node CLI can generate configuration files for custom taxonomies. These configurations support features such as hierarchy, and capability settings.

🛠️ Create a Custom Taxonomy (with Hierarchy Enabled)

npx @rnaga/wp-node-cli -- config taxonomy -h yes

✅ CLI Output Example

✔ Enter new taxonomy name (ASCII and underscore only): · custom_category
_wp/config/taxonomy.json created successfully.
_wp/config/taxonomy.d.ts created successfully.

📥 Using Custom Taxonomy in Code

You can retrieve terms from the newly defined taxonomy via:

const post = await context.utils.post.get(1);
const terms = post.terms("custom_category");

✏️ Updating the Taxonomy Configuration

Edit _wp/config/taxonomy.json to customize its behavior, e.g., toggle hierarchical, disable showUi, or set custom capabilities:

{
  "custom_category": {
    "hierarchical": false,
    "showUi": false,
    "capabilities": {
      "manage_terms": "manage_terms",
      "assign_terms": "assign_terms",
      "edit_terms": "edit_terms",
      "delete_terms": "delete_terms"
    }
  }
}

Post Type Configuration

To define a custom post type, use the CLI with the -n flag:

npx @rnaga/wp-node-cli -- config postType -n custom_post

This generates both the JSON and TypeScript type definition in _wp/config.

Post Status Configuration

Similarly, you can define a custom post status:

npx @rnaga/wp-node-cli -- config postStatus -n custom_type