İçeriğe geç
Değişkenler ve geliştirici hook'ları

PHP API

3 dk okuma

wpmcf_resolve_variables()

php
wpmcf_resolve_variables( string $template, ?EvaluationContext $context = null ): string

Her {{ }} bloğunu $template içinde değiştirir ve metni döndürür. Blokların dışındaki her şey korunur.

php
echo esc_html( wpmcf_resolve_variables( 'Hello {{ glb.company }}, it is {{ sys.year }}.' ) );
// Hello Acme, it is 2026.

Durum

Sonuç

Eklenti henüz başlatılmadı (plugins_loaded öncesinde)

Şablon değiştirilmeden döner

Motorun içinde beklenmeyen bir hata

Şablon değiştirilmeden döner; hata variables modülü altında kaydedilir (Settings › Health)

Değerlendirilemeyen bir blok

O blok boş kalır; geri kalanı çözümlenir

Bağlam yok, döngü içinde

Döngüdeki yazı (get_the_ID()) bağlam nesnesi olur

Bağlam yok, herhangi bir yazının dışında

Nesne yok: fg ve wp.post_* boştur, glb ve sys çalışmaya devam eder

Şu türde bir bağlam: term, user veya comment

wp.post_* boştur; wp.term_* nesneyi şu tür olduğunda okur: term

Dönüş değeri escape edilmez. Gideceği yere göre escape edin (esc_html(), esc_attr(), wp_kses_post()). Ayrıca saklanan alan değerlerindeki "ifadeleri kimin çalıştırabileceği" denetimine tabi değildir, çünkü güvenilir koddur: ona ziyaretçi girdisi vermeyin. Bkz. Güvenlik.

wpmcf_make_context()

php
wpmcf_make_context( ?int $object_id = null, string $context_type = 'post', array $source_values = [] ): EvaluationContext

Motora fg ve wp.post_* ifadelerinin hangi nesneye işaret ettiğini ve src içinde ne bulunduğunu bildiren bağlamı oluşturur.

Argüman

Anlamı

$object_id

Nesne kimliği. Belirtilmezse veya null ise: döngüdeki yazı (get_the_ID()); yoksa nesne olmaz.

$context_type

post (varsayılan), term, user veya comment. fg ifadesinin hangi nesne türünü okuyacağını belirler.

$source_values

Şu şekilde okunabilen bir dizi: {{ src.key }}

php
// A field of a specific post
$ctx = wpmcf_make_context( 42 );
echo esc_html( wpmcf_resolve_variables( '{{ fg.product.price | number(2) }}', $ctx ) );

// A field of a term
$ctx = wpmcf_make_context( $term->term_id, 'term' );
echo esc_html( wpmcf_resolve_variables( '{{ fg.category_extra.headline }}', $ctx ) );

// Values of your own
$ctx = wpmcf_make_context( null, 'post', [ 'city' => 'London', 'n' => 10 ] );
echo esc_html( wpmcf_resolve_variables( "{{ src.city == 'London' ? 'Capital' : 'City' }}", $ctx ) );

Değerlendirme bağlamı

WPMass\CustomFields\Variables\Context\EvaluationContext değiştirilemezdir: her with* metodu değiştirilmiş bir kopya döndürür.

Metot

Amaç

EvaluationContext::make()

Boş bir bağlam (nesne yok, tür post)

withObjectId( ?int $id )

Nesneyi ayarlar

withContextType( string $type )

post, term, user, comment

withSourceValues( array $values )

Şunun için değerler: src.*

withMeta( string $key, mixed $value )

Ad alanı çözümleyicileri için serbest biçimli veri (örneğin term_id; wp.term_* bunu bağlam nesnesine tercih eder)

getObjectId(), getContextType(), getSourceValue( $key ), getAllSourceValues(), getMeta( $key )

Geri okur

php
$ctx = wpmcf_make_context( $term->term_id, 'term' )->withMeta( 'term_id', $term->term_id );
echo esc_html( wpmcf_resolve_variables( '{{ wp.term_name }} ({{ wp.term_slug }})', $ctx ) );

Motor

php
$engine = wpmcf_variable_engine();   // ?VariableEngine, null until the plugin has booted

Metot

Döndürür

resolve( string $template, EvaluationContext $context ): string

Çözümlenen metin

resolveEscaped( string $template, EvaluationContext $context, callable $escape ): string

Şuna benzer: resolve() ancak her üst düzey blok sonucu $escape( string ): string üzerinden geçer, blokların çevresindeki metin yazıldığı gibi kalır. Bir editörün yazdığı HTML'ye değer yerleştirmek için kullanın.

hasVariables( string $text ): bool

Metnin şunu içerip içermediği: {{ (işe girişmeden önce hızlı bir kontrol)

getRegistry(): VariableRegistry

Kayıt defteri

php
$engine = wpmcf_variable_engine();
if ( $engine ) {
    $html = $engine->resolveEscaped(
        '<p class="price">{{ fg.product.price | number(2) }}</p>',
        wpmcf_make_context( get_the_ID() ),
        'esc_html'
    );
}

resolve() kendisi, wpmcf_resolve_variables() gibi istisnalara karşı korunmaz. Fonksiyonu tercih edin, ancak resolveEscaped() gerekiyorsa bunu kullanın.

Kayıt defteri

php
$registry = wpmcf_variable_registry();   // ?VariableRegistry

Metot

Amaç

registerNamespace( string $name, NamespaceResolverInterface|Closure $resolver )

Bir ad alanı ekler (bir closure, çözümleyiciyi ilk kullanımda oluşturur)

registerFilter( string $name, callable $fn )

Bir filtre ekler. $fn( $value, ...$arguments )

registerFunction( string $name, callable $fn )

Şunun için bir fonksiyon ekler: fn.name(). $fn( ...$arguments )

hasNamespace(), hasFilter(), hasFunction()

Varlık kontrolleri (adlar küçük harfe çevrilir)

getRegisteredNamespaces(), getRegisteredFilters(), getRegisteredFunctions()

Küçük harfli adların listeleri

Bir adı yeniden kaydetmek, önceki girdinin yerini alır.

Motoru genişletme

Ad alanlarını, filtreleri ve fonksiyonları wpmcf/variables/register action'ından ekleyin. Kayıt defterini alır ve eklenti başlatıldıktan sonra kayıt defteri oluşturulduğunda yalnızca bir kez tetiklenir.

php
use WPMass\CustomFields\Variables\Context\EvaluationContext;
use WPMass\CustomFields\Variables\Namespace\NamespaceResolverInterface;
use WPMass\CustomFields\Variables\Registry\VariableRegistry;

final class My_Resolver implements NamespaceResolverInterface {
    public function resolve( array $path, EvaluationContext $ctx ): mixed {
        // {{ my.rating }} → $path = [ 'rating' ]
        return match ( $path[0] ?? '' ) {
            'rating' => (string) get_post_meta( (int) $ctx->getObjectId(), 'rating', true ),
            default  => null,        // null renders nothing
        };
    }

    public function getNamespace(): string {
        return 'my';
    }
}

add_action( 'wpmcf/variables/register', function ( VariableRegistry $registry ): void {
    $registry->registerNamespace( 'my', new My_Resolver() );
    $registry->registerFilter( 'shout', fn ( $value, $suffix = '!' ) => strtoupper( (string) $value ) . $suffix );
    $registry->registerFunction( 'sum_all', fn ( ...$numbers ) => array_sum( $numbers ) );
} );

Artık {{ my.rating }}, {{ glb.name | shout('?') }} ve {{ fn.sum_all(1, 2, 3) }} çalışır.

Eklentiler için kurallar:

  • Düz değerler döndürün. Metin, sayı, boolean, null veya liste. Listeler şu ayraçla birleştirilerek yazdırılır: , ; null ve false hiçbir şey yazdırmaz; true ise 1 yazdırır.
  • Yola asla güvenmeyin. $path editörlerden gelir. İşlediğiniz adları beyaz listeye alın (yukarıdaki match gibi) ve yalnızca herkese açık yazdırılması güvenli verileri okuyun.
  • Sırları yazdırmayın. Parolalara ve anahtarlara erişilememelidir. Yerleşik fg ve glb çözümleyicileri parola değerlerini hariç tutar; bu kurala uyun.
  • Adlar harf, rakam ve alt çizgiden oluşur ve büyük/küçük harf duyarsız eşleşir. fn, func, fonk ve function fonksiyon çağrıları için ayrılmıştır.
  • Exception fırlatmak güvenlidir (blok boş çıkar), ancak null döndürmek daha temizdir.

Zamanlama

Dinleyici, kayıt defteri başlatma sonrasında oluşturulmadan önce eklenmelidir. Eklenti dosyanız yüklenirken veya plugins_loaded sırasında ekleyin. Bundan sonra çalışabiliyorsanız action'ı atlayın ve doğrudan kayıt defterine kaydedin:

php
$registry = wpmcf_variable_registry();
if ( $registry ) {
    $registry->registerFilter( 'shout', fn ( $value ) => strtoupper( (string) $value ) );
}

Bağlama istek verisi ekleme

Bu wpmcf/variables/context filtresi, bir modülün her üst düzey değerlendirmenin başında bağlama veri eklemesini sağlar. Programatik SEO bunu, oluşturulan bir sayfadaki alan değerlerinin sayfanın veri satırına erişmesi için kullanır.

php
add_filter( 'wpmcf/variables/context', function ( EvaluationContext $ctx ): EvaluationContext {
    return $ctx->withMeta( 'campaign', 'spring-sale' );
} );

İfade kullanmadan değer okuma

Şablona değil yalnızca bir değere ihtiyacınız olduğunda wpmcf_get_field() ve wpmcf_get_global() kullanın. Bunlar, saklanan değerin içindeki {{ }} ifadelerini Değişkenlerin çalıştığı yerler bölümündeki kurallara göre bir kez değerlendirir.

Bu sayfa yardımcı oldu mu?

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