Zum Inhalt springen

Hooks

Filter und Aktionen zur Anpassung von Seiten, Mustern, Website-Vorlagen und dem Parser HTML.

Parser

blockstudio/block_tags/builders

Registriere Builder für Block-Arrays, die von Block-Tags und elementzugeordneten benutzerdefinierten Blöcken verwendet werden. Der Callback für jeden Block erhält ein Attribut-Array und rohe innere Inhalte.

PHP
add_filter( 'blockstudio/block_tags/builders', function( $builders, $parser ) {
    $builders['acf/hero'] = function( array $attrs, string $inner_content ) {
        $inner_blocks = Blockstudio\Block_Tags::parse_inner_blocks( $inner_content );

        return array(
            'blockName'    => 'acf/hero',
            'attrs'        => $attrs,
            'innerBlocks'  => $inner_blocks,
            'innerHTML'    => '',
            'innerContent' => array_fill( 0, count( $inner_blocks ), null ),
        );
    };

    return $builders;
}, 10, 2 );

blockstudio/block_tags/renderers und blockstudio/parser/renderers greifen auf dieselbe Registry zu. Sie werden nach blockstudio/block_tags/builders in dieser Reihenfolge ausgeführt und können einen früheren Builder für denselben Block ersetzen.

blockstudio/parser/element_mapping

Überschreibe die Standardzuordnung von HTML-Elementen zu Blöcken. Standardmäßig werden gewöhnliche HTML-Elemente wie <h1>, <p> und <img> Core-WordPress-Blöcken zugeordnet. Mit diesem Filter kannst du jedes Element einem anderen Block zuweisen.

PHP
add_filter( 'blockstudio/parser/element_mapping', function( $mapping ) {
    $mapping['h1']  = 'custom/heading';
    $mapping['h2']  = 'custom/heading';
    $mapping['p']   = 'custom/paragraph';
    $mapping['img'] = 'custom/image';

    return $mapping;
}, 10, 2 );

Wenn <p> einem registrierten Nicht-Core-Blockstudio-Block mit einem Richtext-Attribut content zugeordnet ist, wird sein inneres HTML in dieses Attribut kopiert, einschließlich Inline-Tags wie code und img, die ebenfalls Elementen zugeordnet sind. Ein Absatz, dessen einziges untergeordnetes Element ein Bild ist, wird zu dem Block, dem <img> zugeordnet ist. Verschachtelte Block-Tags oder HTML auf Blockebene behalten das übliche Verhalten beim Parsen innerer Blöcke bei.

Seiten

blockstudio/pages/paths

Filtert die Verzeichnisse, die nach Seitenvorlagen durchsucht werden.

PHP
add_filter( 'blockstudio/pages/paths', function( $paths ) {
    $paths[] = get_template_directory() . '/custom-pages';
    $paths[] = MY_PLUGIN_DIR . '/pages';
    return $paths;
} );

blockstudio/pages/manifest_scan_interval

Filtert das Höchstalter eines veralteten Manifest-Caches vor Version 7.6.2, der beim Upgrade die persistierte Collection-Laufzeitkonfiguration initialisieren darf. Bei normalen Anfragen wird die persistierte Collection-Konfiguration verwendet und die Seitenstammverzeichnisse werden nicht regelmäßig erneut durchsucht. Führe wp bs pages sync aus oder rufe Blockstudio\Pages::reconcile() auf, nachdem du ein Collection-Manifest geändert hast.

PHP
add_filter( 'blockstudio/pages/manifest_scan_interval', function() {
    return 10;
} );

blockstudio/pages/create_post_data

Filtert Beitragsdaten, bevor eine neue Seite erstellt wird.

PHP
add_filter( 'blockstudio/pages/create_post_data', function( $post_data, $page_data ) {
    $post_data['post_author'] = 1;
    return $post_data;
}, 10, 2 );

blockstudio/pages/update_post_data

Filtert Beitragsdaten, bevor eine vorhandene Seite aktualisiert wird.

PHP
add_filter( 'blockstudio/pages/update_post_data', function( $post_data, $post, $page_data ) {
    return $post_data;
}, 10, 3 );

blockstudio/pages/synced

Wird ausgelöst, nachdem alle Seiten synchronisiert wurden.

PHP
add_action( 'blockstudio/pages/synced', function( $registry ) {
    // $registry is the Page_Registry instance
} );

blockstudio/pages/post_created

Wird ausgelöst, nachdem ein Seitenbeitrag erstellt wurde.

PHP
add_action( 'blockstudio/pages/post_created', function( $post_id, $page_data ) {
    // Do something after page creation
}, 10, 2 );

blockstudio/pages/post_updated

Wird ausgelöst, nachdem ein Seitenbeitrag aktualisiert wurde.

PHP
add_action( 'blockstudio/pages/post_updated', function( $post_id, $page_data ) {
    // Do something after page update
}, 10, 2 );

Muster

blockstudio/patterns/paths

Filtert die Verzeichnisse, die nach Mustervorlagen durchsucht werden.

PHP
add_filter( 'blockstudio/patterns/paths', function( $paths ) {
    $paths[] = get_stylesheet_directory() . '/custom-patterns';
    $paths[] = MY_PLUGIN_PATH . '/patterns';
    return $paths;
} );

blockstudio/patterns/registered

Wird ausgelöst, nachdem alle Muster registriert wurden.

PHP
add_action( 'blockstudio/patterns/registered', function( $registry ) {
    // $registry is the Pattern_Registry instance
} );

Website-Vorlagen

blockstudio/site_templates/template_paths

Filtert die Verzeichnisse, die nach template.json-Dateien durchsucht werden.

PHP
add_filter( 'blockstudio/site_templates/template_paths', function( $paths ) {
    $paths[] = get_stylesheet_directory() . '/site-templates';
    return $paths;
} );

blockstudio/site_templates/part_paths

Filtert die Verzeichnisse, die nach part.json-Dateien durchsucht werden.

PHP
add_filter( 'blockstudio/site_templates/part_paths', function( $paths ) {
    $paths[] = get_stylesheet_directory() . '/site-parts';
    return $paths;
} );

blockstudio/site_templates/paths

Filtert beide Erkennungspfadlisten gemeinsam. Der Wert enthält templates– und parts-Arrays.

PHP
add_filter( 'blockstudio/site_templates/paths', function( $paths ) {
    return $paths;
} );

blockstudio/site_templates/template_candidates

Filtert Kandidaten für Quelldateien, nachdem das Manifest und der logische Quellbaum aufgelöst wurden.

PHP
add_filter(
    'blockstudio/site_templates/template_candidates',
    function( $candidates, $directory, $manifest ) {
        $candidates[] = $directory . '/template.custom.php';
        return $candidates;
    },
    10,
    3
);

blockstudio/site_templates/templates

Filtert vollständige Vorlagen, die von der Registry API zurückgegeben werden.

PHP
add_filter( 'blockstudio/site_templates/templates', function( $templates ) {
    return $templates;
} );

blockstudio/site_templates/parts

Filtert Vorlagenteile, die von der Registry API zurückgegeben werden.

PHP
add_filter( 'blockstudio/site_templates/parts', function( $parts ) {
    return $parts;
} );

blockstudio/site_templates/template_content

Filtert eine Vorlagen-Quellzeichenfolge, bevor Blockstudio sie in Blöcke parst.

PHP
add_filter( 'blockstudio/site_templates/template_content', function( $content, $template ) {
    return $content;
}, 10, 2 );

blockstudio/site_templates/part_content

Filtert eine Quellzeichenfolge für einen Vorlagenteil, bevor Blockstudio sie in Blöcke parst.

PHP
add_filter( 'blockstudio/site_templates/part_content', function( $content, $part ) {
    return $content;
}, 10, 2 );

blockstudio/site_templates/parser

Filtert die für eine kompilierte Vorlage oder einen Vorlagenteil verwendete Instanz von Blockstudio\Html_Parser. Gib ein Html_Parser zurück; andere Werte verwenden den Standardparser.

PHP
add_filter(
    'blockstudio/site_templates/parser',
    function( $parser, $item ) {
        return $parser;
    },
    10,
    2
);

blockstudio/site_templates/discovered

Aktion wird nach einem Durchlauf für kalte Erkennung und Kompilierung ausgelöst, bevor die neu erstellte Registrierung gespeichert wird.

PHP
add_action( 'blockstudio/site_templates/discovered', function( $registry ) {
    // Inspect the rebuilt Site_Template_Registry.
} );

blockstudio/site_templates/registered

Aktion wird ausgelöst, nachdem eine neu erstellte, dateibasierte Site-Editor-Vorlagenregistrierung gespeichert wurde.

PHP
add_action( 'blockstudio/site_templates/registered', function( $registry ) {
    // $registry is the Site_Template_Registry instance
} );

Die Aktionen discovered und registered werden bei einem Treffer im warmen Registrierungscache nicht ausgelöst.