Hoppa till innehåll

Hooks

Filter och åtgärder för att anpassa sidor, mönster, webbplatsmallar och parsern HTML.

Parsern

blockstudio/block_tags/builders

Registrera byggare av blockmatriser som används av blocktaggar och anpassade block mappade från element. Återanropet för varje block får en attributmatris och rått inre innehåll.

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 och blockstudio/parser/renderers får samma register. De körs efter blockstudio/block_tags/builders, i den ordningen, och kan ersätta en tidigare byggare för samma block.

blockstudio/parser/element_mapping

Åsidosätt standardmappningen från HTML-element till block. Som standard mappas vanliga HTML-element som <h1>, <p> och <img> till kärnblocken WordPress. Använd det här filtret för att peka valfritt element till ett annat block.

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

Om <p> motsvarar ett registrerat icke-kärnblock av typen Blockstudio med ett content-attribut av typen richtext kopieras dess inre HTML till attributet, inklusive infogade taggar som code och img som också mappas till element. Ett stycke vars enda underordnade element är en bild blir det block som <img> motsvarar. Kapslade blocktaggar eller HTML på blocknivå följer den vanliga parsningen av inre block.

Sidor

blockstudio/pages/paths

Filtrera katalogerna som genomsöks efter sidmallar.

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

Filtrera den maximala åldern för en äldre manifestcache från före 7.6.2 som kan initiera den beständiga samlingskörningen under en uppgradering. Vanliga förfrågningar använder den beständiga samlingskonfigurationen och genomsöker inte sidrötterna regelbundet. Kör wp bs pages sync eller anropa Blockstudio\Pages::reconcile() efter att ha ändrat ett samlingsmanifest.

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

blockstudio/pages/create_post_data

Filtrera inläggsdata innan en ny sida skapas.

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

Filtrera inläggsdata innan en befintlig sida uppdateras.

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

blockstudio/pages/synced

Åtgärd som utlöses efter att alla sidor har synkroniserats.

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

blockstudio/pages/post_created

Åtgärd som utlöses efter att ett sidinlägg har skapats.

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

blockstudio/pages/post_updated

Åtgärd som utlöses efter att ett sidinlägg har uppdaterats.

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

Mönster

blockstudio/patterns/paths

Filtrera katalogerna som genomsöks efter mönstermallar.

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

blockstudio/patterns/registered

Åtgärd som utlöses efter att alla mönster har registrerats.

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

Webbplatsmallar

blockstudio/site_templates/template_paths

Filtrera katalogerna som genomsöks efter template.json-filer.

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

blockstudio/site_templates/part_paths

Filtrera katalogerna som genomsöks efter part.json-filer.

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

blockstudio/site_templates/paths

Filtrera båda listorna med sökvägar tillsammans. Värdet innehåller matriserna templates och parts.

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

blockstudio/site_templates/template_candidates

Filtrera kandidater till källfiler efter att manifestet och det logiska källträdet har lösts upp.

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

Filtrera fullständiga mallar som returneras av registret API.

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

blockstudio/site_templates/parts

Filtrera malldelar som returneras av registret API.

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

blockstudio/site_templates/template_content

Filtrera en källsträng för en mall innan Blockstudio parsar den till block.

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

blockstudio/site_templates/part_content

Filtrera en källsträng för en malldel innan Blockstudio parsar den till block.

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

blockstudio/site_templates/parser

Filtrera instansen av Blockstudio\Html_Parser som används för en kompilerad mall eller malldel. Returnera en Html_Parser; andra värden använder standardparsern.

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

blockstudio/site_templates/discovered

Åtgärd som utlöses efter en kall sök- och kompileringsomgång, innan det återskapade registret sparas.

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

blockstudio/site_templates/registered

Åtgärd som utlöses efter att ett återskapat filbaserat mallregister för Webbplatsredigeraren har sparats.

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

Åtgärderna discovered och registered utlöses inte vid en träff i en varm registercache.