Function reference

Last updated Oct 3, 20264 min read

All functions are global, defined in the free plugin, and safe to call at any time: before the plugin has booted they return the default, and failures are logged under WPM Fields › Settings › Health, never thrown. Common conventions are in the overview; object forms are in Object references.

Function	Purpose
`wpmcf_get_field()`	Raw value of a field
`wpmcf_the_field()`	Print a field, escaped
`wpmcf_has_field()`	Does the field have a value
`wpmcf_update_field()`	Save a value
`wpmcf_delete_field()`	Clear a value
`wpmcf_get_option_field()`	Raw options-page value
`wpmcf_the_option_field()`	Print an options-page value
`wpmcf_has_option_field()`	Options-page value present
`wpmcf_update_option_field()`	Save an options-page value
`wpmcf_delete_option_field()`	Clear an options-page value
`wpmcf_check_password()`	Verify a password field
`wpmcf_get_password()`	Read an encrypted/plain password field
`wpmcf_query_posts()`	`get_posts()` with field conditions
`wpmcf_get_global()`	Raw Global Data value
`wpmcf_the_global()`	Print a Global Data value
`wpmcf_has_global()`	Global Data value present
`wpmcf_update_global()`	Update a Global Data value
Internal helpers	`wpmcf_field_runtime_service()` and others: not public API
Other functions	Variables, PHP-registered groups, WooCommerce

Common arguments (`$args`)

Key	Functions	Meaning
`default`	get, has, the	Value used when the field has none (`NULL`)
`path`	all field functions	Dot path or array of segments into a Group/Repeater value
`sub_key`	all field functions	One-segment `path`
`context`	functions with `$object`	`post`, `user`, `term`, `comment`, `widget`, `options`; wins over a reference's implied context
`format`	the	`auto`, `html`, `attr`, `url`, `js`, `post_html`
`wrap`	the	`false` removes the wrapper span
`widget_sidebar`, `widget_id_base`, `widget_number`	functions with `$object`	Identify a widget for `context` `widget`

wpmcf_get_field

php

wpmcf_get_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): mixed

Raw, unescaped value. Returns $args['default'] (else null) when the value is NULL or the group, field or object is missing or invalid. Resolves {{ }} expressions when the writer is trusted.

php

$price = wpmcf_get_field( 'listing', 'price', $post_id, [ 'default' => 0 ] );
$city  = wpmcf_get_field( 'listing', 'details', $post_id, [ 'path' => 'city' ] );
$bio   = wpmcf_get_field( 'profile', 'bio', 'user_3' );

See Reading values.

wpmcf_the_field

php

wpmcf_the_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): void

Echoes the escaped, formatted value in <span class="wpmcf-field-value"> (turn off with 'wrap' => false). Prints nothing for empty values, Password fields and unformattable values. Invalid object: prints nothing.

php

wpmcf_the_field( 'listing', 'title' );
wpmcf_the_field( 'listing', 'description', null, [ 'format' => 'post_html', 'wrap' => false ] );

See Output formats and escaping.

wpmcf_has_field

php

wpmcf_has_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): bool

true unless the value is null, '' or [] (0, '0' and false count as values).

php

if ( wpmcf_has_field( 'listing', 'gallery' ) ) { /* ... */ }

wpmcf_update_field

php

wpmcf_update_field( string $group_key, string $field_key, mixed $value, mixed $object = null, array $args = [] ): bool

Validates and sanitizes $value with the field type, writes it, purges page caches (posts). null clears. false for an unknown group/field, a missing object or invalid reference, a refused value or a failed write. No capability check. $args: context, widget_*.

php

wpmcf_update_field( 'listing', 'price', 450000, $post_id );
wpmcf_update_field( 'profile', 'bio', 'Hello', 'user_3' );

See Writing values.

wpmcf_delete_field

php

wpmcf_delete_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): bool

Clears the value. true when cleared or nothing to clear; false for an unknown group/field or invalid reference. No capability check.

php

wpmcf_delete_field( 'listing', 'price', $post_id );

wpmcf_get_option_field

php

wpmcf_get_option_field( string $group_key, string $field_key, array $args = [] ): mixed

Raw value on an options page (context fixed to options). $args: path, sub_key, default.

php

$name = wpmcf_get_option_field( 'site_settings', 'company_name' );

wpmcf_the_option_field

php

wpmcf_the_option_field( string $group_key, string $field_key, array $args = [] ): void

Echoes the escaped options-page value. $args: format, wrap, path, sub_key, default.

php

wpmcf_the_option_field( 'site_settings', 'company_name', [ 'wrap' => false ] );

wpmcf_has_option_field

php

wpmcf_has_option_field( string $group_key, string $field_key, array $args = [] ): bool

True when the options-page value is not empty. $args: path, sub_key.

wpmcf_update_option_field

php

wpmcf_update_option_field( string $group_key, string $field_key, mixed $value ): bool

Writes the shared options row. Fires wpmcf/options_pages/values_saved once per options page that shows the group. No capability check. Does not verify that the group belongs to an options page.

php

wpmcf_update_option_field( 'site_settings', 'hours', 40 );

wpmcf_delete_option_field

php

wpmcf_delete_option_field( string $group_key, string $field_key ): bool

Clears the options-page value. No capability check.

wpmcf_check_password

php

wpmcf_check_password( string $group_key, string $field_key, string $password, mixed $object = null, array $args = [] ): bool

True when $password matches the stored value of a top-level Password field (hashed, encrypted or plain). false for an empty field or password, a non-Password field or an unknown object.

php

if ( wpmcf_check_password( 'download', 'code', $typed, $post_id ) ) { /* allow */ }

See Password helpers and security.

wpmcf_get_password

php

wpmcf_get_password( string $group_key, string $field_key, mixed $object = null, array $args = [] ): ?string

Readable value of an encrypted or plain Password field; null for a hashed one, an empty field or a failed read. Never print it.

php

$secret = wpmcf_get_password( 'integration', 'api_secret', 'option' );

wpmcf_query_posts

php

wpmcf_query_posts( array $args ): array

get_posts() with suppress_filters => false, so wpmcf_query, orderby wpmcf:group.field and wpmcf_distance work. Returns WP_Post[] (or IDs with 'fields' => 'ids'); an empty array when the query fails.

php

$posts = wpmcf_query_posts( [
    'post_type'   => 'listing',
    'numberposts' => 10,
    'wpmcf_query' => [ [ 'field' => 'listing.price', 'compare' => '<=', 'value' => 500 ] ],
    'orderby'     => [ 'wpmcf:listing.price' => 'ASC' ],
] );

See Querying posts.

wpmcf_get_global

php

wpmcf_get_global( string $key, array $args = [] ): mixed

Raw value of a Global Data variable (string). $args['default'] for a missing or empty variable. Resolves {{ }} expressions. Returns decrypted password variables.

php

$phone = wpmcf_get_global( 'phone', [ 'default' => '' ] );

wpmcf_the_global

php

wpmcf_the_global( string $key, array $args = [] ): void

Echoes the escaped value in <span class="wpmcf-global-value">. $args: format, wrap. Resolves {{ }} expressions; default is printed for a missing or empty variable. Prints nothing for password variables unless wpmcf/global/the_password allows it.

php

wpmcf_the_global( 'phone', [ 'wrap' => false ] );

wpmcf_has_global

php

wpmcf_has_global( string $key, array $args = [] ): bool

True when the variable exists and is not empty ('0' counts as a value).

wpmcf_update_global

php

wpmcf_update_global( string $key, mixed $value ): bool

Sets an existing variable; scalar or null only; HTML tags are stripped; fires wpmcf/global_data/saved. false for an unknown key or non-scalar value. No capability check.

php

wpmcf_update_global( 'phone', '+90 212 555 00 00' );

Internal helpers

These exist for the plugin and its integrations. They are not part of the stable API; use the functions above.

Function	Notes
`wpmcf_field_runtime_service(): ?FieldRuntimeService`	The service behind the read/print functions. `null` before the plugin has booted.
`wpmcf_field_writer(): ?FieldWriter`	The service behind the write functions. `null` before boot.
`wpmcf_global_data_runtime_service(): ?GlobalDataRuntimeService`	The service behind the Global Data functions.
`wpmcf_resolve_object( mixed $object, array $args, string $function ): ?array`	Turns an object reference into `[ id, args ]`; `null` (plus a `_doing_it_wrong()` under `WP_DEBUG`) when invalid.
`wpmcf_booted_service( string $class )`	Looks a service up in the container after boot.

Function	Where
`wpmcf_resolve_variables()`, `wpmcf_make_context()`, `wpmcf_variable_engine()`, `wpmcf_variable_registry()`	Variables and hooks
`wpmcf_register_field_group()`	Field groups (PHP-registered groups)
`wpmcf_get_order_field()` (Pro, WooCommerce orders)	Integrations

Where the arguments are documented

Topic	Page
Return values per type	Reading values
Object references	Object references
`format` and `wrap`	Output formats and escaping
Shortcode attributes	Shortcodes

Was this page helpful?

Still stuck? Contact support