search.post_update.php

Same filename in other branches
  1. 9 core/modules/search/search.post_update.php
  2. 8.9.x core/modules/search/search.post_update.php
  3. 10 core/modules/search/search.post_update.php

Post update functions for Search module.

File

core/modules/search/search.post_update.php

View source
<?php


/**
 * @file
 * Post update functions for Search module.
 */
use Drupal\Core\Config\Entity\ConfigEntityUpdater;
use Drupal\block\BlockInterface;

/**
 * Implements hook_removed_post_updates().
 */
function search_removed_post_updates() : array {
    return [
        'search_post_update_block_page' => '9.0.0',
        'search_post_update_reindex_after_diacritics_rule_change' => '10.0.0',
    ];
}

/**
 * Updates Search Blocks' without an explicit `page_id` from '' to NULL.
 */
function search_post_update_block_with_empty_page_id(&$sandbox = []) {
    $config_entity_updater = \Drupal::classResolver(ConfigEntityUpdater::class);
    $config_entity_updater->update($sandbox, 'block', function (BlockInterface $block) : bool {
        // Only update blocks using the search block plugin.
        // @see search_block_presave()
        if ($block->getPluginId() === 'search_form_block' && $block->get('settings')['page_id'] === '') {
            $settings = $block->get('settings');
            $settings['page_id'] = NULL;
            $block->set('settings', $settings);
            return TRUE;
        }
        return FALSE;
    });
}

Functions

Title Deprecated Summary
search_post_update_block_with_empty_page_id Updates Search Blocks' without an explicit `page_id` from '' to NULL.
search_removed_post_updates Implements hook_removed_post_updates().

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.