Aller au contenu

Hooks

Filtres et actions disponibles pour personnaliser les pages, les motifs, les modèles du site et l’analyseur HTML.

Analyseur

blockstudio/block_tags/builders

Enregistrez les constructeurs de tableaux de blocs utilisés par les balises de bloc et les blocs personnalisés associés à des éléments. Le rappel de chaque bloc reçoit un tableau d’attributs et le contenu interne brut.

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 et blockstudio/parser/renderers reçoivent le même registre. Ils s’exécutent après blockstudio/block_tags/builders, dans cet ordre, et peuvent remplacer un constructeur précédent pour le même bloc.

blockstudio/parser/element_mapping

Remplacez la correspondance par défaut entre les éléments HTML et les blocs. Par défaut, les éléments HTML standard comme <h1>, <p> et <img> correspondent aux blocs WordPress principaux. Utilisez ce filtre pour associer n’importe quel élément à un autre bloc.

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

Si <p> associe un bloc Blockstudio enregistré non principal doté d’un attribut richtext content, son contenu interne HTML est copié dans cet attribut, y compris les balises en ligne comme code et img, elles aussi associées à des éléments. Un paragraphe dont l’unique enfant est une image devient le bloc vers lequel pointe <img>. Les balises de bloc imbriquées ou les HTML de niveau bloc conservent le comportement normal d’analyse des blocs internes.

Pages

blockstudio/pages/paths

Filtrez les répertoires analysés pour trouver des modèles de page.

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

Filtrez l’âge maximal du cache de manifeste hérité antérieur à 7.6.2 pouvant initialiser le runtime de collection persistant lors d’une mise à niveau. Les requêtes normales utilisent la configuration de collection persistante et ne réanalysent pas périodiquement les racines de page. Exécutez wp bs pages sync ou appelez Blockstudio\Pages::reconcile() après avoir modifié un manifeste de collection.

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

blockstudio/pages/create_post_data

Filtrez les données de publication avant de créer une page.

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

Filtrez les données de publication avant de mettre à jour une page existante.

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

blockstudio/pages/synced

Action déclenchée après la synchronisation de toutes les pages.

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

blockstudio/pages/post_created

Action déclenchée après la création d’une publication de page.

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

blockstudio/pages/post_updated

Action déclenchée après la mise à jour d’une publication de page.

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

Modèles de blocs

blockstudio/patterns/paths

Filtrez les répertoires analysés pour trouver des modèles de blocs.

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

blockstudio/patterns/registered

Action déclenchée après l’enregistrement de tous les modèles de blocs.

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

Modèles de site

blockstudio/site_templates/template_paths

Filtrez les répertoires analysés pour trouver les fichiers template.json.

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

blockstudio/site_templates/part_paths

Filtrez les répertoires analysés pour trouver les fichiers part.json.

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

blockstudio/site_templates/paths

Filtrez ensemble les deux listes de chemins de découverte. La valeur contient des tableaux templates et parts.

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

blockstudio/site_templates/template_candidates

Filtrez les fichiers sources candidats une fois le manifeste et l’arborescence logique des sources résolus.

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

Filtrez les modèles complets renvoyés par le registre API.

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

blockstudio/site_templates/parts

Filtrez les parties de modèle renvoyées par le registre API.

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

blockstudio/site_templates/template_content

Filtrez une chaîne source de modèle avant que Blockstudio ne l’analyse en blocs.

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

blockstudio/site_templates/part_content

Filtrez une chaîne source de partie de modèle avant que Blockstudio ne l’analyse en blocs.

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

blockstudio/site_templates/parser

Filtrez l’instance Blockstudio\Html_Parser utilisée pour un modèle ou une partie compilé. Renvoyez un Html_Parser ; les autres valeurs rétablissent l’analyseur par défaut.

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

blockstudio/site_templates/discovered

Action déclenchée après une passe de découverte à froid et de compilation, avant la persistance du registre reconstruit.

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

blockstudio/site_templates/registered

Action déclenchée après la persistance d’un registre de modèles de l’éditeur de site reconstruit à partir de fichiers.

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

Les actions discovered et registered ne se déclenchent pas lorsque le cache du registre est utilisé.