23. Options Pages API | Field Forge - Custom Fields, Built for Speed
Download Log in

23. Options Pages API

Developer Guide

Read options page values via REST.

GET /fieldforge/v1/options/{page}

Get all values for an options page by its slug.

bash
curl -s -u "$AUTH" 
  "https://example.com/wp-json/fieldforge/v1/options/site-options"
Response:
json
{
  "site_logo": "55",
  "site_phone": "+1-555-0123",
  "footer_copyright": "2024 My Company",
  "social_facebook": "https://facebook.com/mycompany"
}

fieldforge Property on Post REST Endpoints (PRO)

When PRO is active, standard WordPress post REST endpoints include a fieldforge object:

bash
curl -s "https://example.com/wp-json/wp/v2/posts/42"
json
{
  "id": 42,
  "title": { "rendered": "My Post" },
  "fieldforge": {
    "subtitle": "A great post",
    "price": "29.99",
    "hero_image": {
      "ID": 55,
      "url": "https://example.com/wp-content/uploads/hero.jpg",
      "width": 1200,
      "height": 630
    }
  }
}

This works for all post types with show_in_rest => true, but the public post payload is deny-by-default. A field appears in this fieldforge object only when the field definition sets show_in_rest => true or a developer explicitly allows it through fieldforge/rest/public_field_allowed.

Password fields are never exposed. Fields whose names look sensitive (password, secret, token, credential, api_key, private_key) stay hidden unless fieldforge/rest/public_sensitive_field_allowed explicitly returns true. Compound fields (Group, Repeater, Flexible Content) are filtered recursively so a public parent cannot leak a private sub-field.

Forge AI Assistant Online

Hi! I'm the Field Forge AI assistant. Ask me anything about the plugin — setup, features, troubleshooting, or development.

Just now
Powered by Forge AI · Browse docs