Fields Reference
Every dynamic field Oxygen ships with, grouped as the field chooser groups them.
This is a lookup, not a tutorial. For how binding works — opening the chooser, what
happens per post, the Prepend / Append / Limit Characters / Fallback options every field
shares — see Dynamic Data.
Reading the tables
The Options column lists the controls that appear once you pick that field. It does
not repeat the four Advanced options, which every field has.
Fields resolve against whatever the current item is. In a
Post Loop that's the post being rendered; in a
Term Loop the Term fields resolve against the current term; on
a single-post template it's the post being viewed. A field with nothing to resolve
against returns empty.
Note: the chooser also filters by what the control can accept. A field expecting an
image URL won't offer you Post Content. If a field you expect is missing, check whether
the control you're binding takes that kind of value.
Post
The current post's own data.
| Field | Returns | Options |
|---|---|---|
| Post Title | text, URL | Search Post, Post ID |
| Post Content | text | |
| Post Excerpt | text | |
| Post Permalink | text, URL | Search Post, Post ID |
| Post Date | text | Format, Custom Format, Type |
| Post Time | text | Type, Format, Custom Format |
| Post Terms | text | Taxonomy, Link, Separator |
| Post Comments Number | text | No comments, One comment, Multiple comments |
| Post Featured Image | image | |
| Post Featured Image (URL) | URL | |
| Post Image Attachment | image | Image Index |
| Post Image Attachments | gallery | |
| Post Custom Field | text, URL, map | Key |
| Post Custom Field (Image URL) | image | Key |
| Post Custom Field (Oembed URL) | video | Key |
Post Title and Post Permalink take an optional Search Post or Post ID — leave
them empty for the current post, or fill them in to point at a specific one.
Post Comments Number takes three separate strings so the output reads properly at
each count: what to print for none, for one, and for many.
Featured Image
The current post's featured image — its own metadata, not the image itself. For the image
use Post Featured Image above.
| Field | Returns | Options |
|---|---|---|
| Featured Title | text | |
| Featured Alt | text | |
| Featured Caption | text | |
| Custom Field | text, URL, map | Key |
| Custom Field (Image URL) | image | Key |
| Custom Field (Oembed URL) | video | Key |
The Custom Field entries here read fields attached to the attachment, which is where
photo credits and licence information usually live.
Author
The author of the current post.
| Field | Returns | Options |
|---|---|---|
| Author Name | text | Field |
| Author Bio | text | |
| Author Email | text | |
| Author Website | text, URL | |
| Author Avatar | image | |
| Author Avatar (URL) | URL | |
| Custom Field | text, URL, map | Key |
| Custom Field (Image URL) | image | Key |
| Custom Field (Oembed URL) | video | Key |
Author Name's Field option chooses which name to print — display name, first name,
last name, nickname and so on.
Term
The current term. These resolve inside a Term Loop and on
taxonomy archive templates.
| Field | Returns | Options |
|---|---|---|
| Term Name | text | |
| Term Description | text | |
| Term Permalink | text, URL | |
| Term Count | text | |
| Term ID | text | |
| Term Custom Field | text, URL, map | Key |
Archive
For archive templates.
| Field | Returns | Options |
|---|---|---|
| Archive Title | text | Disable Prefix |
| Archive Description | text |
Disable Prefix strips WordPress's automatic "Category:" / "Tag:" / "Author:" prefix,
leaving just the name.
Current User
The person viewing the page — not the post's author. Empty for logged-out visitors.
| Field | Returns | Options |
|---|---|---|
| User Name | text | Field |
| User Bio | text | |
| User Email | text | |
| User Website | text | |
| User Avatar | image | |
| User Avatar (URL) | URL | |
| Custom Field | text, URL, map | Key |
| Custom Field (Image URL) | image | Key |
| Custom Field (Oembed URL) | video | Key |
Site Info
Site-wide values from WordPress settings.
| Field | Returns | Options |
|---|---|---|
| Site Title | text | |
| Site Tagline | text | |
| Site URL | URL, text | |
| Home URL | URL, text | |
| Admin Email | text | |
| Site Logo | image | |
| Site Logo (URL) | URL | |
| RSS URL | text | Type |
| Logout URL | text, URL | Redirect URL |
Site Logo is the logo set in the WordPress Customizer, the same one your theme would
use. Logout URL's Redirect URL sets where the visitor lands after logging out.
URL & Query
Values from the current request. Useful for search templates and for landing pages that
react to their own URL.
| Field | Returns | Options |
|---|---|---|
| Search Query | query, text | |
| URL Parameter | query, text | Parameter Name |
| Common UTM Tags | query, text | UTM Tag |
Common UTM Tags is a convenience wrapper over URL Parameter, with the standard
utm_source / utm_medium / utm_campaign names in a dropdown instead of typed by hand.
Caution: these print whatever is in the URL. Don't put a raw URL parameter somewhere
it could be mistaken for your own content without considering what a visitor could put
there.
Utility
Escape hatches, for when no field fits.
| Field | Returns | Options |
|---|---|---|
| Current Date | text | Format, Custom Format |
| Shortcode | text | Shortcode |
| PHP | image, text | Code |
Shortcode runs any registered shortcode and prints its output, which is how most
plugin-provided values reach an Oxygen element.
PHP evaluates code you write and prints what it returns. It carries the same caveats
as a Custom PHP condition: not sandboxed, and an
error surfaces on the page.
Component
| Field | Returns | Options |
|---|---|---|
| Component Field | text, URL, image | Key |
Component Field reads a property of the Component the
element sits inside — the mechanism that lets one Component render differently per
instance. Outside a Component it has nothing to read.
Fields from field plugins
Custom field plugins add their own entries alongside these, grouped by the field group
they belong to rather than appearing in the lists above. Oxygen ships integrations for
ACF, Meta Box and Toolset, each mapping the plugin's field types onto the
right kind of Oxygen field — an ACF image field becomes an image field, a link field
becomes a URL field, and so on.
The generic Custom Field entries above read post meta directly by key, which works for
any plugin, but returns the raw stored value. The plugin-specific fields return the
resolved value — an image URL rather than an attachment ID — so prefer them when the
integration provides one.