Function __global->import_id_remap_put

Definitions

sources/import.php

  • Set the NEW ID for an imported old ID, which also tacitly indicates completion of importing an item of some type of content. This mapping (old ID to new ID) may be used later for importing related content that requires the new identifier. import_id_remap_get is the inverse of this function.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$type ID_TEXT No No required parameter N/A N/A An importation type code, from those the software has defined
$id_old string No No required parameter N/A N/A The source (old, original) ID of the mapping
$id_new AUTO_LINK No No required parameter N/A N/A The destination (new) ID of the mapping (0: N/A) (-1: resource was not imported due to an error)

Preview

Code (PHP)

/**
 * Set the NEW ID for an imported old ID, which also tacitly indicates completion of importing an item of some type of content. This mapping (old ID to new ID) may be used later for importing related content that requires the new identifier. import_id_remap_get is the inverse of this function.
 *
 * @param  ID_TEXT $type An importation type code, from those the software has defined
 * @param  string $id_old The source (old, original) ID of the mapping
 * @param  AUTO_LINK $id_new The destination (new) ID of the mapping (0: N/A) (-1: resource was not imported due to an error)
 */
function import_id_remap_put(string $type, string $id_old, int $id_new)