Перейти к содержимому

Хуки

Фильтры и действия для настройки страниц, паттернов, шаблонов сайта и парсера 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, у которого есть атрибут richtext 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 не выполняются при попадании в теплый кэш реестра.