Geliştirici API'si

Fonksiyon referansı

Son güncelleme 3 Eki 20264 dk okuma

Tüm fonksiyonlar global kapsamdadır, ücretsiz eklentide tanımlıdır ve her zaman güvenle çağrılabilir: eklenti başlatılmadan önce varsayılan değeri döndürürler, hatalar da fırlatılmaz, şuraya kaydedilir: WPM Fields › Settings › Health. Ortak kurallar genel bakışta, nesne biçimleri Nesne referansları sayfasında yer alır.

Fonksiyon	Amaç
`wpmcf_get_field()`	Bir alanın ham değeri
`wpmcf_the_field()`	Bir alanı kaçışlanmış olarak yazdırır
`wpmcf_has_field()`	Alanın değeri var mı
`wpmcf_update_field()`	Bir değer kaydeder
`wpmcf_delete_field()`	Bir değeri temizler
`wpmcf_get_option_field()`	Seçenek sayfası ham değeri
`wpmcf_the_option_field()`	Bir seçenek sayfası değerini yazdırır
`wpmcf_has_option_field()`	Seçenek sayfası değeri mevcut
`wpmcf_update_option_field()`	Bir seçenek sayfası değerini kaydeder
`wpmcf_delete_option_field()`	Bir seçenek sayfası değerini temizler
`wpmcf_check_password()`	Bir Password alanını doğrular
`wpmcf_get_password()`	Şifrelenmiş/düz metin Password alanını okur
`wpmcf_query_posts()`	`get_posts()` ve alan koşulları
`wpmcf_get_global()`	Ham Global Data değeri
`wpmcf_the_global()`	Bir Global Data değerini yazdırır
`wpmcf_has_global()`	Global Data değeri mevcut
`wpmcf_update_global()`	Bir Global Data değerini günceller
Dahili yardımcılar	`wpmcf_field_runtime_service()` ve diğerleri: genel API değildir
Diğer fonksiyonlar	Değişkenler, PHP ile kaydedilen gruplar, WooCommerce

Ortak argümanlar (`$args`)

Anahtar	Fonksiyonlar	Anlamı
`default`	get, has, the	Alanın değeri olmadığında kullanılan değer (`NULL`)
`path`	tüm alan fonksiyonları	Group/Repeater değerine giden noktalı yol veya segment dizisi
`sub_key`	tüm alan fonksiyonları	Tek segmentli `path`
`context`	Şu parametreyi alan fonksiyonlar: `$object`	`post`, `user`, `term`, `comment`, `widget`, `options`; bir referansın ima ettiği bağlama üstün gelir
`format`	the	`auto`, `html`, `attr`, `url`, `js`, `post_html`
`wrap`	the	`false` sarmalayıcı span'i kaldırır
`widget_sidebar`, `widget_id_base`, `widget_number`	Şu parametreyi alan fonksiyonlar: `$object`	Bir widget'ı şu bağlam için tanımlar: `context` `widget`

wpmcf_get_field

php

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

Ham, kaçışlanmamış değer. Döndürülen: $args['default'] (yoksa null); değer NULL olduğunda veya grup, alan ya da nesne eksik veya geçersiz olduğunda. Yazan güvenilirse {{ }} ifadeleri çözümlenir.

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' );

Bkz. Değerleri okuma.

wpmcf_the_field

php

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

Kaçışlanmış, biçimlendirilmiş değeri şu öğenin içinde yazdırır: <span class="wpmcf-field-value"> (kapatmak için 'wrap' => false). Boş değerler, Password alanları ve biçimlendirilemeyen değerler için hiçbir şey yazdırmaz. Geçersiz nesne: hiçbir şey yazdırmaz.

php

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

Bkz. Çıktı biçimleri ve kaçışlama.

wpmcf_has_field

php

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

true döner; değer null, '' veya [] değilse (0, '0' ve false değer sayılır).

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

Alan türüne göre $value değerini doğrular ve temizler, yazar, sayfa önbelleklerini temizler (yazılar). null değeri temizler. false döner: bilinmeyen grup/alan, eksik nesne veya geçersiz referans, reddedilen değer ya da başarısız yazma durumunda. Yetki kontrolü yapılmaz. $args: context, widget_*.

php

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

Bkz. Değerleri yazma.

wpmcf_delete_field

php

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

Değeri temizler. true döner: temizlendiyse veya temizlenecek bir şey yoksa; false döner: bilinmeyen grup/alan veya geçersiz referans durumunda. Yetki kontrolü yapılmaz.

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

Bir seçenek sayfasındaki ham değer (bağlam options olarak sabittir). $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

Seçenek sayfası değerini kaçışlanmış olarak yazdırır. $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

Seçenek sayfası değeri boş değilse true döner. $args: path, sub_key.

wpmcf_update_option_field

php

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

Paylaşılan seçenekler satırına yazar. Grubu gösteren her seçenek sayfası için birer kez wpmcf/options_pages/values_saved tetiklenir. Yetki kontrolü yapılmaz. Grubun bir seçenek sayfasına ait olduğunu doğrulamaz.

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

Seçenek sayfası değerini temizler. Yetki kontrolü yapılmaz.

wpmcf_check_password

php

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

Üst düzey bir Password alanının saklanan değeriyle (hash'lenmiş, şifrelenmiş veya düz) $password eşleştiğinde true döner. false döner: alan veya parola boşsa, alan Password değilse ya da nesne bilinmiyorsa.

php

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

Bkz. Parola yardımcıları ve güvenlik.

wpmcf_get_password

php

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

Bir şifrelenmiş veya düz metin Password alanının okunabilir değeri; hash'lenmiş alan, boş alan ya da başarısız okuma için null döner. Asla yazdırmayın.

php

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

wpmcf_query_posts

php

wpmcf_query_posts( array $args ): array

get_posts() çağrısını suppress_filters => false ile yapar; böylece wpmcf_query, orderby wpmcf:group.field ve wpmcf_distance çalışır. Şunu döndürür: WP_Post[] (veya 'fields' => 'ids' ile ID'ler); sorgu başarısız olursa boş dizi.

php

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

Bkz. Yazıları sorgulama.

wpmcf_get_global

php

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

Bir Global Data değişkeninin ham değeri (dize). Eksik veya boş değişken için $args['default'] döner. {{ }} ifadelerini çözümler. Parola değişkenlerini şifresi çözülmüş olarak döndürür.

php

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

wpmcf_the_global

php

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

Kaçışlanmış değeri şu öğenin içinde yazdırır: <span class="wpmcf-global-value">. $args: format, wrap. {{ }} ifadelerini çözümler; eksik veya boş bir değişken için default yazdırılır. Parola değişkenleri için, wpmcf/global/the_password izin vermedikçe hiçbir şey yazdırmaz.

php

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

wpmcf_has_global

php

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

Değişken mevcutsa ve boş değilse true döner ('0' bir değer sayılır).

wpmcf_update_global

php

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

Bir mevcut değişkeni ayarlar; yalnızca skaler değer veya null kabul edilir; HTML etiketleri kaldırılır; wpmcf/global_data/saved tetiklenir. false döner: bilinmeyen anahtar veya skaler olmayan değer durumunda. Yetki kontrolü yapılmaz.

php

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

Dahili yardımcılar

Bunlar eklenti ve entegrasyonları için vardır. Kararlı API'nin parçası değildir; yukarıdaki fonksiyonları kullanın.

Fonksiyon	Notlar
`wpmcf_field_runtime_service(): ?FieldRuntimeService`	Okuma/yazdırma fonksiyonlarının arkasındaki servis. `null` değeri, eklenti başlatılmadan önce döner.
`wpmcf_field_writer(): ?FieldWriter`	Yazma fonksiyonlarının arkasındaki servis. `null` değeri, başlatma öncesinde döner.
`wpmcf_global_data_runtime_service(): ?GlobalDataRuntimeService`	Global Data fonksiyonlarının arkasındaki servis.
`wpmcf_resolve_object( mixed $object, array $args, string $function ): ?array`	Bir nesne referansını `[ id, args ]` değerine dönüştürür; geçersizse `null` (artı `_doing_it_wrong()`, `WP_DEBUG` altında) döner.
`wpmcf_booted_service( string $class )`	Başlatma sonrasında bir servisi kapsayıcıda arar.

Başka yerlerde belgelenen diğer fonksiyonlar

Fonksiyon	Nerede
`wpmcf_resolve_variables()`, `wpmcf_make_context()`, `wpmcf_variable_engine()`, `wpmcf_variable_registry()`	Değişkenler ve hook'lar
`wpmcf_register_field_group()`	Alan grupları (PHP ile kaydedilen gruplar)
`wpmcf_get_order_field()` (Pro, WooCommerce siparişleri)	Entegrasyonlar

Argümanların belgelendiği yerler

Konu	Sayfa
Türe göre dönüş değerleri	Değerleri okuma
Nesne referansları	Nesne referansları
`format` ve `wrap`	Çıktı biçimleri ve kaçışlama
Shortcode öznitelikleri	Shortcode'lar

Bu sayfa yardımcı oldu mu?

Hâlâ takıldınız mı? Destek ile iletişime geçin