Update hook_entity_insert() (and others) to use EntityInterface and make implementations in core consistant

[YesCT]

Problem

There is an "and" in this title, so it might make sense to split into two issues, but...

grep -R --after=3 "Implements hook_entity_insert" *

or

ag -C3 "Implements hook_entity_insert" *

shows

core/modules/entity/tests/entity_crud_hook_test/entity_crud_hook_test.module
48-}
49-
50-/**
51: * Implements hook_entity_insert().
52- */
53-function entity_crud_hook_test_entity_insert($entity, $type) {
54-  $_SESSION['entity_crud_hook_test'][] = (__FUNCTION__ . ' called for type ' . $type);

core/modules/filter/filter.module
1595-}
1596-
1597-/**
1598: * Implements hook_entity_insert().
1599- */
1600-function filter_entity_insert(EntityInterface $entity) {
1601-  $referenced_files_by_field = _filter_get_file_ids_by_field($entity);

core/modules/path/path.module
441-}
442-
443-/**
444: * Implements hook_entity_insert().
445- */
446-function path_entity_insert(Entity $entity) {
447-  $langcode = isset($entity->langcode) ? $entity->langcode : LANGUAGE_NONE;

And while working on a port of the mollom contrib module, I found a fail in one of the tests in the filter.module code. And I wondered why it had anything to do with filter. YesCT/mollom@814a250

#1088
#87

Proposed resolution

• Update hook_entity_insert docs to take one argument of type EntityInterface
• Update entity_crud_hook_test_entity_insert() to use that new API
• Make a change record?

Remaining tasks

• Find all similar hooks that should be updated.
  • hook_entity_insert()
  • hook_entity_update()
  • more?

[docwilmot]

Dupe? #2558

Closing as a duplicate. Reopen if it is indeed a different issue.

[YesCT]

@BWpanda I cloned the backdrop repo and since that was merged, and I still see inconsistency

core/modules/entity/entity.api.php:function hook_entity_insert($entity, $type) {
core/modules/entity/tests/entity_crud_hook_test/entity_crud_hook_test.module:function entity_crud_hook_test_entity_insert($entity, $type) {
core/modules/filter/filter.module:function filter_entity_insert(EntityInterface $entity) {
core/modules/path/path.module:function path_entity_insert(Entity $entity) {

but I notice in https://github.com/backdrop/backdrop/pull/2253/files#diff-98ff26c655c1b808663b46a9336ec9b1R24 that the docs say Must extend the Entity class or implement EntityInterface

and when looking at the hook definition,

}

/**
 * Act on entities when inserted.
 *
 * @param $entity
 *   The entity object.
 * @param $type
 *   The type of entity being inserted (i.e. node, user, comment).
 */
function hook_entity_insert($entity, $type) {
  // Insert the new entity into a fictional table of all entities.
  $info = entity_get_info($type);
  list($id) = entity_extract_ids($type, $entity);

The param for $entity does not have a type.

I think there could still be a case for making it consistent, and specifying the type, (or documenting when to use Entity, and when to use EntityInterface

No worries, will reopen. Thanks for the update!

[YesCT]

sounds good! thanks!