PhpStorm 2023.3 Help

Inlay hints

Inlay hints appear in the editor and provide you with additional information about your code to make it easier to read and navigate.

Inlay hints example

Enable or disable inlay hints

  • Open the Settings dialog (Ctrl+Alt+S) , go to Editor | Inlay Hints, expand the groups of inlay hints, and clear the checkboxes next to the hints that you want to hide or show.

    Settings | Inlay Hints
  • In the editor, right-click a hint and select whether you want to disable the specific type of hints or all hints in this category.

    Hide code author names

Code vision

Code vision hints display in the editor the number of inheritors and usages for a symbol, show who authored it, and mark symbols that are new or contain uncommitted changes.

When you hover over a hint, it turns into a link. By clicking the link you can navigate to usages or implementations of the class or interface as well as open Version Control annotations.

  • Inheritors show the number of descendants of a class (inheritors), interface (implementations), or trait (used by`s). Click the hint to jump to the descendants. If there are several descendants, select the relevant one from the list. Learn more from Go to implementation.

    Inlay hints, code vision: jump to an inheritor
  • Usages show how many times a class or a method is used in your project. Click the hint to jump to the usage or to select the relevant one from the list. Learn more from Search for usages in a project.

    Inlay hints, code vision: jump to usages
  • Code author shows the person who wrote/edited most code lines in a given code element. The hint also indicates if the element is new, modified in the current revision, or has several contributors who considerably committed to it. Click the hint to open the Git annotations in the gutter. Learn more from Locate code author.

    Inlay hints, code vision: code author

In the right-hand pane of the dialog, configure the default position of inlay hints—whether they should be displayed above symbols or to the right of them—and specify the maximum number of inlay hints to be shown in each position.

Code vision: configure default settings

You can also configure custom positioning for hints of a specific type.

Configure position for inlay hints in the Settings dialog

Parameter names

Show the names of parameters in function and method calls. These hints provide assistance with passing correct arguments to functions and methods.

The PHP-specific parameter name options are:

  • Show name for all arguments: if selected, parameter name hints are displayed for all arguments. Otherwise, parameter hints are displayed only for literals or null values but not for named objects.

    Parameter hints for literals
  • Always show pass by reference: if selected, the & parameter hints are shown for arguments that are passed by reference. The names of the arguments that match the parameters' names are omitted if the Show name for all arguments checkbox is cleared.

    Parameter hints for arguments passed by reference

For a number of methods and functions, parameter names are not shown by default: such methods and functions are on the default Exclude List. To re-enable the excluded parameter name hints, or add more excluded methods or functions, click Exclude list and edit the list.

Settings | Inlay Hints

Types

Show the types of variables, fields, parameters and function return types in the editor.

Inlay hints, types: call chains

Learn more from Return types in JavaScript, Type hints in JavaScript, Return type hints in TypeScript, Type hints in TypeScript.

Values

By default, this checkbox is selected and PhpStorm shows inferred values for numeric enums in the TypeScript context. Clear the checkbox to hide the inferred values and show only the values of explicitly initialized constants.

Other

  • Docker run named stage: show an icon to quickly build or run a specific named stage in a Dockerfile.

  • Table inlays: show horizontal and vertical bars around the table. Provides column and row actions.

Change inlay hints appearance

  1. In the Settings dialog (Ctrl+Alt+S) , go to Editor | Color Scheme | Language Defaults, then select Inline hints.

  2. Select the inlay hint type and state, and configure the font color and effects as required.

Last modified: 25 March 2024