You are here

function search_by_page_force_remove in Search by Page 8

Same name and namespace in other branches
  1. 6 search_by_page.module \search_by_page_force_remove()
  2. 7 search_by_page.module \search_by_page_force_remove()

Removes a page from Search by Page.

The page will immediately be unavailable in search results, and will not be reindexed (unless hook_search_by_page_paths() submits it for indexing again).

Parameters

$module: Module that submitted this path for indexing.

$id: ID given in hook_search_by_page_paths() for this path.

$environment: Environment ID where this path should be removed. If omitted, all environments are checked.

4 calls to search_by_page_force_remove()
search_by_page_attach_node_delete in search_by_page_attach/search_by_page_attach.module
Implements hook_node_delete().
search_by_page_nodes_node_delete in search_by_page_nodes/search_by_page_nodes.module
Implements hook_node_delete().
search_by_page_paths_delete_confirm_submit in search_by_page_paths/search_by_page_paths.module
Submit callback for search_by_page_paths_delete_confirm().
search_by_page_users_user_delete in search_by_page_users/search_by_page_users.module
Implements hook_user_delete().

File

./search_by_page.module, line 57
Main module file for Drupal module Search by Page.

Code

function search_by_page_force_remove($module, $id, $environment = NULL) {
  $envs = [];
  if (isset($environment)) {
    $envs = [
      $environment,
    ];
  }
  else {
    $envs = search_by_page_list_environments();
  }
  foreach ($envs as $env) {
    $item = _search_by_page_lookup(0, '', $id, $module, $env);
    if ($item) {
      _search_by_page_remove_path($item->pid);
    }
  }
}