Issue #2018375 by andypost: Get rid of node_hook() and node_invoke().

core/modules/field/field.api.php

@@ -13,7 +13,7 @@
  *
  * Field UI's "Manage fields" and "Manage display" pages let users re-order
  * fields, but also non-field components. For nodes, these include the title
- * and other elements exposed by modules through hook_form() or hook_form_alter().
+ * and other elements exposed by modules through hook_form_alter().
  *
  * Fieldable entities or modules that want to have their components supported
  * should expose them using this hook. The user-defined settings (weight,

core/modules/forum/forum.module

@@ -632,6 +632,20 @@ function forum_form_taxonomy_term_form_alter(&$form, &$form_state, $form_id) {
  * Implements hook_form_BASE_FORM_ID_alter() for node_form().
  */
 function forum_form_node_form_alter(&$form, &$form_state, $form_id) {
+  $node = $form_state['controller']->getEntity();
+  if (isset($node->taxonomy_forums) && !$node->isNew()) {
+    $forum_terms = $node->taxonomy_forums;
+    // If editing, give option to leave shadows.
+    $shadow = (count($forum_terms) > 1);
+    $form['shadow'] = array(
+      '#type' => 'checkbox',
+      '#title' => t('Leave shadow copy'),
+      '#default_value' => $shadow,
+      '#description' => t('If you move this topic, you can leave a link in the old forum to the new forum.'),
+    );
+    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
+  }
+
   if (isset($form['taxonomy_forums'])) {
     $langcode = $form['taxonomy_forums']['#language'];
     // Make the vocabulary required for 'real' forum-nodes.
@@ -664,29 +678,6 @@ function forum_block_view_pre_render($elements) {
   return $elements;
 }
 
-/**
- * Implements hook_form().
- */
-function forum_form(EntityInterface $node, &$form_state) {
-  $type = node_type_load($node->type);
-  $form['title'] = array(
-    '#type' => 'textfield',
-    '#title' => check_plain($type->title_label),
-    '#default_value' => !empty($node->title) ? $node->title : '',
-    '#required' => TRUE, '#weight' => -5
-  );
-
-  if (!empty($node->nid)) {
-    $forum_terms = $node->taxonomy_forums;
-    // If editing, give option to leave shadows.
-    $shadow = (count($forum_terms) > 1);
-    $form['shadow'] = array('#type' => 'checkbox', '#title' => t('Leave shadow copy'), '#default_value' => $shadow, '#description' => t('If you move this topic, you can leave a link in the old forum to the new forum.'));
-    $form['forum_tid'] = array('#type' => 'value', '#value' => $node->forum_tid);
-  }
-
-  return $form;
-}
-
 /**
  * Returns a tree of all forums for a given taxonomy term ID.
  *

core/modules/node/content_types.inc

@@ -22,46 +22,44 @@ function node_overview_types() {
 
   foreach ($names as $key => $name) {
     $type = $types[$key];
-    if (node_hook($type->type, 'form')) {
-      $row = array(theme('node_admin_overview', array('name' => $name, 'type' => $type)));
-      if ($field_ui && user_access('administer node fields')) {
-        $links['fields'] = array(
-          'title' => t('Manage fields'),
-          'href' => 'admin/structure/types/manage/' . $type->type . '/fields',
-          'weight' => 0,
-        );
-      }
-      if ($field_ui && user_access('administer node display')) {
-        $links['display'] = array(
-          'title' => t('Manage display'),
-          'href' => 'admin/structure/types/manage/' . $type->type . '/display',
-          'weight' => 5,
-        );
-      }
-
-      $links['edit'] = array(
-        'title' => t('Edit'),
-        'href' => 'admin/structure/types/manage/' . $type->type,
-        'weight' => 10,
+    $row = array(theme('node_admin_overview', array('name' => $name, 'type' => $type)));
+    if ($field_ui && user_access('administer node fields')) {
+      $links['fields'] = array(
+        'title' => t('Manage fields'),
+        'href' => 'admin/structure/types/manage/' . $type->type . '/fields',
+        'weight' => 0,
       );
-
-      if ($type->custom) {
-        $links['delete'] = array(
-          'title' => t('Delete'),
-          'href' => 'admin/structure/types/manage/' . $type->type . '/delete',
-          'weight' => 15,
-        );
-      }
-
-      $row[] = array(
-        'data' => array(
-          '#type' => 'operations',
-          '#links' => $links,
-        ),
+    }
+    if ($field_ui && user_access('administer node display')) {
+      $links['display'] = array(
+        'title' => t('Manage display'),
+        'href' => 'admin/structure/types/manage/' . $type->type . '/display',
+        'weight' => 5,
       );
+    }
+
+    $links['edit'] = array(
+      'title' => t('Edit'),
+      'href' => 'admin/structure/types/manage/' . $type->type,
+      'weight' => 10,
+    );
 
-      $rows[] = $row;
+    if ($type->custom) {
+      $links['delete'] = array(
+        'title' => t('Delete'),
+        'href' => 'admin/structure/types/manage/' . $type->type . '/delete',
+        'weight' => 15,
+      );
     }
+
+    $row[] = array(
+      'data' => array(
+        '#type' => 'operations',
+        '#links' => $links,
+      ),
+    );
+
+    $rows[] = $row;
   }
 
   $build['node_table'] = array(

core/modules/node/lib/Drupal/node/NodeFormController.php

@@ -20,8 +20,8 @@ class NodeFormController extends EntityFormController {
   /**
    * Prepares the node object.
    *
-   * Fills in a few default values, and then invokes hook_prepare() on the node
-   * type module, and hook_node_prepare() on all modules.
+   * Fills in a few default values, and then invokes hook_node_prepare() on all
+   * modules.
    *
    * Overrides Drupal\Core\Entity\EntityFormController::prepareEntity().
    */
@@ -49,7 +49,6 @@ protected function prepareEntity() {
     // Always use the default revision setting.
     $node->setNewRevision(in_array('revision', $node_options));
 
-    node_invoke($node, 'prepare');
     module_invoke_all('node_prepare', $node);
   }
 
@@ -93,18 +92,16 @@ public function form(array $form, array &$form_state) {
       '#default_value' => isset($node->changed) ? $node->changed : NULL,
     );
 
-    // Invoke hook_form() to get the node-specific bits. Can't use node_invoke()
-    // because hook_form() needs to be able to receive $form_state by reference.
-    // @todo hook_form() implementations are unable to add #validate or #submit
-    //   handlers to the form buttons below. Remove hook_form() entirely.
-    $function = node_hook($node->type, 'form');
-    if ($function && ($extra = $function($node, $form_state))) {
-      $form = NestedArray::mergeDeep($form, $extra);
-    }
-    // If the node type has a title, and the node type form defined no special
-    // weight for it, we default to a weight of -5 for consistency.
-    if (isset($form['title']) && !isset($form['title']['#weight'])) {
-      $form['title']['#weight'] = -5;
+    $node_type = node_type_load($node->type);
+    if ($node_type->has_title) {
+      $form['title'] = array(
+        '#type' => 'textfield',
+        '#title' => check_plain($node_type->title_label),
+        '#required' => TRUE,
+        '#default_value' => $node->title,
+        '#maxlength' => 255,
+        '#weight' => -5,
+      );
     }
 
     $language_configuration = module_invoke('language', 'get_default_configuration', 'node', $node->type);
@@ -342,13 +339,9 @@ public function validate(array $form, array &$form_state) {
       form_set_error('date', t('You have to specify a valid date.'));
     }
 
-    // Invoke hook_validate() for node type specific validation and
-    // hook_node_validate() for miscellaneous validation needed by modules.
-    // Can't use node_invoke() or module_invoke_all(), because $form_state must
+    // Invoke hook_node_validate() for validation needed by modules.
+    // Can't use module_invoke_all(), because $form_state must
     // be receivable by reference.
-    if ($function = node_hook($node->type, 'validate')) {
-      $function($node, $form, $form_state);
-    }
     foreach (module_implements('node_validate') as $module) {
       $function = $module . '_node_validate';
       $function($node, $form, $form_state);

core/modules/node/lib/Drupal/node/NodeRenderController.php

@@ -34,12 +34,6 @@ public function buildContent(array $entities, array $displays, $view_mode, $lang
       $bundle = $entity->bundle();
       $display = $displays[$bundle];
 
-      // The 'view' hook can be implemented to overwrite the default function
-      // to display nodes.
-      if (node_hook($bundle, 'view')) {
-        $entity = node_invoke($entity, 'view', $display, $view_mode, $langcode);
-      }
-
       $entity->content['links'] = array(
         '#theme' => 'links__node',
         '#pre_render' => array('drupal_pre_render_links'),

core/modules/node/lib/Drupal/node/NodeStorageController.php

@@ -52,14 +52,6 @@ protected function attachLoad(&$queried_entities, $load_revision = FALSE) {
       field_attach_load($this->entityType, $queried_entities);
     }
 
-    // Call object type specific callbacks on each typed array of nodes.
-    foreach ($typed_nodes as $node_type => $nodes_of_type) {
-      // Retrieve the node type 'base' hook implementation based on a Node in
-      // the type-specific stack.
-      if ($function = node_hook($node_type, 'load')) {
-        $function($nodes_of_type);
-      }
-    }
     // Besides the list of nodes, pass one additional argument to
     // hook_node_load(), containing a list of node types that were loaded.
     $argument = array_keys($typed_nodes);
@@ -85,15 +77,6 @@ protected function attachLoad(&$queried_entities, $load_revision = FALSE) {
   protected function invokeHook($hook, EntityInterface $node) {
     $node = $node->getBCEntity();
 
-    if ($hook == 'insert' || $hook == 'update') {
-      node_invoke($node, $hook);
-    }
-    else if ($hook == 'predelete') {
-      // 'delete' is triggered in 'predelete' is here to preserve hook ordering
-      // from Drupal 7.
-      node_invoke($node, 'delete');
-    }
-
     // Inline parent::invokeHook() to pass on BC-entities to node-specific
     // hooks.
 

core/modules/node/node.api.php

@@ -19,11 +19,6 @@
  * During node operations (create, insert, update, view, delete, etc.), there
  * are several sets of hooks that get invoked to allow modules to modify the
  * base node operation:
- * - Node-type-specific hooks: These hooks are only invoked on the primary
- *   module, using the "base" return component of hook_node_info() as the
- *   function prefix.  For example, forum.module defines the base for the Forum
- *   content type as "forum", so during creation of a forum node, hook_insert() is
- *   only invoked by calling forum_insert().
  * - All-module hooks: This set of hooks is invoked on all implementing modules,
  *   to allow other modules to modify what the primary node module is doing. For
  *   example, hook_node_insert() is invoked on all modules when creating a forum
@@ -44,7 +39,6 @@
  *   - hook_node_presave() (all)
  *   - hook_entity_presave() (all)
  *   - Node and revision records are written to the database
- *   - hook_insert() (node-type-specific)
  *   - field_attach_insert()
  *   - hook_node_insert() (all)
  *   - hook_entity_insert() (all)
@@ -55,7 +49,6 @@
  *   - hook_node_presave() (all)
  *   - hook_entity_presave() (all)
  *   - Node and revision records are written to the database
- *   - hook_update() (node-type-specific)
  *   - field_attach_update()
  *   - hook_node_update() (all)
  *   - hook_entity_update() (all)
@@ -64,13 +57,11 @@
  * - Loading a node (calling node_load(), node_load_multiple(), entity_load(),
  *   or entity_load_multiple() with $entity_type of 'node'):
  *   - Node and revision information is read from database.
- *   - hook_load() (node-type-specific)
  *   - field_attach_load_revision() and field_attach_load()
  *   - hook_entity_load() (all)
  *   - hook_node_load() (all)
  * - Viewing a single node (calling node_view() - note that the input to
  *   node_view() is a loaded node, so the Loading steps above are already done):
- *   - hook_view() (node-type-specific)
  *   - field_attach_prepare_view()
  *   - hook_entity_prepare_view() (all)
  *   - field_attach_view()
@@ -83,7 +74,6 @@
  *   above are already done):
  *   - field_attach_prepare_view()
  *   - hook_entity_prepare_view() (all)
- *   - hook_view() (node-type-specific)
  *   - field_attach_view()
  *   - hook_node_view() (all)
  *   - hook_entity_view() (all)
@@ -91,7 +81,6 @@
  *   - hook_entity_view_alter() (all)
  * - Deleting a node (calling $node->delete() or entity_delete_multiple()):
  *   - Node is loaded (see Loading section above)
- *   - hook_delete() (node-type-specific)
  *   - hook_node_predelete() (all)
  *   - hook_entity_predelete() (all)
  *   - field_attach_delete()
@@ -105,13 +94,10 @@
  *   - field_attach_delete_revision()
  * - Preparing a node for editing (calling node_form() - note that if it is an
  *   existing node, it will already be loaded; see the Loading section above):
- *   - hook_prepare() (node-type-specific)
  *   - hook_node_prepare() (all)
- *   - hook_form() (node-type-specific)
  *   - field_attach_form()
  * - Validating a node during editing form submit (calling
  *   node_form_validate()):
- *   - hook_validate() (node-type-specific)
  *   - hook_node_validate() (all)
  *   - field_attach_form_validate()
  * - Searching (calling node_search_execute()):
@@ -404,10 +390,9 @@ function hook_node_grants_alter(&$grants, $account, $op) {
 /**
  * Act before node deletion.
  *
- * This hook is invoked from entity_delete_multiple() after the type-specific
- * hook_delete() has been invoked, but before hook_entity_predelete() and
- * field_attach_delete() are called, and before the node is removed from the
- * node table in the database.
+ * This hook is invoked from entity_delete_multiple() before
+ * hook_entity_predelete() and field_attach_delete() are called, and before
+ * the node is removed from the node table in the database.
  *
  * @param \Drupal\Core\Entity\EntityInterface $node
  *   The node that is about to be deleted.
@@ -461,9 +446,8 @@ function hook_node_revision_delete(\Drupal\Core\Entity\EntityInterface $node) {
  * Respond to creation of a new node.
  *
  * This hook is invoked from $node->save() after the database query that will
- * insert the node into the node table is scheduled for execution, after the
- * type-specific hook_insert() is invoked, and after field_attach_insert() is
- * called.
+ * insert the node into the node table is scheduled for execution, and after
+ * field_attach_insert() is called.
  *
  * Note that when this hook is invoked, the changes have not yet been written to
  * the database, because a database transaction is still in progress. The
@@ -515,9 +499,8 @@ function hook_node_create(\Drupal\Core\Entity\EntityInterface $node) {
  * This hook is invoked during node loading, which is handled by entity_load(),
  * via classes Drupal\node\NodeStorageController and
  * Drupal\Core\Entity\DatabaseStorageController. After the node information is
- * read from the database or the entity cache, hook_load() is invoked on the
- * node's content type module, then field_attach_load_revision() or
- * field_attach_load() is called, then hook_entity_load() is invoked on all
+ * read from the database or the entity cache, then field_attach_load_revision()
+ * or field_attach_load() is called, then hook_entity_load() is invoked on all
  * implementing modules, and finally hook_node_load() is invoked on all
  * implementing modules.
  *
@@ -525,9 +508,7 @@ function hook_node_create(\Drupal\Core\Entity\EntityInterface $node) {
  *   An array of the nodes being loaded, keyed by nid.
  * @param $types
  *   An array containing the node types present in $nodes. Allows for an early
- *   return for modules that only support certain node types. However, if your
- *   module defines a content type, you can use hook_load() to respond to
- *   loading of just that content type.
+ *   return for modules that only support certain node types.
  *
  * For a detailed usage example, see nodeapi_example.module.
  *
@@ -616,8 +597,7 @@ function hook_node_access($node, $op, $account, $langcode) {
 /**
  * Act on a node object about to be shown on the add/edit form.
  *
- * This hook is invoked from NodeFormController::prepareEntity() after the
- * type-specific hook_prepare() is invoked.
+ * This hook is invoked from NodeFormController::prepareEntity().
  *
  * @param \Drupal\Core\Entity\EntityInterface $node
  *   The node that is about to be shown on the add/edit form.
@@ -681,9 +661,8 @@ function hook_node_presave(\Drupal\Core\Entity\EntityInterface $node) {
  * Respond to updates to a node.
  *
  * This hook is invoked from $node->save() after the database query that will
- * update node in the node table is scheduled for execution, after the
- * type-specific hook_update() is invoked, and after field_attach_update() is
- * called.
+ * update node in the node table is scheduled for execution, and after
+ * field_attach_update() is called.
  *
  * Note that when this hook is invoked, the changes have not yet been written to
  * the database, because a database transaction is still in progress. The
@@ -735,8 +714,7 @@ function hook_node_update_index(\Drupal\Core\Entity\EntityInterface $node, $lang
  *
  * This hook is invoked from NodeFormController::validate(), after a user has
  * finished editing the node and is previewing or submitting it. It is invoked
- * at the end of all the standard validation steps, and after the type-specific
- * hook_validate() is invoked.
+ * at the end of all the standard validation steps.
  *
  * To indicate a validation error, use form_set_error().
  *
@@ -793,9 +771,9 @@ function hook_node_submit(\Drupal\Core\Entity\EntityInterface $node, $form, &$fo
 /**
  * Act on a node that is being assembled before rendering.
  *
- * The module may add elements to $node->content prior to rendering. This hook
- * will be called after hook_view(). The structure of $node->content is a
- * renderable array as expected by drupal_render().
+ * The module may add elements to $node->content prior to rendering.
+ * The structure of $node->content is a renderable array as expected by
+ * drupal_render().
  *
  * When $view_mode is 'rss', modules can also add extra RSS elements and
  * namespaces to $node->rss_elements and $node->rss_namespaces respectively for
@@ -984,7 +962,6 @@ function hook_ranking() {
   }
 }
 
-
 /**
  * Respond to node type creation.
  *
@@ -1028,282 +1005,6 @@ function hook_node_type_delete($info) {
   variable_del('comment_' . $info->type);
 }
 
-/**
- * Respond to node deletion.
- *
- * This hook is invoked only on the module that defines the node's content type
- * (use hook_node_delete() to respond to all node deletions).
- *
- * This hook is invoked from entity_delete_multiple() after the node has been
- * removed from the node table in the database, before hook_node_delete() is
- * invoked, and before field_attach_delete() is called.
- *
- * @param \Drupal\Core\Entity\EntityInterface $node
- *   The node that is being deleted.
- *
- * @ingroup node_api_hooks
- */
-function hook_delete(\Drupal\Core\Entity\EntityInterface $node) {
-  db_delete('mytable')
-    ->condition('nid', $node->nid)
-    ->execute();
-}
-
-/**
- * Act on a node object about to be shown on the add/edit form.
- *
- * This hook is invoked only on the module that defines the node's content type
- * (use hook_node_prepare() to act on all node preparations).
- *
- * This hook is invoked from NodeFormController::prepareEntity() before the
- * general hook_node_prepare() is invoked.
- *
- * @param \Drupal\Core\Entity\EntityInterface $node
- *   The node that is about to be shown on the add/edit form.
- *
- * @ingroup node_api_hooks
- */
-function hook_prepare(\Drupal\Core\Entity\EntityInterface $node) {
-  if ($file = file_check_upload($field_name)) {
-    $file = file_save_upload($field_name, _image_filename($file->filename, NULL, TRUE), FALSE, 0);
-    if ($file) {
-      if (!image_get_info($file->uri)) {
-        form_set_error($field_name, t('Uploaded file is not a valid image'));
-        return;
-      }
-    }
-    else {
-      return;
-    }
-    $node->images['_original'] = $file->uri;
-    _image_build_derivatives($node, TRUE);
-    $node->new_file = TRUE;
-  }
-}
-
-/**
- * Display a node editing form.
- *
- * This hook, implemented by node modules, is called to retrieve the form
- * that is displayed to create or edit a node. This form is displayed at path
- * node/add/[node type] or node/[node ID]/edit.
- *
- * The submit and preview buttons, administrative and display controls, and
- * sections added by other modules (such as path settings, menu settings,
- * comment settings, and fields managed by the Field UI module) are
- * displayed automatically by the node module. This hook just needs to
- * return the node title and form editing fields specific to the node type.
- *
- * @param \Drupal\Core\Entity\EntityInterface $node
- *   The node being added or edited.
- * @param $form_state
- *   The form state array.
- *
- * @return
- *   An array containing the title and any custom form elements to be displayed
- *   in the node editing form.
- *
- * @ingroup node_api_hooks
- */
-function hook_form(\Drupal\Core\Entity\EntityInterface $node, &$form_state) {
-  $type = node_type_load($node->type);
-
-  $form['title'] = array(
-    '#type' => 'textfield',
-    '#title' => check_plain($type->title_label),
-    '#default_value' => !empty($node->title) ? $node->title : '',
-    '#required' => TRUE, '#weight' => -5
-  );
-
-  $form['field1'] = array(