Fonksiyon referansı
4 dk okuma
Tüm işlevler geneldir, ücretsiz eklentide tanımlıdır ve her an çağrılabilir: eklenti başlatılmadan önce varsayılan değeri döndürürler, hatalar Massbase › Settings › Health altında günlüğe yazılır, asla fırlatılmaz. Ortak kurallar genel bakışta, nesne biçimleri ise Nesne başvuruları sayfasındadır.
İşlev | Amaç |
|---|---|
| Bir alanın ham değeri |
| Bir alanı kaçışlanmış olarak yazdırır |
| Alanın değeri var mı |
| Bir değeri kaydeder |
| Bir değeri temizler |
| Seçenek sayfası değerinin ham hali |
| Bir seçenek sayfası değerini yazdırır |
| Seçenek sayfası değeri var |
| Bir seçenek sayfası değerini kaydeder |
| Bir seçenek sayfası değerini temizler |
| Bir parola alanını doğrular |
| Şifreli veya düz parola alanını okur |
|
|
| Global Data değerinin ham hali |
| Bir Global Data değerini yazdırır |
| Global Data değeri var |
| Bir Global Data değerini günceller |
Dahili yardımcılar |
|
Diğer işlevler | Değişkenler, PHP ile kaydedilen gruplar, WooCommerce |
Ortak bağımsız değişkenler ($args)
Anahtar | İşlevler | Anlamı |
|---|---|---|
| get, has, the | Alanın değeri olmadığında ( |
| tüm alan işlevleri | Bir Group/Repeater değerinin içine nokta yolu veya segment dizisi |
| tüm alan işlevleri | Tek segmentli |
| şu parametreli işlevler: |
|
| the |
|
| the |
|
| şu parametreli işlevler: | Şunun için bir widget'ı tanımlar: |
wpmcf_get_field
wpmcf_get_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): mixedHam, kaçışlanmamış değer. Değer NULL ise ya da grup, alan veya nesne eksik veya geçersizse $args['default'] değerini (yoksa null) döndürür. Yazan güvenilir olduğunda {{ }} ifadelerini çözer.
$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
wpmcf_the_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): voidKaçışlanmış, biçimlendirilmiş değeri <span class="wpmcf-field-value"> içinde yazdırır ('wrap' => false ile kapatılır). 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.
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
wpmcf_has_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): booltrue döndürür; değer null, '' veya [] değilse (0, '0' ve false birer değer sayılır).
if ( wpmcf_has_field( 'listing', 'gallery' ) ) { /* ... */ }wpmcf_update_field
wpmcf_update_field( string $group_key, string $field_key, mixed $value, mixed $object = null, array $args = [] ): bool$value değerini alan türüyle doğrular ve temizler, yazar, sayfa önbelleklerini boşaltır (yazılar). null temizler. false döner: bilinmeyen bir grup/alan, eksik bir nesne veya geçersiz başvuru, reddedilen bir değer (eski değer korunur; alanın uzunluk, min/max veya adım kurallarını bozan değerler de buna dahildir) ya da başarısız bir yazma durumunda. Yetki denetimi yoktur. $args: context, widget_*.
wpmcf_update_field( 'listing', 'price', 450000, $post_id );
wpmcf_update_field( 'profile', 'bio', 'Hello', 'user_3' );Bkz. Değerleri yazma.
wpmcf_delete_field
wpmcf_delete_field( string $group_key, string $field_key, mixed $object = null, array $args = [] ): boolDeğeri temizler. true döner: temizlendiğinde veya temizlenecek bir şey olmadığında; false döner: bilinmeyen bir grup/alan veya geçersiz başvuruda. Yetki denetimi yoktur.
wpmcf_delete_field( 'listing', 'price', $post_id );wpmcf_get_option_field
wpmcf_get_option_field( string $group_key, string $field_key, array $args = [] ): mixedBir seçenek sayfasındaki ham değer (bağlam options olarak sabittir). $args: path, sub_key, default.
$name = wpmcf_get_option_field( 'site_settings', 'company_name' );wpmcf_the_option_field
wpmcf_the_option_field( string $group_key, string $field_key, array $args = [] ): voidKaçışlanmış seçenek sayfası değerini yazdırır. $args: format, wrap, path, sub_key, default.
wpmcf_the_option_field( 'site_settings', 'company_name', [ 'wrap' => false ] );wpmcf_has_option_field
wpmcf_has_option_field( string $group_key, string $field_key, array $args = [] ): boolSeçenek sayfası değeri boş değilse true döner. $args: path, sub_key.
wpmcf_update_option_field
wpmcf_update_option_field( string $group_key, string $field_key, mixed $value ): boolPaylaşılan seçenekler satırını yazar. Grubu gösteren her seçenek sayfası için bir kez wpmcf/options_pages/values_saved tetikler. Yetki denetimi yoktur. Grubun bir seçenek sayfasına ait olduğunu doğrulamaz.
wpmcf_update_option_field( 'site_settings', 'hours', 40 );wpmcf_delete_option_field
wpmcf_delete_option_field( string $group_key, string $field_key ): boolSeçenek sayfası değerini temizler. Yetki denetimi yoktur.
wpmcf_check_password
wpmcf_check_password( string $group_key, string $field_key, string $password, mixed $object = null, array $args = [] ): bool$password değeri, üst düzey bir Password alanının saklanan değeriyle (karma, şifreli veya düz) eşleşiyorsa true döner. false döner: boş bir alan veya parola, Password olmayan bir alan ya da bilinmeyen bir nesne için.
if ( wpmcf_check_password( 'download', 'code', $typed, $post_id ) ) { /* allow */ }Bkz. Parola yardımcıları ve güvenlik.
wpmcf_get_password
wpmcf_get_password( string $group_key, string $field_key, mixed $object = null, array $args = [] ): ?stringBir şifreli veya düz Password alanının okunabilir değeri; karma, boş bir alan veya başarısız okuma için null. Asla yazdırmayın.
$secret = wpmcf_get_password( 'integration', 'api_secret', 'option' );wpmcf_query_posts
wpmcf_query_posts( array $args ): arrayget_posts(), suppress_filters => false ile çalışır; böylece wpmcf_query, orderby wpmcf:group.field ve wpmcf_distance çalışır. WP_Post[] döndürür ('fields' => 'ids' ile kimlikler); sorgu başarısız olursa boş bir dizi döner.
$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
wpmcf_get_global( string $key, array $args = [] ): mixedBir Global Data değişkeninin ham değeri (dize). Eksik veya boş bir değişken için $args['default'] döner. {{ }} ifadelerini çözer. Parola değişkenlerinin çözülmüş halini döndürür.
$phone = wpmcf_get_global( 'phone', [ 'default' => '' ] );wpmcf_the_global
wpmcf_the_global( string $key, array $args = [] ): voidKaçışlanmış değeri <span class="wpmcf-global-value"> içinde yazdırır. $args: format, wrap. {{ }} ifadelerini çözer; eksik veya boş bir değişken için default yazdırılır. wpmcf/global/the_password izin vermedikçe parola değişkenleri için hiçbir şey yazdırmaz.
wpmcf_the_global( 'phone', [ 'wrap' => false ] );wpmcf_has_global
wpmcf_has_global( string $key, array $args = [] ): boolDeğişken varsa ve boş değilse true döner ('0' bir değer sayılır).
wpmcf_update_global
wpmcf_update_global( string $key, mixed $value ): boolYalnızca var olan bir değişkeni ayarlar; yalnızca skaler veya null kabul edilir; HTML etiketleri ayıklanır; wpmcf/global_data/saved tetiklenir. false döner: bilinmeyen anahtar veya skaler olmayan değer için. Yetki denetimi yoktur.
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 işlevleri kullanın.
İşlev | Notlar |
|---|---|
| Okuma/yazdırma işlevlerinin arkasındaki hizmet. Eklenti başlatılmadan önce |
| Yazma işlevlerinin arkasındaki hizmet. Başlatmadan önce |
| Global Data işlevlerinin arkasındaki hizmet. |
| Bir nesne başvurusunu |
| Başlatmadan sonra bir hizmeti kapsayıcıda arar. |
Başka yerde belgelenen diğer işlevler
İşlev | Nerede |
|---|---|
| |
| Alan grupları (PHP ile kaydedilen gruplar) |
|
ACF uyumluluk işlevleri
ACF'den taşıma sonrasında, ACF devre dışı bırakıldığında eklenti taşınan alanlar için ACF'nin şablon işlevlerini sağlar: get_field(), the_field(), get_fields(), get_field_object(), have_rows(), the_row() ve get_sub_field() döngüleri, update_field(), delete_field(), [acf] shortcode'u ve seçenek sayfası okumaları. Yalnızca uyumluluk katmanı etkin olduğu sürece vardırlar ve yeni kodda kullanmamalısınız.
ACF işlevi | Bunun yerine kullanın |
|---|---|
|
|
|
|
|
|
|
|
|
|
Seçenek sayfası okumaları |
|
Massbase › Tools › ACF, temanızda ve eklentilerinizde hâlâ bir ACF işlevi çağıran her yeri, yerine geçecek kodla birlikte listeler. Kodu adım adım taşımak için satırları tek tek ilerleyin.
Bağımsız değişkenlerin belgelendiği yerler
Konu | Sayfa |
|---|---|
Türe göre dönüş değerleri | |
Nesne başvuruları | |
| |
Shortcode öznitelikleri |
Hâlâ takıldınız mı? Destek ile iletişime geçin