How to create custom token to be used in default mail message template in drupal 8

How​ ​to​ ​create​ ​custom​ ​token​ ​to​ ​be​ ​used​ ​in​ ​default​ ​mail​ ​message template​ ​in​​ ​Drupal​ ​8 How​ ​to​ ​create​ ​custom​ ​Token​ ​in​ ​Drupal​ ​8​ ​to​ ​get​ ​the​ ​same​ ​results

Description: ​Tokens are very small bits of data or text that we place into a larger documents through simple placeholders, like [type:token], to create custom tokens in Drupal​ ​8.

Abstract: ​Have you ever been in a situation where you have to do similar coding in different places, if yes, then learn to create custom token to be used in default mail message​ ​template​ ​in​ ​Drupal​ ​8.

Blog

Sometimes we need to do similar codings in different places, such as for account settings email templates (Welcome mail template, Forget password mail template, from UI to get the same results. In this scenario, it's always suggested to create a custom token and use that in different types of mail templates (account setting mail templates) from​ ​Drupal​ ​UI​ ​in​ ​[token:type]​ ​format.

In our previous blog, we explored about ​creating custom tokens in Drupal 7 ​a​n​d in this, we​ ​will​ ​take​ ​a​ ​brief​ ​look​ ​at​ ​what​ ​is​ ​token?​ ​How​ ​to​ ​create​ ​it​ ​in​ ​Drupal​ ​8?

In​ ​vein​ ​of​ ​first​ ​thing​ ​first,​ ​what​ ​is​ ​token?

Tokens are very small bits of data or text that we use or place into a larger documents via simple placeholders, like [type:token], to create custom tokens. The Token module provides an API that is used to provide tokens for all other core or contributed module in a​ ​bunch​ ​and​ ​provide​ ​browsing​ ​facility​ ​for​ ​all​ ​available​ ​tokens​ ​in​ ​UI. When we install Drupal in our system, some Drupal core modules has available tokens that we can use in our code as well as in account setting email templates. But as a beginner in Drupal 8, It's really difficult to find out which core tokens are available and to find​ ​this,​ ​we​ ​use​ ​Token​ ​module.

See​ ​the​ ​screenshot​ ​below​ ​for​ ​an​ ​example​ ​of​ ​available​ ​tokens.

Requirements Sometimes,​ ​we​ ​need​ ​to​ ​create​ ​custom​ ​tokens​ ​as​ ​per​ ​the​ ​project's​ ​requirement​ ​and​ ​for that​ ​we​ ​need​ ​two​ ​hooks,​ ​namely 1.​ ​hook_token_into() 2.​ ​hook_tokens() hook_token_into()​:​ ​This​ ​hook​ ​will​ ​allow​ ​you​ ​to​ ​provide​ ​the​ ​information​ ​of​ ​types​ ​of​ ​token and​ ​placeholders​ ​of​ ​tokens. hook_tokens()​:​ ​This​ ​hooks​ ​provides​ ​a​ ​replacement​ ​values​ ​of​ ​tokens.​ ​Some​ ​parameters are​ ​needed​ ​for​ ​this​ ​hook.​ ​<a href=”https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Utility%21tok en.api.php/function/hook_tokens/8.2.x”>Click​ ​here</a>​ ​to​ ​check​ ​the​ ​parameters.

Here, I am creating a simple token to print “Hello World!” text as token replacement parameter.

Here​ ​we​ ​are​ ​going​ ​to​ ​see​ ​how​ ​to​ ​create​ ​simple​ ​custom​ ​token​ ​in​ ​Drupal​ ​8..

Step​ ​1:​​ ​Create​ ​a​ ​custom​ ​module​ ​for​ ​this​ ​custom​ ​token.​ ​Here​ ​I​ ​am​ ​creating​ ​a​ ​custom module​ ​name​ ​custom_module​ ​that​ ​contains​ ​the​ ​below​ ​mentioned​ ​files. custom_token.info.yml custom_token.module custom_token.tokens.inc Step​ ​2:​​ ​Create​ ​a​ ​custom_token.info.yml​ ​file name:​ ​Custom​ ​Token description:​ ​Custom​ ​token​ ​example type:​ ​module package:​ ​Custom core:​ ​‘8.x’ Step​ ​3:​​ ​Create​ ​“custom_token.module​ ​file”. <?php //​ ​Load​ ​custom_token.tokens.inc​ ​from​ ​custom_token​ ​module module_load_include('inc',​ ​'custom_token',​ ​‘custom_token​ ​.tokens'); Step​ ​4:​​ ​Create​ ​“custom_token.tokens.inc”​ ​file.​ ​Here,​ ​I​ ​have​ ​added​ ​all​ ​the​ ​custom​ ​codes for​ ​custom​ ​token. <?php use​ ​Drupal\Core\Render\BubbleableMetadata; /* *​ ​implement​ ​hook_token_info() */ function​ ​custom_token_token_info(){ $types['custom_token_type']​ ​=​ ​array( 'name'​ ​=>​ ​t('Custom​ ​token​ ​type'), 'description'​ ​=>​ ​t('Define​ ​custom​ ​token​ ​type') ); $tokens['custom_token_name']​ ​=​ ​array(

);

'name'​ ​=>​ ​t('Custom​ ​token​ ​name'), 'description'​ ​=>​ ​t('Define​ ​custom​ ​token​ ​name')

return​ ​array( 'types'​ ​=>​ ​$types, 'tokens'​ ​=>​ ​array( 'custom_token_type'​ ​=>​ ​$tokens ) ); }

/* *​ ​implement​ ​hook_token() */ function​ ​custom_token_tokens($type,​ ​$tokens,​ ​array​ ​$data,​ ​array​ ​$options, BubbleableMetadata​ ​$bubbleable_metadata){ $replacements​ ​=​ ​array(); if($type​ ​==​ ​'custom_token_type')​ ​{ foreach​ ​($tokens​ ​as​ ​$name​ ​=>​ ​$original)​ ​{ switch​ ​($name)​ ​{ case​ ​'custom_token_name': $text​ ​=​ ​'Hello​ ​World!'; $replacements[$original]​ ​=​ ​$text; break; } } } return​ ​$replacements; }

Note:​​ ​You​ ​can​ ​put​ ​both​ ​hooks​ ​and​ ​require​ ​bubble​ ​metadata​ ​class​ ​in “custom_token.module”​ ​file​ ​directly​ ​without​ ​creating​ ​any​ ​.inc​ ​file.

Ones​ ​you​ ​create​ ​and​ ​install​ ​this​ ​module,​ ​you​ ​will​ ​find​ ​the​ ​newly​ ​ ​created​ ​custom​ ​token​ ​is displaying​ ​into​ ​the​​ ​Browse​ ​available​ ​tokens​​ ​section.

Now​ ​you​ ​can​ ​use​ ​this​ ​newly​ ​created​ ​custom​ ​token​ ​in​ ​Account​ ​setting​ ​Email​ ​section​ ​as the​ ​below​ ​format: [custom_token_type:custom_token_name] See​ ​the​ ​screenshot​ ​below​ ​for​ ​an​ ​example

Okay, so now you know what is custom Token and how to create it? You're also convinced that you've got something new to say about your subject. Go ahead! Try custom Token on your website and see what it can do for you. I invite you to comment below​ ​or​ ​ask​ ​any​ ​questions​ ​you​ ​may​ ​have.

Below​ ​given​ ​is​ ​a​ ​presentation​ ​on​ ​creating​ ​custom​ ​tokens​ ​in​ ​Drupal​ ​8. https://www.slideshare.net/valuebound/token-module-in-drupal-8 <iframe​ ​src="//www.slideshare.net/slideshow/embed_code/key/ktcj4EGIXQWzOp"​ ​width="595" height="485"​ ​frameborder="0"​ ​marginwidth="0"​ ​marginheight="0"​ ​scrolling="no" style="border:1px​ ​solid​ ​#CCC;​ ​border-width:1px;​ ​margin-bottom:5px;​ ​max-width:​ ​100%;" allowfullscreen>​ ​</iframe>​ ​<div​ ​style="margin-bottom:5px">​ ​<strong>​ ​<a href="//www.slideshare.net/valuebound/token-module-in-drupal-8"​ ​title="Token​ ​module​ ​in​ ​drupal 8"​ ​target="_blank">Token​ ​module​ ​in​ ​drupal​ ​8</a>​ ​</strong>​ ​from​ ​<strong><a href="https://www.slideshare.net/valuebound"​ ​target="_blank">valuebound</a></strong>​ ​</div>