Перейти до вмісту

Хуки

Фільтри й дії для налаштування сторінок, шаблонів блоків, шаблонів сайту та парсера HTML.

Парсер

blockstudio/block_tags/builders

Реєструє будівники масивів блоків, які використовують теги блоків і спеціальні блоки з прив’язкою до елементів. Зворотний виклик для кожного блока отримує масив атрибутів і необроблений внутрішній вміст.

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 і blockstudio/parser/renderers отримують той самий реєстр. Вони запускаються після blockstudio/block_tags/builders у цьому порядку й можуть замінити раніший будівник для того самого блока.

blockstudio/parser/element_mapping

Перевизначає стандартне зіставлення елементів HTML із блоками. Типові елементи HTML, як-от <h1>, <p> і <img>, за замовчуванням зіставляються з базовими блоками WordPress. Використовуйте цей фільтр, щоб спрямувати будь-який елемент до іншого блока.

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

Якщо <p> зіставляється із зареєстрованим небазовим блоком Blockstudio з атрибутом розширеного тексту content, його внутрішній вміст HTML копіюється до цього атрибута, зокрема вбудовані теги, як-от code і img, які також зіставляються з елементами. Абзац, єдиним дочірнім елементом якого є зображення, перетворюється на блок, до якого його зіставляє <img>. Вкладені теги блоків або блокові елементи HTML зберігають стандартну поведінку розбору внутрішніх блоків.

Сторінки

blockstudio/pages/paths

Фільтрує каталоги, у яких шукають шаблони сторінок.

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

Фільтрує максимальний вік кешу маніфесту попередньої версії до 7.6.2, який може ініціалізувати збережене середовище виконання колекції під час оновлення. Звичайні запити використовують збережену конфігурацію колекції й періодично не сканують кореневі каталоги сторінок. Запустіть wp bs pages sync або викличте Blockstudio\Pages::reconcile() після зміни маніфесту колекції.

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

blockstudio/pages/create_post_data

Фільтрує дані публікації перед створенням нової сторінки.

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

Фільтрує дані публікації перед оновленням наявної сторінки.

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

blockstudio/pages/synced

Дія виконується після синхронізації всіх сторінок.

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

blockstudio/pages/post_created

Дія виконується після створення публікації сторінки.

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

blockstudio/pages/post_updated

Дія виконується після оновлення публікації сторінки.

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

Візерунки

blockstudio/patterns/paths

Фільтрує каталоги, у яких шукають шаблони візерунків.

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

blockstudio/patterns/registered

Дія виконується після реєстрації всіх візерунків.

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

Шаблони сайту

blockstudio/site_templates/template_paths

Фільтрує каталоги, у яких шукають файли 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

Фільтрує каталоги, у яких шукають файли part.json.

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

blockstudio/site_templates/paths

Фільтрує разом обидва списки шляхів пошуку. Значення містить масиви templates і parts.

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

blockstudio/site_templates/template_candidates

Фільтрує кандидатів серед файлів джерела після визначення маніфесту й логічного дерева джерел.

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

Фільтрує повні шаблони, повернуті реєстром API.

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

blockstudio/site_templates/parts

Фільтрує частини шаблонів, повернуті реєстром API.

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

blockstudio/site_templates/template_content

Фільтрує вихідний рядок шаблону, перш ніж Blockstudio розбере його на блоки.

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

blockstudio/site_templates/part_content

Фільтрує вихідний рядок частини шаблону, перш ніж Blockstudio розбере його на блоки.

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

blockstudio/site_templates/parser

Фільтрує екземпляр Blockstudio\Html_Parser, який використовується для одного скомпільованого шаблону або його частини. Поверніть Html_Parser; інші значення призводять до використання стандартного аналізатора.

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

blockstudio/site_templates/discovered

Дія виконується після холодного циклу пошуку й компіляції, перед збереженням оновленого реєстру.

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

blockstudio/site_templates/registered

Дія виконується після збереження оновленого реєстру шаблонів Site Editor, що базується на файлах.

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

Дії discovered і registered не виконуються, якщо кеш реєстру актуальний.