5 * Hooks specific to the Node module.
8 use Drupal\node\NodeInterface;
9 use Drupal\Component\Utility\Html;
10 use Drupal\Component\Utility\Xss;
11 use Drupal\Core\Access\AccessResult;
19 * Inform the node access system what permissions the user has.
21 * This hook is for implementation by node access modules. In this hook,
22 * the module grants a user different "grant IDs" within one or more
23 * "realms". In hook_node_access_records(), the realms and grant IDs are
24 * associated with permission to view, edit, and delete individual nodes.
26 * The realms and grant IDs can be arbitrarily defined by your node access
27 * module; it is common to use role IDs as grant IDs, but that is not required.
28 * Your module could instead maintain its own list of users, where each list has
29 * an ID. In that case, the return value of this hook would be an array of the
30 * list IDs that this user is a member of.
32 * A node access module may implement as many realms as necessary to properly
33 * define the access privileges for the nodes. Note that the system makes no
34 * distinction between published and unpublished nodes. It is the module's
35 * responsibility to provide appropriate realms to limit access to unpublished
38 * Node access records are stored in the {node_access} table and define which
39 * grants are required to access a node. There is a special case for the view
40 * operation -- a record with node ID 0 corresponds to a "view all" grant for
41 * the realm and grant ID of that record. If there are no node access modules
42 * enabled, the core node module adds a node ID 0 record for realm 'all'. Node
43 * access modules can also grant "view all" permission on their custom realms;
44 * for example, a module could create a record in {node_access} with:
49 * 'realm' => 'example_realm',
51 * 'grant_update' => 0,
52 * 'grant_delete' => 0,
54 * db_insert('node_access')->fields($record)->execute();
56 * And then in its hook_node_grants() implementation, it would need to return:
58 * if ($op == 'view') {
59 * $grants['example_realm'] = array(888);
62 * If you decide to do this, be aware that the node_access_rebuild() function
63 * will erase any node ID 0 entry when it is called, so you will need to make
64 * sure to restore your {node_access} record after node_access_rebuild() is
67 * For a detailed example, see node_access_example.module.
69 * @param \Drupal\Core\Session\AccountInterface $account
70 * The account object whose grants are requested.
72 * The node operation to be performed, such as 'view', 'update', or 'delete'.
75 * An array whose keys are "realms" of grants, and whose values are arrays of
76 * the grant IDs within this realm that this user is being granted.
78 * @see node_access_view_all_nodes()
79 * @see node_access_rebuild()
80 * @ingroup node_access
82 function hook_node_grants(\Drupal\Core\Session\AccountInterface $account, $op) {
83 if ($account->hasPermission('access private content')) {
84 $grants['example'] = [1];
87 $grants['example_author'] = [$account->id()];
93 * Set permissions for a node to be written to the database.
95 * When a node is saved, a module implementing hook_node_access_records() will
96 * be asked if it is interested in the access permissions for a node. If it is
97 * interested, it must respond with an array of permissions arrays for that
100 * Node access grants apply regardless of the published or unpublished status
101 * of the node. Implementations must make sure not to grant access to
102 * unpublished nodes if they don't want to change the standard access control
103 * behavior. Your module may need to create a separate access realm to handle
104 * access to unpublished nodes.
106 * Note that the grant values in the return value from your hook must be
107 * integers and not boolean TRUE and FALSE.
109 * Each permissions item in the array is an array with the following elements:
110 * - 'realm': The name of a realm that the module has defined in
111 * hook_node_grants().
112 * - 'gid': A 'grant ID' from hook_node_grants().
113 * - 'grant_view': If set to 1 a user that has been identified as a member
114 * of this gid within this realm can view this node. This should usually be
115 * set to $node->isPublished(). Failure to do so may expose unpublished content
117 * - 'grant_update': If set to 1 a user that has been identified as a member
118 * of this gid within this realm can edit this node.
119 * - 'grant_delete': If set to 1 a user that has been identified as a member
120 * of this gid within this realm can delete this node.
121 * - langcode: (optional) The language code of a specific translation of the
122 * node, if any. Modules may add this key to grant different access to
123 * different translations of a node, such that (e.g.) a particular group is
124 * granted access to edit the Catalan version of the node, but not the
125 * Hungarian version. If no value is provided, the langcode is set
126 * automatically from the $node parameter and the node's original language (if
127 * specified) is used as a fallback. Only specify multiple grant records with
128 * different languages for a node if the site has those languages configured.
130 * A "deny all" grant may be used to deny all access to a particular node or
137 * 'grant_update' => 0,
138 * 'grant_delete' => 0,
139 * 'langcode' => 'ca',
142 * Note that another module node access module could override this by granting
143 * access to one or more nodes, since grants are additive. To enforce that
144 * access is denied in a particular case, use hook_node_access_records_alter().
145 * Also note that a deny all is not written to the database; denies are
148 * @param \Drupal\node\NodeInterface $node
149 * The node that has just been saved.
152 * An array of grants as defined above.
154 * @see hook_node_access_records_alter()
155 * @ingroup node_access
157 function hook_node_access_records(\Drupal\node\NodeInterface $node) {
158 // We only care about the node if it has been marked private. If not, it is
159 // treated just like any other node and we completely ignore it.
160 if ($node->private->value) {
162 // Only published Catalan translations of private nodes should be viewable
163 // to all users. If we fail to check $node->isPublished(), all users would be able
164 // to view an unpublished node.
165 if ($node->isPublished()) {
167 'realm' => 'example',
175 // For the example_author array, the GID is equivalent to a UID, which
176 // means there are many groups of just 1 user.
177 // Note that an author can always view his or her nodes, even if they
178 // have status unpublished.
179 if ($node->getOwnerId()) {
181 'realm' => 'example_author',
182 'gid' => $node->getOwnerId(),
195 * Alter permissions for a node before it is written to the database.
197 * Node access modules establish rules for user access to content. Node access
198 * records are stored in the {node_access} table and define which permissions
199 * are required to access a node. This hook is invoked after node access modules
200 * returned their requirements via hook_node_access_records(); doing so allows
201 * modules to modify the $grants array by reference before it is stored, so
202 * custom or advanced business logic can be applied.
204 * Upon viewing, editing or deleting a node, hook_node_grants() builds a
205 * permissions array that is compared against the stored access records. The
206 * user must have one or more matching permissions in order to complete the
207 * requested operation.
209 * A module may deny all access to a node by setting $grants to an empty array.
211 * The preferred use of this hook is in a module that bridges multiple node
212 * access modules with a configurable behavior, as shown in the example with the
213 * 'is_preview' field.
215 * @param array $grants
216 * The $grants array returned by hook_node_access_records().
217 * @param \Drupal\node\NodeInterface $node
218 * The node for which the grants were acquired.
220 * @see hook_node_access_records()
221 * @see hook_node_grants()
222 * @see hook_node_grants_alter()
223 * @ingroup node_access
225 function hook_node_access_records_alter(&$grants, Drupal\node\NodeInterface $node) {
226 // Our module allows editors to mark specific articles with the 'is_preview'
227 // field. If the node being saved has a TRUE value for that field, then only
228 // our grants are retained, and other grants are removed. Doing so ensures
229 // that our rules are enforced no matter what priority other grants are given.
230 if ($node->is_preview) {
231 // Our module grants are set in $grants['example'].
232 $temp = $grants['example'];
233 // Now remove all module grants but our own.
234 $grants = ['example' => $temp];
239 * Alter user access rules when trying to view, edit or delete a node.
241 * Node access modules establish rules for user access to content.
242 * hook_node_grants() defines permissions for a user to view, edit or delete
243 * nodes by building a $grants array that indicates the permissions assigned to
244 * the user by each node access module. This hook is called to allow modules to
245 * modify the $grants array by reference, so the interaction of multiple node
246 * access modules can be altered or advanced business logic can be applied.
248 * The resulting grants are then checked against the records stored in the
249 * {node_access} table to determine if the operation may be completed.
251 * A module may deny all access to a user by setting $grants to an empty array.
253 * Developers may use this hook to either add additional grants to a user or to
254 * remove existing grants. These rules are typically based on either the
255 * permissions assigned to a user role, or specific attributes of a user
258 * @param array $grants
259 * The $grants array returned by hook_node_grants().
260 * @param \Drupal\Core\Session\AccountInterface $account
261 * The account requesting access to content.
263 * The operation being performed, 'view', 'update' or 'delete'.
265 * @see hook_node_grants()
266 * @see hook_node_access_records()
267 * @see hook_node_access_records_alter()
268 * @ingroup node_access
270 function hook_node_grants_alter(&$grants, \Drupal\Core\Session\AccountInterface $account, $op) {
271 // Our sample module never allows certain roles to edit or delete
272 // content. Since some other node access modules might allow this
273 // permission, we expressly remove it by returning an empty $grants
274 // array for roles specified in our variable setting.
276 // Get our list of banned roles.
277 $restricted = \Drupal::config('example.settings')->get('restricted_roles');
279 if ($op != 'view' && !empty($restricted)) {
280 // Now check the roles for this account against the restrictions.
281 foreach ($account->getRoles() as $rid) {
282 if (in_array($rid, $restricted)) {
290 * Controls access to a node.
292 * Modules may implement this hook if they want to have a say in whether or not
293 * a given user has access to perform a given operation on a node.
295 * The administrative account (user ID #1) always passes any access check, so
296 * this hook is not called in that case. Users with the "bypass node access"
297 * permission may always view and edit content through the administrative
300 * Note that not all modules will want to influence access on all node types. If
301 * your module does not want to explicitly allow or forbid access, return an
302 * AccessResultInterface object with neither isAllowed() nor isForbidden()
303 * equaling TRUE. Blindly returning an object with isForbidden() equaling TRUE
304 * will break other node access modules.
306 * Also note that this function isn't called for node listings (e.g., RSS feeds,
307 * the default home page at path 'node', a recent content block, etc.) See
308 * @link node_access Node access rights @endlink for a full explanation.
310 * @param \Drupal\node\NodeInterface|string $node
311 * Either a node entity or the machine name of the content type on which to
312 * perform the access check.
314 * The operation to be performed. Possible values:
319 * @param \Drupal\Core\Session\AccountInterface $account
320 * The user object to perform the access check operation on.
322 * @return \Drupal\Core\Access\AccessResultInterface
325 * @ingroup node_access
327 function hook_node_access(\Drupal\node\NodeInterface $node, $op, \Drupal\Core\Session\AccountInterface $account) {
328 $type = $node->bundle();
332 return AccessResult::allowedIfHasPermission($account, 'create ' . $type . ' content');
335 if ($account->hasPermission('edit any ' . $type . ' content', $account)) {
336 return AccessResult::allowed()->cachePerPermissions();
339 return AccessResult::allowedIf($account->hasPermission('edit own ' . $type . ' content', $account) && ($account->id() == $node->getOwnerId()))->cachePerPermissions()->cachePerUser()->addCacheableDependency($node);
343 if ($account->hasPermission('delete any ' . $type . ' content', $account)) {
344 return AccessResult::allowed()->cachePerPermissions();
347 return AccessResult::allowedIf($account->hasPermission('delete own ' . $type . ' content', $account) && ($account->id() == $node->getOwnerId()))->cachePerPermissions()->cachePerUser()->addCacheableDependency($node);
352 return AccessResult::neutral();
357 * Act on a node being displayed as a search result.
359 * This hook is invoked from the node search plugin during search execution,
360 * after loading and rendering the node.
362 * @param \Drupal\node\NodeInterface $node
363 * The node being displayed in a search result.
366 * Extra information to be displayed with search result. This information
367 * should be presented as an associative array. It will be concatenated with
368 * the post information (last updated, author) in the default search result
371 * @see template_preprocess_search_result()
372 * @see search-result.html.twig
374 * @ingroup entity_crud
376 function hook_node_search_result(\Drupal\node\NodeInterface $node) {
377 $rating = db_query('SELECT SUM(points) FROM {my_rating} WHERE nid = :nid', ['nid' => $node->id()])->fetchField();
378 return ['rating' => \Drupal::translation()->formatPlural($rating, '1 point', '@count points')];
382 * Act on a node being indexed for searching.
384 * This hook is invoked during search indexing, after loading, and after the
385 * result of rendering is added as $node->rendered to the node object.
387 * @param \Drupal\node\NodeInterface $node
388 * The node being indexed.
391 * Additional node information to be indexed.
393 * @ingroup entity_crud
395 function hook_node_update_index(\Drupal\node\NodeInterface $node) {
397 $ratings = db_query('SELECT title, description FROM {my_ratings} WHERE nid = :nid', [':nid' => $node->id()]);
398 foreach ($ratings as $rating) {
399 $text .= '<h2>' . Html::escape($rating->title) . '</h2>' . Xss::filter($rating->description);
405 * Provide additional methods of scoring for core search results for nodes.
407 * A node's search score is used to rank it among other nodes matched by the
408 * search, with the highest-ranked nodes appearing first in the search listing.
410 * For example, a module allowing users to vote on content could expose an
411 * option to allow search results' rankings to be influenced by the average
412 * voting score of a node.
414 * All scoring mechanisms are provided as options to site administrators, and
415 * may be tweaked based on individual sites or disabled altogether if they do
416 * not make sense. Individual scoring mechanisms, if enabled, are assigned a
417 * weight from 1 to 10. The weight represents the factor of magnification of
418 * the ranking mechanism, with higher-weighted ranking mechanisms having more
419 * influence. In order for the weight system to work, each scoring mechanism
420 * must return a value between 0 and 1 for every node. That value is then
421 * multiplied by the administrator-assigned weight for the ranking mechanism,
422 * and then the weighted scores from all ranking mechanisms are added, which
423 * brings about the same result as a weighted average.
426 * An associative array of ranking data. The keys should be strings,
427 * corresponding to the internal name of the ranking mechanism, such as
428 * 'recent', or 'comments'. The values should be arrays themselves, with the
429 * following keys available:
430 * - title: (required) The human readable name of the ranking mechanism.
431 * - join: (optional) An array with information to join any additional
432 * necessary table. This is not necessary if the table required is already
433 * joined to by the base query, such as for the {node} table. Other tables
434 * should use the full table name as an alias to avoid naming collisions.
435 * - score: (required) The part of a query string to calculate the score for
436 * the ranking mechanism based on values in the database. This does not need
437 * to be wrapped in parentheses, as it will be done automatically; it also
438 * does not need to take the weighted system into account, as it will be
439 * done automatically. It does, however, need to calculate a decimal between
440 * 0 and 1; be careful not to cast the entire score to an integer by
441 * inadvertently introducing a variable argument.
442 * - arguments: (optional) If any arguments are required for the score, they
443 * can be specified in an array here.
445 * @ingroup entity_crud
447 function hook_ranking() {
448 // If voting is disabled, we can avoid returning the array, no hard feelings.
449 if (\Drupal::config('vote.settings')->get('node_enabled')) {
452 'title' => t('Average vote'),
453 // Note that we use i.sid, the search index's search item id, rather than
457 'table' => 'vote_node_data',
458 'alias' => 'vote_node_data',
459 'on' => 'vote_node_data.nid = i.sid',
461 // The highest possible score should be 1, and the lowest possible score,
462 // always 0, should be 0.
463 'score' => 'vote_node_data.average / CAST(%f AS DECIMAL)',
464 // Pass in the highest possible voting score as a decimal argument.
465 'arguments' => [\Drupal::config('vote.settings')->get('score_max')],
472 * Alter the links of a node.
474 * @param array &$links
475 * A renderable array representing the node links.
476 * @param \Drupal\node\NodeInterface $entity
477 * The node being rendered.
478 * @param array &$context
479 * Various aspects of the context in which the node links are going to be
480 * displayed, with the following keys:
481 * - 'view_mode': the view mode in which the node is being viewed
482 * - 'langcode': the language in which the node is being viewed
484 * @see \Drupal\node\NodeViewBuilder::renderLinks()
485 * @see \Drupal\node\NodeViewBuilder::buildLinks()
488 function hook_node_links_alter(array &$links, NodeInterface $entity, array &$context) {
489 $links['mymodule'] = [
490 '#theme' => 'links__node__mymodule',
491 '#attributes' => ['class' => ['links', 'inline']],
494 'title' => t('Report'),
495 'url' => Url::fromRoute('node_test.report', ['node' => $entity->id()], ['query' => ['token' => \Drupal::getContainer()->get('csrf_token')->get("node/{$entity->id()}/report")]]),
502 * @} End of "addtogroup hooks".