PhpStorm 2019.2 Help

Language injections

Language injections let you work with pieces of code in other languages embedded in your code. When you inject a language (such as HTML, CSS, XML, RegExp, and so on) into a string literal, you get comprehensive code assistance for editing that literal.

Temporarily inject a language

  1. Position the caret inside the string literal, tag, or attribute, in which you want to inject a language and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Inject language or reference and choose the language you want to inject.

Open a code fragment in the dedicated editor section

  1. Position the caret within the injected code piece and press Alt+Enter (or use the intention action icon Intention action icon).

  2. Select Edit <language ID> Fragment.

    PhpStorm will open a dedicated editor section for editing the code with the injected language. This editor provides full code assistance, including code completion, inspections, intentions and code style actions.

Use the @lang annotation

In the PHP context, you can also use the @lang <language_ID> annotation to inject a language.

Provide the @lang <language_ID> PHPDoc annotation preceding the target string literal. Language IDs are generally intuitive, for example SQL, RegExp, XML, HTML.

Inject a language inside a nowdoc/heredoc string

In the PHP context, you can inject a language inside nowdoc / heredoc strings.

Start typing a heredoc / nowdoc string and set the marker to the language ID you want to inject. Language IDs are generally intuitive, for example SQL, RegExp, XML, HTML.

Use language injection comments

Add a blank line before the target string literal, and type the following comment:

-- language=<language_ID>

For comments, use the syntax of the language you want to inject. Language IDs are generally intuitive, for example, SQL, RegExp, XML, HTML.

Cancel injections

  1. Position the caret at the code fragment and press Alt+Enter (or use the intention action icon the Intention action button).

  2. Select Uninject language or reference.

To cancel a language injection, you can also delete the injection comment or annotation.

Configure injection rules

You can configure language injection rules on the Editor | Language Injections page of PhpStorm settings Ctrl+Alt+S.

All pre-defined injection rules are configured for the Built-in scope. In other words, they are global (and therefore available in all PhpStorm projects). Custom rules can be configured for the IDE or for one project only. To change the scope of custom injections, use the the Move to Project/IDE scope button.

To configure custom injection rules, click the Add button to add a new rule, or copy a predefined rule and change its settings.

Last modified: 23 September 2019