diff --git a/core/includes/bootstrap.inc b/core/includes/bootstrap.inc index 27d9576..20df411 100644 --- a/core/includes/bootstrap.inc +++ b/core/includes/bootstrap.inc @@ -394,7 +394,7 @@ function _drupal_set_preferred_header_name($name = NULL) { * variable text such as user names or link URLs into translated text. Variable * substitution looks like this: * @code - * $text = t("@name's blog", array('@name' => user_format_name($account))); + * $text = t("@name's blog", array('@name' => $account->getDisplayName())); * @endcode * Basically, you can put variables like @name into your string, and t() will * substitute their sanitized values at translation time. (See the diff --git a/core/lib/Drupal/Core/Session/AccountInterface.php b/core/lib/Drupal/Core/Session/AccountInterface.php index 7bef0ac..ce1b38c 100644 --- a/core/lib/Drupal/Core/Session/AccountInterface.php +++ b/core/lib/Drupal/Core/Session/AccountInterface.php @@ -130,7 +130,17 @@ public function getPreferredLangcode($fallback_to_default = TRUE); public function getPreferredAdminLangcode($fallback_to_default = TRUE); /** - * Returns the username of this account. + * Returns the unique username of this account. + * + * @return string + * An unsanitized string with the unique username. The code receiving this + * result must ensure that \Drupal\Component\Utility\String::checkPlain() + * is called on it before it is printed to the page. + */ + public function getUsername(); + + /** + * Returns the display name of this account. * * By default, the passed-in object's 'name' property is used if it exists, or * else, the site-defined value for the 'anonymous' variable. However, a module @@ -139,13 +149,13 @@ public function getPreferredAdminLangcode($fallback_to_default = TRUE); * * @see hook_user_format_name_alter() * - * @return - * An unsanitized string with the username to display. The code receiving - * this result must ensure that \Drupal\Component\Utility\String::checkPlain() - * is called on it before it is - * printed to the page. + * @return string + * An unsanitized string with the user name to display. The code receiving + * this result must ensure that + * \Drupal\Component\Utility\String::checkPlain() is called on it before it + * is printed to the page or used in a template. */ - public function getUsername(); + public function getDisplayName(); /** * Returns the email address of this account. diff --git a/core/lib/Drupal/Core/Session/AccountProxy.php b/core/lib/Drupal/Core/Session/AccountProxy.php index 2aa8fa5..c7cad7a 100644 --- a/core/lib/Drupal/Core/Session/AccountProxy.php +++ b/core/lib/Drupal/Core/Session/AccountProxy.php @@ -169,6 +169,13 @@ public function getUsername() { /** * {@inheritdoc} */ + public function getDisplayName() { + return $this->getAccount()->getDisplayName(); + } + + /** + * {@inheritdoc} + */ public function getEmail() { return $this->getAccount()->getEmail(); } diff --git a/core/lib/Drupal/Core/Session/UserSession.php b/core/lib/Drupal/Core/Session/UserSession.php index 6181f24..48dc2f1 100644 --- a/core/lib/Drupal/Core/Session/UserSession.php +++ b/core/lib/Drupal/Core/Session/UserSession.php @@ -209,6 +209,13 @@ function getPreferredAdminLangcode($fallback_to_default = TRUE) { * {@inheritdoc} */ public function getUsername() { + return $this->name ?: ''; + } + + /** + * {@inheritdoc} + */ + public function getDisplayName() { $name = $this->name ?: \Drupal::config('user.settings')->get('anonymous'); \Drupal::moduleHandler()->alter('user_format_name', $name, $this); return $name; diff --git a/core/modules/action/src/Plugin/Action/EmailAction.php b/core/modules/action/src/Plugin/Action/EmailAction.php index e56a887..d31d239 100644 --- a/core/modules/action/src/Plugin/Action/EmailAction.php +++ b/core/modules/action/src/Plugin/Action/EmailAction.php @@ -185,7 +185,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta '#default_value' => $this->configuration['message'], '#cols' => '80', '#rows' => '20', - '#description' => t('The message that should be sent. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), + '#description' => t('The message that should be sent. You may include placeholders like [node:title], [user:display-name], [user:name] and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), ); return $form; } diff --git a/core/modules/action/src/Plugin/Action/MessageAction.php b/core/modules/action/src/Plugin/Action/MessageAction.php index c87b606..c8ddd4a 100644 --- a/core/modules/action/src/Plugin/Action/MessageAction.php +++ b/core/modules/action/src/Plugin/Action/MessageAction.php @@ -78,7 +78,7 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta '#default_value' => $this->configuration['message'], '#required' => TRUE, '#rows' => '8', - '#description' => t('The message to be displayed to the current user. You may include placeholders like [node:title], [user:name], and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), + '#description' => t('The message to be displayed to the current user. You may include placeholders like [node:title], [user:display-name], [user:name] and [comment:body] to represent data that will be different each time message is sent. Not all placeholders will be available in all contexts.'), ); return $form; } diff --git a/core/modules/comment/src/CommentForm.php b/core/modules/comment/src/CommentForm.php index 95629b2..9a5f136 100644 --- a/core/modules/comment/src/CommentForm.php +++ b/core/modules/comment/src/CommentForm.php @@ -212,6 +212,12 @@ public function form(array $form, FormStateInterface $form_state) { $form['#cache']['tags'] = Cache::mergeTags(isset($form['#cache']['tags']) ? $form['#cache']['tags'] : [], $config->getCacheTags()); + // Set the uid on new comments to the current user. + $form['uid'] = array( + '#type' => 'value', + '#value' => $comment->id() ? $comment->getOwnerId() : $this->currentUser->id(), + ); + return parent::form($form, $form_state, $comment); } @@ -269,7 +275,16 @@ public function buildEntity(array $form, FormStateInterface $form_state) { $uid = $account ? $account->id() : 0; $comment->setOwnerId($uid); } + } + + /** + * Overrides Drupal\Core\Entity\EntityForm::submit(). + */ + public function submit(array $form, array &$form_state) { + /** @var \Drupal\comment\CommentInterface $comment */ + $comment = parent::submit($form, $form_state); + $author_name = $comment->getAuthorName(); // If the comment was posted by an anonymous user and no author name was // required, use "Anonymous" by default. if ($comment->getOwnerId() === 0 && (!isset($author_name) || $author_name === '')) { diff --git a/core/modules/contact/src/Controller/ContactController.php b/core/modules/contact/src/Controller/ContactController.php index 648a064..bd66579 100644 --- a/core/modules/contact/src/Controller/ContactController.php +++ b/core/modules/contact/src/Controller/ContactController.php @@ -140,7 +140,7 @@ public function contactPersonalPage(UserInterface $user) { )); $form = $this->entityFormBuilder()->getForm($message); - $form['#title'] = $this->t('Contact @username', array('@username' => $user->getUsername())); + $form['#title'] = $this->t('Contact @username', array('@username' => $user->getDisplayName())); return $form; } diff --git a/core/modules/file/src/Tests/FileFieldPathTest.php b/core/modules/file/src/Tests/FileFieldPathTest.php index bf166ed..6bbf697 100644 --- a/core/modules/file/src/Tests/FileFieldPathTest.php +++ b/core/modules/file/src/Tests/FileFieldPathTest.php @@ -46,7 +46,7 @@ function testUploadPath() { // Check the path when used with tokens. // Change the path to contain multiple token directories. - $this->updateFileField($field_name, $type_name, array('file_directory' => '[current-user:uid]/[current-user:name]')); + $this->updateFileField($field_name, $type_name, array('file_directory' => '[current-user:uid]/[current-user:display-name]')); // Upload a new file into the token subdirectories. $nid = $this->uploadNodeFile($test_file, $field_name, $type_name); diff --git a/core/modules/file/src/Tests/FileTokenReplaceTest.php b/core/modules/file/src/Tests/FileTokenReplaceTest.php index 84d599f..37056f2 100644 --- a/core/modules/file/src/Tests/FileTokenReplaceTest.php +++ b/core/modules/file/src/Tests/FileTokenReplaceTest.php @@ -54,7 +54,7 @@ function testFileTokenReplacement() { $tests['[file:created:short]'] = format_date($file->getCreatedTime(), 'short', '', NULL, $language_interface->getId()); $tests['[file:changed]'] = format_date($file->getChangedTime(), 'medium', '', NULL, $language_interface->getId()); $tests['[file:changed:short]'] = format_date($file->getChangedTime(), 'short', '', NULL, $language_interface->getId()); - $tests['[file:owner]'] = String::checkPlain(user_format_name($this->admin_user)); + $tests['[file:owner]'] = String::checkPlain(user_format_name($this->admin_user->getDisplayName())); $tests['[file:owner:uid]'] = $file->getOwnerId(); // Test to make sure that we generated something for each token. diff --git a/core/modules/forum/forum.module b/core/modules/forum/forum.module index 2cf0c53..7729d8d 100644 --- a/core/modules/forum/forum.module +++ b/core/modules/forum/forum.module @@ -456,7 +456,7 @@ function template_preprocess_forums(&$variables) { } $forum_submitted = array('#theme' => 'forum_submitted', '#topic' => (object) array( 'uid' => $topic->getOwnerId(), - 'name' => $topic->getOwner()->getUsername(), + 'name' => $topic->getOwner()->getDisplayName(), 'created' => $topic->getCreatedTime(), )); $variables['topics'][$id]->submitted = drupal_render($forum_submitted); diff --git a/core/modules/node/src/Plugin/views/row/Rss.php b/core/modules/node/src/Plugin/views/row/Rss.php index 55d62a5..43a18c0 100644 --- a/core/modules/node/src/Plugin/views/row/Rss.php +++ b/core/modules/node/src/Plugin/views/row/Rss.php @@ -123,7 +123,7 @@ public function render($row) { ), array( 'key' => 'dc:creator', - 'value' => $node->getOwner()->getUsername(), + 'value' => $node->getOwner()->getDisplayName(), ), array( 'key' => 'guid', diff --git a/core/modules/rdf/rdf.module b/core/modules/rdf/rdf.module index 50b6f36..007cf16 100644 --- a/core/modules/rdf/rdf.module +++ b/core/modules/rdf/rdf.module @@ -362,7 +362,7 @@ function rdf_preprocess_user(&$variables) { '#attributes' => array( 'about' => $account->url(), 'property' => $name_mapping['properties'], - 'content' => $account->getUsername(), + 'content' => $account->getDisplayName(), 'lang' => '', ), ); diff --git a/core/modules/shortcut/src/Form/SwitchShortcutSet.php b/core/modules/shortcut/src/Form/SwitchShortcutSet.php index 0efa824..c4603f3 100644 --- a/core/modules/shortcut/src/Form/SwitchShortcutSet.php +++ b/core/modules/shortcut/src/Form/SwitchShortcutSet.php @@ -194,7 +194,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) { )); $set->save(); $replacements = array( - '%user' => $this->user->label(), + '%user' => $this->user->getDisplayName(), '%set_name' => $set->label(), '@switch-url' => $this->url($this->routeMatch->getRouteName(), array('user' => $this->user->id())), ); @@ -216,7 +216,7 @@ public function submitForm(array &$form, FormStateInterface $form_state) { /* @var \Drupal\shortcut\Entity\ShortcutSet $set */ $set = $this->shortcutSetStorage->load($form_state->getValue('set')); $replacements = array( - '%user' => $this->user->label(), + '%user' => $this->user->getDisplayName(), '%set_name' => $set->label(), ); drupal_set_message($account_is_user ? $this->t('You are now using the %set_name shortcut set.', $replacements) : $this->t('%user is now using the %set_name shortcut set.', $replacements)); diff --git a/core/modules/system/system.api.php b/core/modules/system/system.api.php index b0eadb5..88bd1a1 100644 --- a/core/modules/system/system.api.php +++ b/core/modules/system/system.api.php @@ -16,6 +16,1296 @@ */ /** + * Defines one or more hooks that are exposed by a module. + * + * Normally hooks do not need to be explicitly defined. However, by declaring a + * hook explicitly, a module may define a "group" for it. Modules that implement + * a hook may then place their implementation in either $module.module or in + * $module.$group.inc. If the hook is located in $module.$group.inc, then that + * file will be automatically loaded when needed. + * In general, hooks that are rarely invoked and/or are very large should be + * placed in a separate include file, while hooks that are very short or very + * frequently called should be left in the main module file so that they are + * always available. + * + * @return + * An associative array whose keys are hook names and whose values are an + * associative array containing: + * - group: A string defining the group to which the hook belongs. The module + * system will determine whether a file with the name $module.$group.inc + * exists, and automatically load it when required. + * + * See system_hook_info() for all hook groups defined by Drupal core. + * + * @see hook_hook_info_alter(). + */ +function hook_hook_info() { + $hooks['token_info'] = array( + 'group' => 'tokens', + ); + $hooks['tokens'] = array( + 'group' => 'tokens', + ); + return $hooks; +} + +/** + * Perform periodic actions. + * + * Modules that require some commands to be executed periodically can + * implement hook_cron(). The engine will then call the hook whenever a cron + * run happens, as defined by the administrator. Typical tasks managed by + * hook_cron() are database maintenance, backups, recalculation of settings + * or parameters, automated mailing, and retrieving remote data. + * + * Short-running or non-resource-intensive tasks can be executed directly in + * the hook_cron() implementation. + * + * Long-running tasks and tasks that could time out, such as retrieving remote + * data, sending email, and intensive file tasks, should use the queue API + * instead of executing the tasks directly. To do this, first define one or + * more queues via hook_queue_info(). Then, add items that need to be + * processed to the defined queues. + */ +function hook_cron() { + // Short-running operation example, not using a queue: + // Delete all expired records since the last cron run. + $expires = \Drupal::state()->get('mymodule.cron_last_run', REQUEST_TIME); + db_delete('mymodule_table') + ->condition('expires', $expires, '>=') + ->execute(); + \Drupal::state()->set('mymodule.cron_last_run', REQUEST_TIME); + + // Long-running operation example, leveraging a queue: + // Fetch feeds from other sites. + $result = db_query('SELECT * FROM {aggregator_feed} WHERE checked + refresh < :time AND refresh <> :never', array( + ':time' => REQUEST_TIME, + ':never' => AGGREGATOR_CLEAR_NEVER, + )); + $queue = \Drupal::queue('aggregator_feeds'); + foreach ($result as $feed) { + $queue->createItem($feed); + } +} + +/** + * Alter available data types for typed data wrappers. + * + * @param array $data_types + * An array of data type information. + * + * @see hook_data_type_info() + */ +function hook_data_type_info_alter(&$data_types) { + $data_types['email']['class'] = '\Drupal\mymodule\Type\Email'; +} + +/** + * Declare queues holding items that need to be run periodically. + * + * While there can be only one hook_cron() process running at the same time, + * there can be any number of processes defined here running. Because of + * this, long running tasks are much better suited for this API. Items queued + * in hook_cron() might be processed in the same cron run if there are not many + * items in the queue, otherwise it might take several requests, which can be + * run in parallel. + * + * You can create queues, add items to them, claim them, etc without declaring + * the queue in this hook if you want, however, you need to take care of + * processing the items in the queue in that case. + * + * @return + * An associative array where the key is the queue name and the value is + * again an associative array. Possible keys are: + * - 'worker callback': A PHP callable to call that is an implementation of + * callback_queue_worker(). + * - 'cron': (optional) An associative array containing the optional key: + * - 'time': (optional) How much time Drupal cron should spend on calling + * this worker in seconds. Defaults to 15. + * If the cron key is not defined, the queue will not be processed by cron, + * and must be processed by other means. + * + * @see hook_cron() + * @see hook_queue_info_alter() + */ +function hook_queue_info() { + $queues['aggregator_feeds'] = array( + 'title' => t('Aggregator refresh'), + 'worker callback' => array('Drupal\my_module\MyClass', 'aggregatorRefresh'), + // Only needed if this queue should be processed by cron. + 'cron' => array( + 'time' => 60, + ), + ); + return $queues; +} + +/** + * Alter cron queue information before cron runs. + * + * Called by \Drupal\Core\Cron to allow modules to alter cron queue settings + * before any jobs are processesed. + * + * @param array $queues + * An array of cron queue information. + * + * @see hook_queue_info() + * @see \Drupal\Core\Cron + */ +function hook_queue_info_alter(&$queues) { + // This site has many feeds so let's spend 90 seconds on each cron run + // updating feeds instead of the default 60. + $queues['aggregator_feeds']['cron']['time'] = 90; +} + +/** + * Work on a single queue item. + * + * Callback for hook_queue_info(). + * + * @param $queue_item_data + * The data that was passed to \Drupal\Core\Queue\QueueInterface::createItem() + * when the item was queued. + * + * @throws \Exception + * The worker callback may throw an exception to indicate there was a problem. + * The cron process will log the exception, and leave the item in the queue to + * be processed again later. + * @throws \Drupal\Core\Queue\SuspendQueueException + * More specifically, a SuspendQueueException should be thrown when the + * callback is aware that the problem will affect all subsequent workers of + * its queue. For example, a callback that makes HTTP requests may find that + * the remote server is not responding. The cron process will behave as with a + * normal Exception, and in addition will not attempt to process further items + * from the current item's queue during the current cron run. + * + * @see \Drupal\Core\Cron::run() + */ +function callback_queue_worker($queue_item_data) { + $node = node_load($queue_item_data); + $node->title = 'Updated title'; + $node->save(); +} + +/** + * Allows modules to declare their own Form API element types and specify their + * default values. + * + * This hook allows modules to declare their own form element types and to + * specify their default values. The values returned by this hook will be + * merged with the elements returned by form constructor implementations and so + * can return defaults for any Form APIs keys in addition to those explicitly + * documented by \Drupal\Core\Render\ElementInfoInterface::getInfo(). + * + * @return array + * An associative array with structure identical to that of the return value + * of \Drupal\Core\Render\ElementInfoInterface::getInfo(). + * + * @see hook_element_info_alter() + * @see system_element_info() + */ +function hook_element_info() { + $types['filter_format'] = array( + '#input' => TRUE, + ); + return $types; +} + +/** + * Alter the element type information returned from modules. + * + * A module may implement this hook in order to alter the element type defaults + * defined by a module. + * + * @param array $types + * An associative array with structure identical to that of the return value + * of \Drupal\Core\Render\ElementInfoInterface::getInfo(). + * + * @see hook_element_info() + */ +function hook_element_info_alter(array &$types) { + // Decrease the default size of textfields. + if (isset($types['textfield']['#size'])) { + $types['textfield']['#size'] = 40; + } +} + +/** + * Perform necessary alterations to the JavaScript before it is presented on + * the page. + * + * @param $javascript + * An array of all JavaScript being presented on the page. + * + * @see _drupal_add_js() + * @see drupal_get_js() + * @see drupal_js_defaults() + */ +function hook_js_alter(&$javascript) { + // Swap out jQuery to use an updated version of the library. + $javascript['core/assets/vendor/jquery/jquery.js']['data'] = drupal_get_path('module', 'jquery_update') . '/jquery.js'; +} + +/** + * Alters the JavaScript/CSS library registry. + * + * Allows certain, contributed modules to update libraries to newer versions + * while ensuring backwards compatibility. In general, such manipulations should + * only be done by designated modules, since most modules that integrate with a + * certain library also depend on the API of a certain library version. + * + * @param $libraries + * The JavaScript/CSS libraries provided by $module. Keyed by internal library + * name and passed by reference. + * @param $module + * The name of the module that registered the libraries. + */ +function hook_library_info_alter(&$libraries, $module) { + // Update Farbtastic to version 2.0. + if ($module == 'core' && isset($libraries['jquery.farbtastic'])) { + // Verify existing version is older than the one we are updating to. + if (version_compare($libraries['jquery.farbtastic']['version'], '2.0', '<')) { + // Update the existing Farbtastic to version 2.0. + $libraries['jquery.farbtastic']['version'] = '2.0'; + // To accurately replace library files, the order of files and the options + // of each file have to be retained; e.g., like this: + $old_path = 'assets/vendor/farbtastic'; + // Since the replaced library files are no longer located in a directory + // relative to the original extension, specify an absolute path (relative + // to DRUPAL_ROOT / base_path()) to the new location. + $new_path = '/' . drupal_get_path('module', 'farbtastic_update') . '/js'; + $new_js = array(); + $replacements = array( + $old_path . '/farbtastic.js' => $new_path . '/farbtastic-2.0.js', + ); + foreach ($libraries['jquery.farbtastic']['js'] as $source => $options) { + if (isset($replacements[$source])) { + $new_js[$replacements[$source]] = $options; + } + else { + $new_js[$source] = $options; + } + } + $libraries['jquery.farbtastic']['js'] = $new_js; + } + } +} + +/** + * Alters a JavaScript/CSS library before it is attached. + * + * Allows modules and themes to dynamically attach further assets to a library + * when it is added to the page; e.g., to add JavaScript settings. + * + * This hook is only invoked once per library and page. + * + * @param array $library + * The JavaScript/CSS library that is being added. + * @param string $name + * The name of the library. + * + * @see _drupal_add_library() + */ +function hook_library_alter(array &$library, $name) { + if ($name == 'core/jquery.ui.datepicker') { + // Note: If the added assets do not depend on additional request-specific + // data supplied here, consider to statically register it directly via + // hook_library_info_alter() already. + $library['dependencies'][] = 'locale/drupal.locale.datepicker'; + + $language_interface = \Drupal::languageManager()->getCurrentLanguage(); + $settings['jquery']['ui']['datepicker'] = array( + 'isRTL' => $language_interface->direction == LanguageInterface::DIRECTION_RTL, + 'firstDay' => \Drupal::config('system.date')->get('first_day'), + ); + $library['js'][] = array( + 'type' => 'setting', + 'data' => $settings, + ); + } +} + +/** + * Alter CSS files before they are output on the page. + * + * @param $css + * An array of all CSS items (files and inline CSS) being requested on the page. + * + * @see _drupal_add_css() + * @see drupal_get_css() + */ +function hook_css_alter(&$css) { + // Remove defaults.css file. + unset($css[drupal_get_path('module', 'system') . '/defaults.css']); +} + +/** + * Alter the Ajax command data that is sent to the client. + * + * @param \Drupal\Core\Ajax\CommandInterface[] $data + * An array of all the rendered commands that will be sent to the client. + * + * @see \Drupal\Core\Ajax\AjaxResponse::ajaxRender() + */ +function hook_ajax_render_alter(array &$data) { + // Inject any new status messages into the content area. + $status_messages = array('#theme' => 'status_messages'); + $command = new \Drupal\Core\Ajax\PrependCommand('#block-system-main .content', drupal_render($status_messages)); + $data[] = $command->render(); +} + +/** + * Add elements to a page before it is rendered. + * + * Use this hook when you want to add elements at the page level. For your + * additions to be printed, they have to be placed below a top level array key + * of the $page array that has the name of a region of the active theme. + * + * By default, valid region keys are 'page_top', 'header', 'sidebar_first', + * 'content', 'sidebar_second' and 'page_bottom'. To get a list of all regions + * of the active theme, use system_region_list($theme). Note that $theme is a + * global variable. + * + * If you want to alter the elements added by other modules or if your module + * depends on the elements of other modules, use hook_page_alter() instead which + * runs after this hook. + * + * @param $page + * Nested array of renderable elements that make up the page. + * + * @see hook_page_alter() + * @see drupal_render_page() + */ +function hook_page_build(&$page) { + $path = drupal_get_path('module', 'foo'); + // Add JavaScript/CSS assets to all pages. + // @see drupal_process_attached() + $page['#attached']['js'][$path . '/foo.js'] = array('every_page' => TRUE); + $page['#attached']['css'][$path . '/foo.base.css'] = array('every_page' => TRUE); + $page['#attached']['css'][$path . '/foo.theme.css'] = array('every_page' => TRUE); + + // Add a special CSS file to a certain page only. + if (drupal_is_front_page()) { + $page['#attached']['css'][] = $path . '/foo.front.css'; + } + + // Append a standard disclaimer to the content region on a node detail page. + if (\Drupal::request()->attributes->get('node')) { + $page['content']['disclaimer'] = array( + '#markup' => t('Acme, Inc. is not responsible for the contents of this sample code.'), + '#weight' => 25, + ); + } +} + +/** + * Alter links for menus. + * + * @param array $links + * The link definitions to be altered. + * + * @return array + * An array of default menu links. Each link has a key that is the machine + * name, which must be unique. By default, use the route name as the + * machine name. In cases where multiple links use the same route name, such + * as two links to the same page in different menus, or two links using the + * same route name but different route parameters, the suggested machine name + * patten is the route name followed by a dot and a unique suffix. For + * example, an additional logout link might have a machine name of + * user.logout.navigation, and default links provided to edit the article and + * page content types could use machine names node.type_edit.article and + * node.type_edit.page. Since the machine name may be arbitrary, you should + * never write code that assumes it is identical to the route name. + * + * The value corresponding to each machine name key is an associative array + * that may contain the following key-value pairs: + * - title: (required) The untranslated title of the menu link. + * - description: The untranslated description of the link. + * - route_name: (optional) The route name to be used to build the path. + * Either a route_name or a link_path must be provided. + * - route_parameters: (optional) The route parameters to build the path. + * - link_path: (optional) If you have an external link use link_path instead + * of providing a route_name. + * - parent: (optional) The machine name of the link that is this link's menu + * parent. + * - weight: (optional) An integer that determines the relative position of + * items in the menu; higher-weighted items sink. Defaults to 0. Menu items + * with the same weight are ordered alphabetically. + * - menu_name: (optional) The machine name of a menu to put the link in, if + * not the default Tools menu. + * - expanded: (optional) If set to TRUE, and if a menu link is provided for + * this menu item (as a result of other properties), then the menu link is + * always expanded, equivalent to its 'always expanded' checkbox being set + * in the UI. + * - options: (optional) An array of options to be passed to l() when + * generating a link from this menu item. + * + * @ingroup menu + */ +function hook_menu_link_defaults_alter(&$links) { + // Change the weight and title of the user.logout link. + $links['user.logout']['weight'] = -10; + $links['user.logout']['title'] = 'Logout'; +} + +/** + * Alter tabs and actions displayed on the page before they are rendered. + * + * This hook is invoked by menu_local_tasks(). The system-determined tabs and + * actions are passed in by reference. Additional tabs or actions may be added. + * + * Each tab or action is an associative array containing: + * - #theme: The theme function to use to render. + * - #link: An associative array containing: + * - title: The localized title of the link. + * - href: The system path to link to. + * - localized_options: An array of options to pass to l(). + * - #weight: The link's weight compared to other links. + * - #active: Whether the link should be marked as 'active'. + * + * @param array $data + * An associative array containing: + * - actions: A list of of actions keyed by their href, each one being an + * associative array as described above. + * - tabs: A list of (up to 2) tab levels that contain a list of of tabs keyed + * by their href, each one being an associative array as described above. + * @param string $route_name + * The route name of the page. + */ +function hook_menu_local_tasks(&$data, $route_name) { + // Add an action linking to node/add to all pages. + $data['actions']['node/add'] = array( + '#theme' => 'menu_local_action', + '#link' => array( + 'title' => t('Add content'), + 'href' => 'node/add', + 'localized_options' => array( + 'attributes' => array( + 'title' => t('Add content'), + ), + ), + ), + ); + + // Add a tab linking to node/add to all pages. + $data['tabs'][0]['node/add'] = array( + '#theme' => 'menu_local_task', + '#link' => array( + 'title' => t('Example tab'), + 'href' => 'node/add', + 'localized_options' => array( + 'attributes' => array( + 'title' => t('Add content'), + ), + ), + ), + ); +} + +/** + * Alter tabs and actions displayed on the page before they are rendered. + * + * This hook is invoked by menu_local_tasks(). The system-determined tabs and + * actions are passed in by reference. Existing tabs or actions may be altered. + * + * @param array $data + * An associative array containing tabs and actions. See + * hook_menu_local_tasks() for details. + * @param string $route_name + * The route name of the page. + * + * @see hook_menu_local_tasks() + * + * @ingroup menu + */ +function hook_menu_local_tasks_alter(&$data, $route_name) { +} + +/** + * Alter local actions plugins. + * + * @param array $local_actions + * The array of local action plugin definitions, keyed by plugin ID. + * + * @see \Drupal\Core\Menu\LocalActionInterface + * @see \Drupal\Core\Menu\LocalActionManager + * + * @ingroup menu + */ +function hook_menu_local_actions_alter(&$local_actions) { +} + +/** + * Alter local tasks plugins. + * + * @param array $local_tasks + * The array of local tasks plugin definitions, keyed by plugin ID. + * + * @see \Drupal\Core\Menu\LocalTaskInterface + * @see \Drupal\Core\Menu\LocalTaskManager + */ +function hook_local_tasks_alter(&$local_tasks) { + // Remove a specified local task plugin. + unset($local_tasks['example_plugin_id']); +} + +/** + * Alter contextual links before they are rendered. + * + * This hook is invoked by + * \Drupal\Core\Menu\ContextualLinkManager::getContextualLinkPluginsByGroup(). + * The system-determined contextual links are passed in by reference. Additional + * links may be added and existing links can be altered. + * + * Each contextual link contains the following entries: + * - title: The localized title of the link. + * - route_name: The route name of the link. + * - route_parameters: The route parameters of the link. + * - localized_options: An array of options to pass to url(). + * - (optional) weight: The weight of the link, which is used to sort the links. + * + * + * @param array $links + * An associative array containing contextual links for the given $group, + * as described above. The array keys are used to build CSS class names for + * contextual links and must therefore be unique for each set of contextual + * links. + * @param string $group + * The group of contextual links being rendered. + * @param array $route_parameters. + * The route parameters passed to each route_name of the contextual links. + * For example: + * @code + * array('node' => $node->id()) + * @endcode + * + * @see \Drupal\Core\Menu\ContextualLinkManager + * + * @ingroup menu + */ +function hook_contextual_links_alter(array &$links, $group, array $route_parameters) { + if ($group == 'menu') { + // Dynamically use the menu name for the title of the menu_edit contextual + // link. + $menu = \Drupal::entityManager()->getStorage('menu')->load($route_parameters['menu']); + $links['menu_edit']['title'] = t('Edit menu: !label', array('!label' => $menu->label())); + } +} + +/** + * Alter the plugin definition of contextual links. + * + * @param array $contextual_links + * An array of contextual_links plugin definitions, keyed by contextual link + * ID. Each entry contains the following keys: + * - title: The displayed title of the link + * - route_name: The route_name of the contextual link to be displayed + * - group: The group under which the contextual links should be added to. + * Possible values are e.g. 'node' or 'menu'. + * + * @see \Drupal\Core\Menu\ContextualLinkManager + */ +function hook_contextual_links_plugins_alter(array &$contextual_links) { + $contextual_links['menu_edit']['title'] = 'Edit the menu'; +} + +/** + * Perform alterations before a page is rendered. + * + * Use this hook when you want to remove or alter elements at the page + * level, or add elements at the page level that depend on an other module's + * elements (this hook runs after hook_page_build(). + * + * If you are making changes to entities such as forms, menus, or user + * profiles, use those objects' native alter hooks instead (hook_form_alter(), + * for example). + * + * The $page array contains top level elements for each block region: + * @code + * $page['page_top'] + * $page['header'] + * $page['sidebar_first'] + * $page['content'] + * $page['sidebar_second'] + * $page['page_bottom'] + * @endcode + * + * The 'content' element contains the main content of the current page, and its + * structure will vary depending on what module is responsible for building the + * page. Some legacy modules may not return structured content at all: their + * pre-rendered markup will be located in $page['content']['main']['#markup']. + * + * Pages built by Drupal's core Node module use a standard structure: + * + * @code + * // Node body. + * $page['content']['system_main']['nodes'][$nid]['body'] + * // Array of links attached to the node (add comments, read more). + * $page['content']['system_main']['nodes'][$nid]['links'] + * // The node entity itself. + * $page['content']['system_main']['nodes'][$nid]['#node'] + * // The results pager. + * $page['content']['system_main']['pager'] + * @endcode + * + * Blocks may be referenced by their module/delta pair within a region: + * @code + * // The login block in the first sidebar region. + * $page['sidebar_first']['user_login']['#block']; + * @endcode + * + * @param $page + * Nested array of renderable elements that make up the page. + * + * @see hook_page_build() + * @see drupal_render_page() + */ +function hook_page_alter(&$page) { + // Add help text to the user login block. + $page['sidebar_first']['user_login']['help'] = array( + '#weight' => -10, + '#markup' => t('To post comments or add content, you first have to log in.'), + ); +} + +/** + * Perform alterations before a form is rendered. + * + * One popular use of this hook is to add form elements to the node form. When + * altering a node form, the node entity can be retrieved by invoking + * $form_state['controller']->getEntity(). + * + * In addition to hook_form_alter(), which is called for all forms, there are + * two more specific form hooks available. The first, + * hook_form_BASE_FORM_ID_alter(), allows targeting of a form/forms via a base + * form (if one exists). The second, hook_form_FORM_ID_alter(), can be used to + * target a specific form directly. + * + * The call order is as follows: all existing form alter functions are called + * for module A, then all for module B, etc., followed by all for any base + * theme(s), and finally for the theme itself. The module order is determined + * by system weight, then by module name. + * + * Within each module, form alter hooks are called in the following order: + * first, hook_form_alter(); second, hook_form_BASE_FORM_ID_alter(); third, + * hook_form_FORM_ID_alter(). So, for each module, the more general hooks are + * called first followed by the more specific. + * + * @param $form + * Nested array of form elements that comprise the form. + * @param $form_state + * A keyed array containing the current state of the form. The arguments + * that \Drupal::formBuilder()->getForm() was originally called with are + * available in the array $form_state['build_info']['args']. + * @param $form_id + * String representing the name of the form itself. Typically this is the + * name of the function that generated the form. + * + * @see hook_form_BASE_FORM_ID_alter() + * @see hook_form_FORM_ID_alter() + * @see forms_api_reference.html + */ +function hook_form_alter(&$form, &$form_state, $form_id) { + if (isset($form['type']) && $form['type']['#value'] . '_node_settings' == $form_id) { + $upload_enabled_types = \Drupal::config('mymodule.settings')->get('upload_enabled_types'); + $form['workflow']['upload_' . $form['type']['#value']] = array( + '#type' => 'radios', + '#title' => t('Attachments'), + '#default_value' => in_array($form['type']['#value'], $upload_enabled_types) ? 1 : 0, + '#options' => array(t('Disabled'), t('Enabled')), + ); + // Add a custom submit handler to save the array of types back to the config file. + $form['actions']['submit']['#submit'][] = 'mymodule_upload_enabled_types_submit'; + } +} + +/** + * Provide a form-specific alteration instead of the global hook_form_alter(). + * + * Modules can implement hook_form_FORM_ID_alter() to modify a specific form, + * rather than implementing hook_form_alter() and checking the form ID, or + * using long switch statements to alter multiple forms. + * + * Form alter hooks are called in the following order: hook_form_alter(), + * hook_form_BASE_FORM_ID_alter(), hook_form_FORM_ID_alter(). See + * hook_form_alter() for more details. + * + * @param $form + * Nested array of form elements that comprise the form. + * @param $form_state + * A keyed array containing the current state of the form. The arguments + * that \Drupal::formBuilder()->getForm() was originally called with are + * available in the array $form_state['build_info']['args']. + * @param $form_id + * String representing the name of the form itself. Typically this is the + * name of the function that generated the form. + * + * @see hook_form_alter() + * @see hook_form_BASE_FORM_ID_alter() + * @see \Drupal\Core\Form\FormBuilderInterface::prepareForm() + * @see forms_api_reference.html + */ +function hook_form_FORM_ID_alter(&$form, &$form_state, $form_id) { + // Modification for the form with the given form ID goes here. For example, if + // FORM_ID is "user_register_form" this code would run only on the user + // registration form. + + // Add a checkbox to registration form about agreeing to terms of use. + $form['terms_of_use'] = array( + '#type' => 'checkbox', + '#title' => t("I agree with the website's terms and conditions."), + '#required' => TRUE, + ); +} + +/** + * Provide a form-specific alteration for shared ('base') forms. + * + * By default, when \Drupal::formBuilder()->getForm() is called, Drupal looks + * for a function with the same name as the form ID, and uses that function to + * build the form. In contrast, base forms allow multiple form IDs to be mapped + * to a single base (also called 'factory') form function. + * + * Modules can implement hook_form_BASE_FORM_ID_alter() to modify a specific + * base form, rather than implementing hook_form_alter() and checking for + * conditions that would identify the shared form constructor. + * + * To identify the base form ID for a particular form (or to determine whether + * one exists) check the $form_state. The base form ID is stored under + * $form_state['build_info']['base_form_id']. + * + * Form alter hooks are called in the following order: hook_form_alter(), + * hook_form_BASE_FORM_ID_alter(), hook_form_FORM_ID_alter(). See + * hook_form_alter() for more details. + * + * @param $form + * Nested array of form elements that comprise the form. + * @param $form_state + * A keyed array containing the current state of the form. + * @param $form_id + * String representing the name of the form itself. Typically this is the + * name of the function that generated the form. + * + * @see hook_form_alter() + * @see hook_form_FORM_ID_alter() + * @see \Drupal\Core\Form\FormBuilderInterface::prepareForm() + */ +function hook_form_BASE_FORM_ID_alter(&$form, &$form_state, $form_id) { + // Modification for the form with the given BASE_FORM_ID goes here. For + // example, if BASE_FORM_ID is "node_form", this code would run on every + // node form, regardless of node type. + + // Add a checkbox to the node form about agreeing to terms of use. + $form['terms_of_use'] = array( + '#type' => 'checkbox', + '#title' => t("I agree with the website's terms and conditions."), + '#required' => TRUE, + ); +} + +/** + * Alter an email message created with the drupal_mail() function. + * + * hook_mail_alter() allows modification of email messages created and sent + * with drupal_mail(). Usage examples include adding and/or changing message + * text, message fields, and message headers. + * + * Email messages sent using functions other than drupal_mail() will not + * invoke hook_mail_alter(). For example, a contributed module directly + * calling the drupal_mail_system()->mail() or PHP mail() function + * will not invoke this hook. All core modules use drupal_mail() for + * messaging, it is best practice but not mandatory in contributed modules. + * + * @param $message + * An array containing the message data. Keys in this array include: + * - 'id': + * The drupal_mail() id of the message. Look at module source code or + * drupal_mail() for possible id values. + * - 'to': + * The address or addresses the message will be sent to. The + * formatting of this string must comply with RFC 2822. + * - 'from': + * The address the message will be marked as being from, which is + * either a custom address or the site-wide default email address. + * - 'subject': + * Subject of the email to be sent. This must not contain any newline + * characters, or the email may not be sent properly. + * - 'body': + * An array of strings containing the message text. The message body is + * created by concatenating the individual array strings into a single text + * string using "\n\n" as a separator. + * - 'headers': + * Associative array containing mail headers, such as From, Sender, + * MIME-Version, Content-Type, etc. + * - 'params': + * An array of optional parameters supplied by the caller of drupal_mail() + * that is used to build the message before hook_mail_alter() is invoked. + * - 'language': + * The language object used to build the message before hook_mail_alter() + * is invoked. + * - 'send': + * Set to FALSE to abort sending this email message. + * + * @see drupal_mail() + */ +function hook_mail_alter(&$message) { + if ($message['id'] == 'modulename_messagekey') { + if (!example_notifications_optin($message['to'], $message['id'])) { + // If the recipient has opted to not receive such messages, cancel + // sending. + $message['send'] = FALSE; + return; + } + $message['body'][] = "--\nMail sent out from " . \Drupal::config('system.site')->get('name'); + } +} + +/** + * Alter the registry of modules implementing a hook. + * + * This hook is invoked during \Drupal::moduleHandler()->getImplementations(). + * A module may implement this hook in order to reorder the implementing + * modules, which are otherwise ordered by the module's system weight. + * + * Note that hooks invoked using \Drupal::moduleHandler->alter() can have + * multiple variations(such as hook_form_alter() and hook_form_FORM_ID_alter()). + * \Drupal::moduleHandler->alter() will call all such variants defined by a + * single module in turn. For the purposes of hook_module_implements_alter(), + * these variants are treated as a single hook. Thus, to ensure that your + * implementation of hook_form_FORM_ID_alter() is called at the right time, + * you will have to change the order of hook_form_alter() implementation in + * hook_module_implements_alter(). + * + * @param $implementations + * An array keyed by the module's name. The value of each item corresponds + * to a $group, which is usually FALSE, unless the implementation is in a + * file named $module.$group.inc. + * @param $hook + * The name of the module hook being implemented. + */ +function hook_module_implements_alter(&$implementations, $hook) { + if ($hook == 'rdf_mapping') { + // Move my_module_rdf_mapping() to the end of the list. + // \Drupal::moduleHandler()->getImplementations() + // iterates through $implementations with a foreach loop which PHP iterates + // in the order that the items were added, so to move an item to the end of + // the array, we remove it and then add it. + $group = $implementations['my_module']; + unset($implementations['my_module']); + $implementations['my_module'] = $group; + } +} + +/** + * Perform alterations to the breadcrumb built by the BreadcrumbManager. + * + * @param array $breadcrumb + * An array of breadcrumb link a tags, returned by the breadcrumb manager + * build method, for example + * @code + * array('Home'); + * @endcode + * @param \Drupal\Core\Routing\RouteMatchInterface $route_match + * The current route match. + * @param array $context + * May include the following key: + * - builder: the instance of + * \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface that constructed this + * breadcrumb, or NULL if no builder acted based on the current attributes. + */ +function hook_system_breadcrumb_alter(array &$breadcrumb, \Drupal\Core\Routing\RouteMatchInterface $route_match, array $context) { + // Add an item to the end of the breadcrumb. + $breadcrumb[] = Drupal::l(t('Text'), 'example_route_name'); +} + +/** + * Alter the information parsed from module and theme .info.yml files + * + * This hook is invoked in _system_rebuild_module_data() and in + * _system_rebuild_theme_data(). A module may implement this hook in order to + * add to or alter the data generated by reading the .info.yml file with + * \Drupal\Core\Extension\InfoParser. + * + * @param array $info + * The .info.yml file contents, passed by reference so that it can be altered. + * @param \Drupal\Core\Extension\Extension $file + * Full information about the module or theme. + * @param string $type + * Either 'module' or 'theme', depending on the type of .info.yml file that + * was passed. + */ +function hook_system_info_alter(array &$info, \Drupal\Core\Extension\Extension $file, $type) { + // Only fill this in if the .info.yml file does not define a 'datestamp'. + if (empty($info['datestamp'])) { + $info['datestamp'] = $file->getMTime(); + } +} + +/** + * Define user permissions. + * + * This hook can supply permissions that the module defines, so that they + * can be selected on the user permissions page and used to grant or restrict + * access to actions the module performs. + * + * Permissions are checked using \Drupal::currentUser()->hasPermission(). + * + * For a detailed usage example, see page_example.module. + * + * @return + * An array whose keys are permission names and whose corresponding values + * are arrays containing the following key-value pairs: + * - title: The human-readable name of the permission, to be shown on the + * permission administration page. This should be wrapped in the t() + * function so it can be translated. + * - description: (optional) A description of what the permission does. This + * should be wrapped in the t() function so it can be translated. + * - restrict access: (optional) A boolean which can be set to TRUE to + * indicate that site administrators should restrict access to this + * permission to trusted users. This should be used for permissions that + * have inherent security risks across a variety of potential use cases + * (for example, the "administer filters" and "bypass node access" + * permissions provided by Drupal core). When set to TRUE, a standard + * warning message defined in user_admin_permissions() will be displayed + * with the permission on the permission administration page. Defaults + * to FALSE. + * - warning: (optional) A translated warning message to display for this + * permission on the permission administration page. This warning overrides + * the automatic warning generated by 'restrict access' being set to TRUE. + * This should rarely be used, since it is important for all permissions to + * have a clear, consistent security warning that is the same across the + * site. Use the 'description' key instead to provide any information that + * is specific to the permission you are defining. + * + * @ingroup user_api + */ +function hook_permission() { + return array( + 'administer my module' => array( + 'title' => t('Administer my module'), + 'description' => t('Perform administration tasks for my module.'), + ), + ); +} + +/** + * Provide online user help. + * + * By implementing hook_help(), a module can make documentation available to + * the user for the module as a whole, or for specific pages. Help for + * developers should usually be provided via function header comments in the + * code, or in special API example files. + * + * The page-specific help information provided by this hook appears as a system + * help block on that page. The module overview help information is displayed + * by the Help module. It can be accessed from the page at admin/help or from + * the Extend page. + * + * For detailed usage examples of: + * - Module overview help, see content_translation_help(). Module overview + * help should follow + * @link https://drupal.org/node/632280 the standard help template. @endlink + * - Page-specific help using only routes, see book_help(). + * - Page-specific help using routes and $request, see block_help(). + * + * @param string $route_name + * For page-specific help, use the route name as identified in the + * module's routing.yml file. For module overview help, the route name + * will be in the form of "help.page.$modulename". + * @param Drupal\Core\Routing\RouteMatchInterface $route_match + * The current route match. This can be used to generate different help + * output for different pages that share the same route. + * + * @return string + * A localized string containing the help text. + */ +function hook_help($route_name, \Drupal\Core\Routing\RouteMatchInterface $route_match) { + switch ($route_name) { + // Main module help for the block module. + case 'help.page.block': + return '

' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Bartik, for example, implements the regions "Sidebar first", "Sidebar second", "Featured", "Content", "Header", "Footer", etc., and a block may appear in any one of these areas. The blocks administration page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', array('!blocks' => \Drupal::url('block.admin_display'))) . '

'; + + // Help for another path in the block module. + case 'block.admin_display': + return '

' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the Save blocks button at the bottom of the page.') . '

'; + } +} + +/** + * Register a module or theme's theme implementations. + * + * The implementations declared by this hook have several purposes: + * - They can specify how a particular render array is to be rendered as HTML. + * This is usually the case if the theme function is assigned to the render + * array's #theme property. + * - They can return HTML for default calls to _theme(). + * - They can return HTML for calls to _theme() for a theme suggestion. + * + * @param array $existing + * An array of existing implementations that may be used for override + * purposes. This is primarily useful for themes that may wish to examine + * existing implementations to extract data (such as arguments) so that + * it may properly register its own, higher priority implementations. + * @param $type + * Whether a theme, module, etc. is being processed. This is primarily useful + * so that themes tell if they are the actual theme being called or a parent + * theme. May be one of: + * - 'module': A module is being checked for theme implementations. + * - 'base_theme_engine': A theme engine is being checked for a theme that is + * a parent of the actual theme being used. + * - 'theme_engine': A theme engine is being checked for the actual theme + * being used. + * - 'base_theme': A base theme is being checked for theme implementations. + * - 'theme': The actual theme in use is being checked. + * @param $theme + * The actual name of theme, module, etc. that is being being processed. + * @param $path + * The directory path of the theme or module, so that it doesn't need to be + * looked up. + * + * @return array + * An associative array of information about theme implementations. The keys + * on the outer array are known as "theme hooks". For simple theme + * implementations for regular calls to _theme(), the theme hook is the first + * argument. For theme suggestions, instead of the array key being the base + * theme hook, the key is a theme suggestion name with the format + * 'base_hook_name__sub_hook_name'. For render elements, the key is the + * machine name of the render element. The array values are themselves arrays + * containing information about the theme hook and its implementation. Each + * information array must contain either a 'variables' element (for _theme() + * calls) or a 'render element' element (for render elements), but not both. + * The following elements may be part of each information array: + * - variables: Used for _theme() call items only: an array of variables, + * where the array keys are the names of the variables, and the array + * values are the default values if they are not passed into _theme(). + * Template implementations receive each array key as a variable in the + * template file (so they must be legal PHP/Twig variable names). Function + * implementations are passed the variables in a single $variables function + * argument. + * - render element: Used for render element items only: the name of the + * renderable element or element tree to pass to the theme function. This + * name is used as the name of the variable that holds the renderable + * element or tree in preprocess and process functions. + * - file: The file the implementation resides in. This file will be included + * prior to the theme being rendered, to make sure that the function or + * preprocess function (as needed) is actually loaded; this makes it + * possible to split theme functions out into separate files quite easily. + * - path: Override the path of the file to be used. Ordinarily the module or + * theme path will be used, but if the file will not be in the default + * path, include it here. This path should be relative to the Drupal root + * directory. + * - template: If specified, this theme implementation is a template, and + * this is the template file without an extension. Do not put .html.twig on + * this file; that extension will be added automatically by the default + * rendering engine (which is Twig). If 'path' above is specified, the + * template should also be in this path. + * - function: If specified, this will be the function name to invoke for + * this implementation. If neither 'template' nor 'function' is specified, + * a default function name will be assumed. For example, if a module + * registers the 'node' theme hook, 'theme_node' will be assigned to its + * function. If the chameleon theme registers the node hook, it will be + * assigned 'chameleon_node' as its function. + * - base hook: Used for _theme() suggestions only: the base theme hook name. + * Instead of this suggestion's implementation being used directly, the base + * hook will be invoked with this implementation as its first suggestion. + * The base hook's files will be included and the base hook's preprocess + * functions will be called in place of any suggestion's preprocess + * functions. If an implementation of hook_theme_suggestions_HOOK() (where + * HOOK is the base hook) changes the suggestion order, a different + * suggestion may be used in place of this suggestion. If after + * hook_theme_suggestions_HOOK() this suggestion remains the first + * suggestion, then this suggestion's function or template will be used to + * generate the output for _theme(). + * - pattern: A regular expression pattern to be used to allow this theme + * implementation to have a dynamic name. The convention is to use __ to + * differentiate the dynamic portion of the theme. For example, to allow + * forums to be themed individually, the pattern might be: 'forum__'. Then, + * when the forum is themed, call: + * @code + * _theme(array('forum__' . $tid, 'forum'), $forum) + * @endcode + * - preprocess functions: A list of functions used to preprocess this data. + * Ordinarily this won't be used; it's automatically filled in. By default, + * for a module this will be filled in as template_preprocess_HOOK. For + * a theme this will be filled in as twig_preprocess and + * twig_preprocess_HOOK as well as themename_preprocess and + * themename_preprocess_HOOK. + * - override preprocess functions: Set to TRUE when a theme does NOT want + * the standard preprocess functions to run. This can be used to give a + * theme FULL control over how variables are set. For example, if a theme + * wants total control over how certain variables in the page.html.twig are + * set, this can be set to true. Please keep in mind that when this is used + * by a theme, that theme becomes responsible for making sure necessary + * variables are set. + * - type: (automatically derived) Where the theme hook is defined: + * 'module', 'theme_engine', or 'theme'. + * - theme path: (automatically derived) The directory path of the theme or + * module, so that it doesn't need to be looked up. + * + * @see hook_theme_registry_alter() + */ +function hook_theme($existing, $type, $theme, $path) { + return array( + 'forum_display' => array( + 'variables' => array('forums' => NULL, 'topics' => NULL, 'parents' => NULL, 'tid' => NULL, 'sortby' => NULL, 'forum_per_page' => NULL), + ), + 'forum_list' => array( + 'variables' => array('forums' => NULL, 'parents' => NULL, 'tid' => NULL), + ), + 'forum_icon' => array( + 'variables' => array('new_posts' => NULL, 'num_posts' => 0, 'comment_mode' => 0, 'sticky' => 0), + ), + 'status_report' => array( + 'render element' => 'requirements', + 'file' => 'system.admin.inc', + ), + ); +} + +/** + * Alter the theme registry information returned from hook_theme(). + * + * The theme registry stores information about all available theme hooks, + * including which callback functions those hooks will call when triggered, + * what template files are exposed by these hooks, and so on. + * + * Note that this hook is only executed as the theme cache is re-built. + * Changes here will not be visible until the next cache clear. + * + * The $theme_registry array is keyed by theme hook name, and contains the + * information returned from hook_theme(), as well as additional properties + * added by \Drupal\Core\Theme\Registry::processExtension(). + * + * For example: + * @code + * $theme_registry['user'] = array( + * 'variables' => array( + * 'account' => NULL, + * ), + * 'template' => 'core/modules/user/user', + * 'file' => 'core/modules/user/user.pages.inc', + * 'type' => 'module', + * 'theme path' => 'core/modules/user', + * 'preprocess functions' => array( + * 0 => 'template_preprocess', + * 1 => 'template_preprocess_user_profile', + * ), + * ); + * @endcode + * + * @param $theme_registry + * The entire cache of theme registry information, post-processing. + * + * @see hook_theme() + * @see \Drupal\Core\Theme\Registry::processExtension() + */ +function hook_theme_registry_alter(&$theme_registry) { + // Kill the next/previous forum topic navigation links. + foreach ($theme_registry['forum_topic_navigation']['preprocess functions'] as $key => $value) { + if ($value == 'template_preprocess_forum_topic_navigation') { + unset($theme_registry['forum_topic_navigation']['preprocess functions'][$key]); + } + } +} + +/** + * Alter the default, hook-independent variables for all templates. + * + * Allows modules to provide additional default template variables or manipulate + * existing. This hook is invoked from template_preprocess() after basic default + * template variables have been set up and before the next template preprocess + * function is invoked. + * + * Note that the default template variables are statically cached within a + * request. When adding a template variable that depends on other context, it is + * your responsibility to appropriately reset the static cache in + * template_preprocess() when needed: + * @code + * drupal_static_reset('template_preprocess'); + * @endcode + * + * See user_template_preprocess_default_variables_alter() for an example. + * + * @param array $variables + * An associative array of default template variables, as set up by + * _template_preprocess_default_variables(). Passed by reference. + * + * @see template_preprocess() + * @see _template_preprocess_default_variables() + */ +function hook_template_preprocess_default_variables_alter(&$variables) { + $variables['is_admin'] = \Drupal::currentUser()->hasPermission('access administration pages'); +} + +/** + * Prepare a message based on parameters; called from drupal_mail(). + * + * Note that hook_mail(), unlike hook_mail_alter(), is only called on the + * $module argument to drupal_mail(), not all modules. + * + * @param $key + * An identifier of the mail. + * @param $message + * An array to be filled in. Elements in this array include: + * - id: An ID to identify the mail sent. Look at module source code + * or drupal_mail() for possible id values. + * - to: The address or addresses the message will be sent to. The + * formatting of this string must comply with RFC 2822. + * - subject: Subject of the email to be sent. This must not contain any + * newline characters, or the mail may not be sent properly. drupal_mail() + * sets this to an empty string when the hook is invoked. + * - body: An array of lines containing the message to be sent. Drupal will + * format the correct line endings for you. drupal_mail() sets this to an + * empty array when the hook is invoked. + * - from: The address the message will be marked as being from, which is + * set by drupal_mail() to either a custom address or the site-wide + * default email address when the hook is invoked. + * - headers: Associative array containing mail headers, such as From, + * Sender, MIME-Version, Content-Type, etc. drupal_mail() pre-fills + * several headers in this array. + * @param $params + * An array of parameters supplied by the caller of drupal_mail(). + */ +function hook_mail($key, &$message, $params) { + $account = $params['account']; + $context = $params['context']; + $variables = array( + '%site_name' => \Drupal::config('system.site')->get('name'), + '%username' => $account->getDisplayName(), + ); + if ($context['hook'] == 'taxonomy') { + $entity = $params['entity']; + $vocabulary = entity_load('taxonomy_vocabulary', $entity->id()); + $variables += array( + '%term_name' => $entity->name, + '%term_description' => $entity->description, + '%term_id' => $entity->id(), + '%vocabulary_name' => $vocabulary->name, + '%vocabulary_description' => $vocabulary->description, + '%vocabulary_id' => $vocabulary->id(), + ); + } + + // Node-based variable translation is only available if we have a node. + if (isset($params['node'])) { + /** @var \Drupal\node\NodeInterface $node */ + $node = $params['node']; + $variables += array( + '%uid' => $node->getOwnerId(), + '%url' => url('node/' . $node->id(), array('absolute' => TRUE)), + '%node_type' => node_get_type_label($node), + '%title' => $node->getTitle(), + '%teaser' => $node->teaser, + '%body' => $node->body, + ); + } + $subject = strtr($context['subject'], $variables); + $body = strtr($context['message'], $variables); + $message['subject'] .= str_replace(array("\r", "\n"), '', $subject); + $message['body'][] = drupal_html_to_text($body); +} + +/** * Flush all persistent and static caches. * * This hook asks your module to clear all of its static caches, @@ -57,13 +1347,158 @@ function hook_cache_flush() { * @see drupal_flush_all_caches() */ function hook_rebuild() { - $themes = \Drupal::service('theme_handler')->listInfo(); + $themes = list_themes(); foreach ($themes as $theme) { _block_rehash($theme->getName()); } } /** + * Perform necessary actions before a module is installed. + * + * @param string $module + * The name of the module about to be installed. + */ +function hook_module_preinstall($module) { + mymodule_cache_clear(); +} + +/** + * Perform necessary actions after modules are installed. + * + * This function differs from hook_install() in that it gives all other modules + * a chance to perform actions when a module is installed, whereas + * hook_install() is only called on the module actually being installed. See + * \Drupal\Core\Extension\ModuleHandler::install() for a detailed description of + * the order in which install hooks are invoked. + * + * @param $modules + * An array of the modules that were installed. + * + * @see \Drupal\Core\Extension\ModuleHandler::install() + * @see hook_install() + */ +function hook_modules_installed($modules) { + if (in_array('lousy_module', $modules)) { + \Drupal::state()->set('mymodule.lousy_module_compatibility', TRUE); + } +} + +/** + * Perform necessary actions before a module is uninstalled. + * + * @param string $module + * The name of the module about to be uninstalled. + */ +function hook_module_preuninstall($module) { + mymodule_cache_clear(); +} + +/** + * Perform necessary actions after modules are uninstalled. + * + * This function differs from hook_uninstall() in that it gives all other + * modules a chance to perform actions when a module is uninstalled, whereas + * hook_uninstall() is only called on the module actually being uninstalled. + * + * It is recommended that you implement this hook if your module stores + * data that may have been set by other modules. + * + * @param $modules + * An array of the modules that were uninstalled. + * + * @see hook_uninstall() + * @see hook_modules_disabled() + */ +function hook_modules_uninstalled($modules) { + if (in_array('lousy_module', $modules)) { + \Drupal::state()->delete('mymodule.lousy_module_compatibility'); + } + mymodule_cache_rebuild(); +} + +/** + * Registers PHP stream wrapper implementations associated with a module. + * + * Provide a facility for managing and querying user-defined stream wrappers + * in PHP. PHP's internal stream_get_wrappers() doesn't return the class + * registered to handle a stream, which we need to be able to find the handler + * for class instantiation. + * + * If a module registers a scheme that is already registered with PHP, it will + * be unregistered and replaced with the specified class. + * + * @return + * A nested array, keyed first by scheme name ("public" for "public://"), + * then keyed by the following values: + * - 'name' A short string to name the wrapper. + * - 'class' A string specifying the PHP class that implements the + * Drupal\Core\StreamWrapper\StreamWrapperInterface interface. + * - 'description' A string with a short description of what the wrapper does. + * - 'type' (Optional) A bitmask of flags indicating what type of streams this + * wrapper will access - local or remote, readable and/or writeable, etc. + * Many shortcut constants are defined in file.inc. Defaults to + * STREAM_WRAPPERS_NORMAL which includes all of these bit flags: + * - STREAM_WRAPPERS_READ + * - STREAM_WRAPPERS_WRITE + * - STREAM_WRAPPERS_VISIBLE + * + * @see file_get_stream_wrappers() + * @see hook_stream_wrappers_alter() + * @see system_stream_wrappers() + */ +function hook_stream_wrappers() { + return array( + 'public' => array( + 'name' => t('Public files'), + 'class' => 'Drupal\Core\StreamWrapper\PublicStream', + 'description' => t('Public local files served by the webserver.'), + 'type' => STREAM_WRAPPERS_LOCAL_NORMAL, + ), + 'private' => array( + 'name' => t('Private files'), + 'class' => 'Drupal\Core\StreamWrapper\PrivateStream', + 'description' => t('Private local files served by Drupal.'), + 'type' => STREAM_WRAPPERS_LOCAL_NORMAL, + ), + 'temp' => array( + 'name' => t('Temporary files'), + 'class' => 'Drupal\Core\StreamWrapper\TemporaryStream', + 'description' => t('Temporary local files for upload and previews.'), + 'type' => STREAM_WRAPPERS_LOCAL_HIDDEN, + ), + 'cdn' => array( + 'name' => t('Content delivery network files'), + // @todo: Fix the name of this class when we decide on module PSR-0 usage. + 'class' => 'MyModuleCDNStream', + 'description' => t('Files served by a content delivery network.'), + // 'type' can be omitted to use the default of STREAM_WRAPPERS_NORMAL + ), + 'youtube' => array( + 'name' => t('YouTube video'), + // @todo: Fix the name of this class when we decide on module PSR-0 usage. + 'class' => 'MyModuleYouTubeStream', + 'description' => t('Video streamed from YouTube.'), + // A module implementing YouTube integration may decide to support using + // the YouTube API for uploading video, but here, we assume that this + // particular module only supports playing YouTube video. + 'type' => STREAM_WRAPPERS_READ_VISIBLE, + ), + ); +} + +/** + * Alters the list of PHP stream wrapper implementations. + * + * @see file_get_stream_wrappers() + * @see hook_stream_wrappers() + */ +function hook_stream_wrappers_alter(&$wrappers) { + // Change the name of private files to reflect the performance. + $wrappers['private']['name'] = t('Slow files'); +} + +/** * Define the current version of the database schema. * * A Drupal schema definition is an array structure representing one or more diff --git a/core/modules/user/config/install/user.mail.yml b/core/modules/user/config/install/user.mail.yml index 436ff53..cea80f6 100644 --- a/core/modules/user/config/install/user.mail.yml +++ b/core/modules/user/config/install/user.mail.yml @@ -1,28 +1,28 @@ cancel_confirm: - body: "[user:name],\n\nA request to cancel your account has been made at [site:name].\n\nYou may now cancel your account on [site:url-brief] by clicking this link or copying and pasting it into your browser:\n\n[user:cancel-url]\n\nNOTE: The cancellation of your account is not reversible.\n\nThis link expires in one day and nothing will happen if it is not used.\n\n-- [site:name] team" - subject: 'Account cancellation request for [user:name] at [site:name]' + body: "[user:display-name],\n\nA request to cancel your account has been made at [site:name].\n\nYou may now cancel your account on [site:url-brief] by clicking this link or copying and pasting it into your browser:\n\n[user:cancel-url]\n\nNOTE: The cancellation of your account is not reversible.\n\nThis link expires in one day and nothing will happen if it is not used.\n\n-- [site:name] team" + subject: 'Account cancellation request for [user:display-name] at [site:name]' password_reset: - body: "[user:name],\n\nA request to reset the password for your account has been made at [site:name].\n\nYou may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password. It expires after one day and nothing will happen if it's not used.\n\n-- [site:name] team" - subject: 'Replacement login information for [user:name] at [site:name]' + body: "[user:display-name],\n\nA request to reset the password for your account has been made at [site:name].\n\nYou may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password. It expires after one day and nothing will happen if it's not used.\n\n-- [site:name] team" + subject: 'Replacement login information for [user:display-name] at [site:name]' register_admin_created: - body: "[user:name],\n\nA site administrator at [site:name] has created an account for you. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" + body: "[user:display-name],\n\nA site administrator at [site:name] has created an account for you. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" subject: 'An administrator created an account for you at [site:name]' register_no_approval_required: - body: "[user:name],\n\nThank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" - subject: 'Account details for [user:name] at [site:name]' + body: "[user:display-name],\n\nThank you for registering at [site:name]. You may now log in by clicking this link or copying and pasting it to your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" + subject: 'Account details for [user:display-name] at [site:name]' register_pending_approval: - body: "[user:name],\n\nThank you for registering at [site:name]. Your application for an account is currently pending approval. Once it has been approved, you will receive another email containing information about how to log in, set your password, and other details.\n\n\n-- [site:name] team" - subject: 'Account details for [user:name] at [site:name] (pending admin approval)' + body: "[user:display-name],\n\nThank you for registering at [site:name]. Your application for an account is currently pending approval. Once it has been approved, you will receive another email containing information about how to log in, set your password, and other details.\n\n\n-- [site:name] team" + subject: 'Account details for [user:display-name] at [site:name] (pending admin approval)' register_pending_approval_admin: - body: "[user:name] has applied for an account.\n\n[user:edit-url]" - subject: 'Account details for [user:name] at [site:name] (pending admin approval)' + body: "[user:display-name] has applied for an account.\n\n[user:edit-url]" + subject: 'Account details for [user:display-name] at [site:name] (pending admin approval)' status_activated: - body: "[user:name],\n\nYour account at [site:name] has been activated.\n\nYou may now log in by clicking this link or copying and pasting it into your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" - subject: 'Account details for [user:name] at [site:name] (approved)' + body: "[user:display-name],\n\nYour account at [site:name] has been activated.\n\nYou may now log in by clicking this link or copying and pasting it into your browser:\n\n[user:one-time-login-url]\n\nThis link can only be used once to log in and will lead you to a page where you can set your password.\n\nAfter setting your password, you will be able to log in at [site:login-url] in the future using:\n\nusername: [user:name]\npassword: Your password\n\n-- [site:name] team" + subject: 'Account details for [user:display-name] at [site:name] (approved)' status_blocked: - body: "[user:name],\n\nYour account on [site:name] has been blocked.\n\n-- [site:name] team" - subject: 'Account details for [user:name] at [site:name] (blocked)' + body: "[user:name],\n\nYour account on [site:display-name] has been blocked.\n\n-- [site:name] team" + subject: 'Account details for [user:display-name] at [site:name] (blocked)' status_canceled: - body: "[user:name],\n\nYour account on [site:name] has been canceled.\n\n-- [site:name] team" - subject: 'Account details for [user:name] at [site:name] (canceled)' + body: "[user:display-name],\n\nYour account on [site:name] has been canceled.\n\n-- [site:name] team" + subject: 'Account details for [user:display-name] at [site:name] (canceled)' langcode: en diff --git a/core/modules/user/src/AccountSettingsForm.php b/core/modules/user/src/AccountSettingsForm.php index 38c39e6..ab89365 100644 --- a/core/modules/user/src/AccountSettingsForm.php +++ b/core/modules/user/src/AccountSettingsForm.php @@ -216,7 +216,7 @@ public function buildForm(array $form, FormStateInterface $form_state) { ); // These email tokens are shared for all settings, so just define // the list once to help ensure they stay in sync. - $email_token_help = $this->t('Available variables are: [site:name], [site:url], [user:name], [user:mail], [site:login-url], [site:url-brief], [user:edit-url], [user:one-time-login-url], [user:cancel-url].'); + $email_token_help = $this->t('Available variables are: [site:name], [site:url], [user:display-name], [user:name], [user:mail], [site:login-url], [site:url-brief], [user:edit-url], [user:one-time-login-url], [user:cancel-url].'); $form['email_admin_created'] = array( '#type' => 'details', diff --git a/core/modules/user/src/Controller/UserController.php b/core/modules/user/src/Controller/UserController.php index a34c30b..64a2506 100644 --- a/core/modules/user/src/Controller/UserController.php +++ b/core/modules/user/src/Controller/UserController.php @@ -161,7 +161,7 @@ public function userPage() { * The user account name. */ public function userTitle(UserInterface $user = NULL) { - return $user ? Xss::filter($user->getUsername()) : ''; + return $user ? Xss::filter($user->getDisplayName()) : ''; } /** diff --git a/core/modules/user/src/Entity/User.php b/core/modules/user/src/Entity/User.php index 7fd9f85..f69ffa0 100644 --- a/core/modules/user/src/Entity/User.php +++ b/core/modules/user/src/Entity/User.php @@ -438,7 +438,14 @@ public function isAnonymous() { * {@inheritdoc} */ public function getUsername() { - $name = $this->get('name')->value ?: \Drupal::config('user.settings')->get('anonymous'); + return $this->get('name')->value ?: ''; + } + + /** + * {@inheritdoc} + */ + public function getDisplayName() { + $name = $this->getUsername() ?: \Drupal::config('user.settings')->get('anonymous'); \Drupal::moduleHandler()->alter('user_format_name', $name, $this); return $name; } diff --git a/core/modules/user/src/Plugin/Search/UserSearch.php b/core/modules/user/src/Plugin/Search/UserSearch.php index c3410d0..c929ebf 100644 --- a/core/modules/user/src/Plugin/Search/UserSearch.php +++ b/core/modules/user/src/Plugin/Search/UserSearch.php @@ -148,7 +148,7 @@ public function execute() { foreach ($accounts as $account) { $result = array( - 'title' => $account->getUsername(), + 'title' => $account->getDisplayName(), 'link' => $account->url('canonical', array('absolute' => TRUE)), ); if ($this->currentUser->hasPermission('administer users')) { diff --git a/core/modules/user/src/Plugin/views/field/Name.php b/core/modules/user/src/Plugin/views/field/Name.php index cc91eea..89e33e7 100644 --- a/core/modules/user/src/Plugin/views/field/Name.php +++ b/core/modules/user/src/Plugin/views/field/Name.php @@ -24,18 +24,8 @@ class Name extends User { /** - * Overrides \Drupal\user\Plugin\views\field\User::init(). - * - * Add uid in the query so we can test for anonymous if needed. + * {@inheritdoc} */ - public function init(ViewExecutable $view, DisplayPluginBase $display, array &$options = NULL) { - parent::init($view, $display, $options); - - if (!empty($this->options['overwrite_anonymous']) || !empty($this->options['format_username'])) { - $this->additional_fields['uid'] = 'uid'; - } - } - protected function defineOptions() { $options = parent::defineOptions(); diff --git a/core/modules/user/src/Tests/UserEditedOwnAccountTest.php b/core/modules/user/src/Tests/UserEditedOwnAccountTest.php index bee1a9b..6792ba5 100644 --- a/core/modules/user/src/Tests/UserEditedOwnAccountTest.php +++ b/core/modules/user/src/Tests/UserEditedOwnAccountTest.php @@ -16,6 +16,13 @@ */ class UserEditedOwnAccountTest extends WebTestBase { + /** + * Modules to enable. + * + * @var array + */ + public static $modules = array('user_form_test'); + function testUserEditedOwnAccount() { // Change account setting 'Who can register accounts?' to Administrators // only. diff --git a/core/modules/user/src/Tests/UserEntityCallbacksTest.php b/core/modules/user/src/Tests/UserEntityCallbacksTest.php index 1834872..4da0386 100644 --- a/core/modules/user/src/Tests/UserEntityCallbacksTest.php +++ b/core/modules/user/src/Tests/UserEntityCallbacksTest.php @@ -22,7 +22,7 @@ class UserEntityCallbacksTest extends WebTestBase { * * @var array */ - public static $modules = array('user'); + public static $modules = array('user', 'user_name_test'); /** * An authenticated user to use for testing. @@ -55,6 +55,13 @@ function testLabelCallback() { $name = $this->randomMachineName(); $this->config('user.settings')->set('anonymous', $name)->save(); $this->assertEqual($this->anonymous->label(), $name, 'The variable anonymous should be used for name of uid 0'); + $this->assertEqual($this->anonymous->getUserName(), '', 'The raw anonymous user name should be empty string'); + + // Set to test the altered username. + \Drupal::state()->set('user_name_test_altered_name', 'altered'); + + $this->assertEqual($this->account->getDisplayName(), $this->account->name->value . 'altered', 'The user display name should be altered.'); + $this->assertEqual($this->account->getUsername(), $this->account->name->value, 'The user name should not be altered.'); } } diff --git a/core/modules/user/src/Tests/UserTokenReplaceTest.php b/core/modules/user/src/Tests/UserTokenReplaceTest.php index 897e2aa..e7a9950 100644 --- a/core/modules/user/src/Tests/UserTokenReplaceTest.php +++ b/core/modules/user/src/Tests/UserTokenReplaceTest.php @@ -55,7 +55,8 @@ function testUserTokenReplacement() { // Generate and test sanitized tokens. $tests = array(); $tests['[user:uid]'] = $account->id(); - $tests['[user:name]'] = String::checkPlain(user_format_name($account)); + $tests['[user:display-name]'] = String::checkPlain($account->getDisplayName()); + $tests['[user:name]'] = String::checkPlain($account->getUsername()); $tests['[user:mail]'] = String::checkPlain($account->getEmail()); $tests['[user:url]'] = $account->url('canonical', $url_options); $tests['[user:edit-url]'] = $account->url('edit-form', $url_options); @@ -63,6 +64,7 @@ function testUserTokenReplacement() { $tests['[user:last-login:short]'] = format_date($account->getLastLoginTime(), 'short', '', NULL, $language_interface->getId()); $tests['[user:created]'] = format_date($account->getCreatedTime(), 'medium', '', NULL, $language_interface->getId()); $tests['[user:created:short]'] = format_date($account->getCreatedTime(), 'short', '', NULL, $language_interface->getId()); + $tests['[current-user:display-name]'] = String::checkPlain($global_account->getDisplayName()); $tests['[current-user:name]'] = String::checkPlain(user_format_name($global_account)); // Test to make sure that we generated something for each token. @@ -74,9 +76,11 @@ function testUserTokenReplacement() { } // Generate and test unsanitized tokens. - $tests['[user:name]'] = user_format_name($account); + $tests['[user:display-name]'] = $account->getDisplayName(); + $tests['[user:name]'] = $account->getUsername(); $tests['[user:mail]'] = $account->getEmail(); - $tests['[current-user:name]'] = user_format_name($global_account); + $tests['[current-user:display-name]'] = $global_account->getDisplayName(); + $tests['[current-user:name]'] = $global_account->getUsername(); foreach ($tests as $input => $expected) { $output = $token_service->replace($input, array('user' => $account), array('langcode' => $language_interface->getId(), 'sanitize' => FALSE)); diff --git a/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php b/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php index 8312b11..76d30bb 100644 --- a/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php +++ b/core/modules/user/src/Tests/Views/HandlerFieldUserNameTest.php @@ -25,7 +25,8 @@ class HandlerFieldUserNameTest extends UserTestBase { public static $testViews = array('test_views_handler_field_user_name'); public function testUserName() { - $this->drupalLogin($this->drupalCreateUser(array('access user profiles'))); + $new_user = $this->drupalCreateUser(array('access user profiles')); + $this->drupalLogin($new_user); // Set defaults. $view = Views::getView('test_views_handler_field_user_name'); @@ -37,8 +38,12 @@ public function testUserName() { $username = $view->result[0]->users_field_data_name = $this->randomMachineName(); $view->result[0]->uid = 1; $render = $view->field['name']->advancedRender($view->result[0]); + $this->assertTrue(strpos($render, $username) !== FALSE, 'If link to user is checked the username should be part of the output.'); - $this->assertTrue(strpos($render, 'user/1') !== FALSE, 'If link to user is checked the link to the user should appear as well.'); + $this->assertTrue(strpos($render, 'user/' . $new_user->id()) !== FALSE, 'If link to user is checked the link to the user should appear as well.'); + + $view->destroy(); + $this->executeView($view); $view->field['name']->options['link_to_user'] = FALSE; $username = $view->result[0]->users_field_data_name = $this->randomMachineName(); @@ -49,6 +54,7 @@ public function testUserName() { $view->result[0]->uid = 0; $anon_name = $this->config('user.settings')->get('anonymous'); $view->result[0]->users_field_data_name = ''; + $render = $view->field['name']->advancedRender($view->result[0]); $this->assertIdentical($render, $anon_name , 'For user0 it should use the default anonymous name by default.'); diff --git a/core/modules/user/tests/modules/user_test_views/test_views/views.view.test_views_handler_field_user_name.yml b/core/modules/user/tests/modules/user_test_views/test_views/views.view.test_views_handler_field_user_name.yml index 4fd758c..2f25ca0 100644 --- a/core/modules/user/tests/modules/user_test_views/test_views/views.view.test_views_handler_field_user_name.yml +++ b/core/modules/user/tests/modules/user_test_views/test_views/views.view.test_views_handler_field_user_name.yml @@ -53,6 +53,13 @@ display: type: default row: type: fields + sorts: + uid: + id: uid + table: users + field: uid + plugin_id: standard + provider: views display_plugin: default display_title: Master id: default diff --git a/core/modules/user/user.api.php b/core/modules/user/user.api.php index 928a56a..cc7812e 100644 --- a/core/modules/user/user.api.php +++ b/core/modules/user/user.api.php @@ -107,17 +107,17 @@ function hook_user_cancel_methods_alter(&$methods) { /** * Alter the username that is displayed for a user. * - * Called by user_format_name() to allow modules to alter the username that's + * Called by $user->getDisplayName() to allow modules to alter the username that's * displayed. Can be used to ensure user privacy in situations where * $account->name is too revealing. * * @param $name - * The string that user_format_name() will return. + * The string that $user->getDisplayName() will return. * * @param $account - * The account object passed to user_format_name(). + * The account object. * - * @see user_format_name() + * @see $account->getDisplayName() */ function hook_user_format_name_alter(&$name, $account) { // Display the user's uid instead of name. diff --git a/core/modules/user/user.module b/core/modules/user/user.module index fbc900c..1b91a8d 100644 --- a/core/modules/user/user.module +++ b/core/modules/user/user.module @@ -460,10 +460,10 @@ function user_preprocess_block(&$variables) { * is called on it before it is printed to the page. * * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0. - * Use \Drupal\Core\Session\Interface::getUsername(). + * Use \Drupal\Core\Session\AccountInterface::getDisplayName(). */ function user_format_name(AccountInterface $account) { - return $account->getUsername(); + return $account->getDisplayName(); } /** @@ -519,7 +519,9 @@ function template_preprocess_username(&$variables) { // unsanitized version, in case other preprocess functions want to implement // their own shortening logic or add markup. If they do so, they must ensure // that $variables['name'] is safe for printing. - $name = $variables['name_raw'] = $account->getUsername(); + + $name = $account->getDisplayName(); + $variables['name_raw'] = $account->getUsername(); if (Unicode::strlen($name) > 20) { $name = Unicode::truncate($name, 15, FALSE, TRUE); $variables['truncated'] = TRUE; @@ -787,8 +789,8 @@ function _user_cancel($edit, $account, $method) { } $account->block(); $account->save(); - drupal_set_message(t('%name has been disabled.', array('%name' => $account->getUsername()))); - $logger->notice('Blocked user: %name %email.', array('%name' => $account->getUsername(), '%email' => '<' . $account->getEmail() . '>')); + drupal_set_message(t('%name has been disabled.', array('%name' => $account->getDisplayName()))); + $logger->notice('Blocked user: %name %email.', array('%name' => $account->getDisplayName(), '%email' => '<' . $account->getEmail() . '>')); break; case 'user_cancel_reassign': @@ -798,8 +800,8 @@ function _user_cancel($edit, $account, $method) { _user_mail_notify('status_canceled', $account); } $account->delete(); - drupal_set_message(t('%name has been deleted.', array('%name' => $account->getUsername()))); - $logger->notice('Deleted user: %name %email.', array('%name' => $account->getUsername(), '%email' => '<' . $account->getEmail() . '>')); + drupal_set_message(t('%name has been deleted.', array('%name' => $account->getDisplayName()))); + $logger->notice('Deleted user: %name %email.', array('%name' => $account->getDisplayName(), '%email' => '<' . $account->getEmail() . '>')); break; } @@ -1406,8 +1408,9 @@ function user_toolbar() { '#type' => 'toolbar_item', 'tab' => array( '#type' => 'link', - '#title' => $user->getUsername(), '#url' => Url::fromRoute('user.page'), + '#title' => $user->getDisplayName(), + '#href' => 'user', '#attributes' => array( 'title' => t('My account'), 'class' => array('toolbar-icon', 'toolbar-icon-user'), @@ -1440,7 +1443,7 @@ function user_toolbar() { function user_logout() { $user = \Drupal::currentUser(); - \Drupal::logger('user')->notice('Session closed for %name.', array('%name' => $user->getUsername())); + \Drupal::logger('user')->notice('Session closed for %name.', array('%name' => $user->getDisplayName())); \Drupal::moduleHandler()->invokeAll('user_logout', array($user)); diff --git a/core/modules/user/user.tokens.inc b/core/modules/user/user.tokens.inc index 073b90f..71bfd2b 100644 --- a/core/modules/user/user.tokens.inc +++ b/core/modules/user/user.tokens.inc @@ -27,7 +27,11 @@ function user_token_info() { 'description' => t("The unique ID of the user account."), ); $user['name'] = array( - 'name' => t("Name"), + 'name' => t("Display Name"), + 'description' => t("The display name of the user account."), + ); + $user['username'] = array( + 'name' => t("Login Name"), 'description' => t("The login name of the user account."), ); $user['mail'] = array( @@ -88,11 +92,16 @@ function user_tokens($type, $tokens, array $data = array(), array $options = arr $replacements[$original] = $account->id() ?: t('not yet assigned'); break; - case 'name': - $name = user_format_name($account); + case 'display-name': + $name = $account->getDisplayName(); $replacements[$original] = $sanitize ? String::checkPlain($name) : $name; break; + case 'name': + $username = $account->getUsername(); + $replacements[$original] = $sanitize ? String::checkPlain($username) : $username; + break; + case 'mail': $replacements[$original] = $sanitize ? String::checkPlain($account->getEmail()) : $account->getEmail(); break;