You are here

Home » API reference » Zircon Profile 8 » rest.api.php

function hook_rest_resource_alter in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/rest/rest.api.php \hook_rest_resource_alter()

Alter the resource plugin definitions.

Parameters

array $definitions: The collection of resource definitions.

Related topics

Hooks
Define functions that alter the behavior of Drupal core.
1 invocation of hook_rest_resource_alter()
ResourcePluginManager::__construct in core/modules/rest/src/Plugin/Type/ResourcePluginManager.php
Constructs a new \Drupal\rest\Plugin\Type\ResourcePluginManager object.

File

core/modules/rest/rest.api.php, line 19
Describes hooks provided by the RESTful Web Services module.

Code

function hook_rest_resource_alter(&$definitions) {
  if (isset($definitions['entity:node'])) {

    // We want to handle REST requests regarding nodes with our own plugin
    // class.
    $definitions['entity:node']['class'] = 'Drupal\\mymodule\\Plugin\\rest\\resource\\NodeResource';

    // Serialized nodes should be expanded to my specific node class.
    $definitions['entity:node']['serialization_class'] = 'Drupal\\mymodule\\Entity\\MyNode';
  }

  // We don't want Views to show up in the array of plugins at all.
  unset($definitions['entity:view']);
}