PhpStorm 8.0.0 Web Help

File | Settings | Editor | Code Style | PHP


Use this page to configure formatting options for PHP files. View the result in the Preview pane on the right.

On this page:

8.0+

Set From

Click this link to choose the base for the current language default code style from the pop-up list, that appears. The list contains two options:

  • Language: choose this option to inherit the coding style settings from another language. Select the source language from the list, that opens. So doing, only the settings that are applicable to the current language are taken. All the other settings are not affected.
  • Predefined code style: choose this option to use the coding standards defined for a specific framework. Select one of the following frameworks from the list:

This link appears in the upper-right corner of the language-specific code style page, when applicable.

Click Reset to discard changes and return to the initial set of code style settings.

Tabs and Indents Tab

Item Description
Use tab character
  • If this check box is selected, tab characters are used:
    • On pressing the TabTabTabTabTabTabTabTabTabTabTab key
    • For indentation
    • For code reformatting
  • When the check box is cleared, PhpStorm uses spaces instead of tabs.
Smart tabs
  • If this check box is selected, PhpStorm inserts tabs for indentation and reformatting, but fine alignment to a necessary column is done only via spaces without replacing them with tabs. This is done in order to preserve visual representation of the source code, when the Tab Size is changed.

    php_code_style_smart_tabs_on.png

  • If this check box is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.

    php_code_style_smart_tabs_off.png

The Smart Tabs check box is available if the Use Tab Character check box is selected.

Tab size In this text box, specify the number of spaces included in a tab.
Indent In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected) to be inserted for each indent level.
Detect and use existing file indents for editing Use this check box to detect code style settings in the currently edited file on the fly. In this case, when you open a file in the editor, indentation that was used in that file is preserved automatically. For example, if tabs were used for the indentation then in copy, paste or enter actions, tabs are used. Also, note that if you use the Reformat Code command then PhpStorm applies default code style settings and uses them in the editor.

Spaces Tab

Use this tab to specify where you want spaces in your code. To have PhpStorm automatically insert a space at a location, select the check box next to this location in the list. The results are displayed in the Preview pane.

Wrapping and Braces Tab

In this tab, customize the code style options, which PhpStorm will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, etc.). The right-hand pane shows preview.

Note

Alignment takes precedence over indentation options.

Keep When Reformatting

Use the check boxes to configure exceptions that PhpStorm will make when reformatting the source code. For example, by default, the Line brakes check box is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line brakes check box before you reformat the source code.

Wrapping Options

The wrapping style applies to the various code constructs, specified in the left-hand pane (for example, method call arguments, or assignment statements).

Item Description
Wrapping style From this drop-down list, select the desired wrapping style:
  • Do not wrap - when this option is selected, no special wrapping style is applied.

    Note

    If this option is selected, the nested alignment and braces settings are ignored.

  • Wrap if long - select this option to have lines going beyond the right margin wrapped with proper indentation.
  • Chop down if long - select this option to have elements in lists that go beyond the right margin wrapped so that there is one element per line with proper indentation.
  • Wrap always - select this option to have all elements in lists wrapped so that there is one element per line with proper indentation.

Alignment Options

Item Description
<character(s)> on next line Select this check box to have the specified character or characters moved to the next line when the lines are wrapped.
New line after <character> Select this check box to have the code after the specified character moved to a new line.
Place on new line Use this check box to have the corresponding statements or characters moved to the next line.
Align when multiline If this check box is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level.
Special else if treatment If this check box is selected, else if statements are located in the same line.

Otherwise, else if statements are moved to the next line to the corresponding indent level.

Indent case branches If this check box is selected, the case statement is located at the corresponding indent level. Otherwise, case statement is placed at the same indent level with switch.

Braces placement options

Item Description
Braces placement style Use this drop-down list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:
  • End of line - select this option to have the opening brace placed at the declaration line end.
  • Next line if wrapped - select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.
  • Next line - select this option to have the opening brace placed at the beginning of the line after the declaration line.
  • Next line shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.
  • Next line each shifted - select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.
Force braces From this drop-down list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:
  • Do not force - select this option to suppress introducing braces automatically.
  • When multiline - select this option to have braces introduced automatically, if a statement occupies more than one line. Note that PhpStorm analyzes the number of lines in the entire statement but not only its condition. For example, if the code is
    <?php
        if (true)
            return false;
                             
    %product will insert braces automatically:
    <?php
        if (true)
           {
               return false;
           }
                             
  • Always - select this check box to have braces always introduced automatically.

Blank Lines Tab

Use this tab to define where and how many blank lines you want PhpStorm to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the Preview pane.

Item Description
Keep Maximum Blank Lines In this area, specify the number of blank lines to be kept after reformatting in the specified locations.
Minimum Blank Lines In the text boxes in this area, specify the number of blank lines to be present in the specified locations.

Warning

These settings do not influence the number of blank lines before the first and after the last item.

Arrangement

This tab lets you define a set of rules that rearranges your code according to your preferences.

Item Description
Grouping Rules Use this area to set the grouping rules.
  • Keep getters and setters together

    Select this check box to keep getter and setter methods together. By default, this check box is selected.

  • Keep overridden methods together

    Select this check box to group the overridden methods together by class and interface. In order: list, select keep or by name options.

  • Keep dependent methods together

    Select this check box to group the dependent methods together. In order: list, select depth-first or breadth-first options.

Matching rules Use this area to define elements order as a list of rules, where every rule has a set of matches such as modifier or type.
  • add - use this button to add a rule. The empty rule dialog window opens.
  • delete - use this button to remove the rule from the list.
  • edit1 - use this button to edit an existing rule. To see this button, navigate to the rule that you want to edit and click on the button. In pop-up window that opens, modify the rule fields.
  • arrowUp arrowDown - use these buttons to move the selected rule up or down.
Empty rule Use this window to create a new matching rule or edit an existing one. You can select from the following filters:
  • Type - use this filter to choose classes or methods for your rule.
  • Name - use this field to specify entry names in the rule. This filter matches only entry names such as field names, method names, class names and etc. The filter supports regular expressions and uses a standard syntax. The match is performed against the entire name.
  • Order - use this option to select the sorting order for the rule. This option is useful when more than one element uses the same matching rule. In this case, selecting Keep order will keep the same order as was set before the rearrangement and selecting Order by Name will sort the elements with the same matching rule by their names.
  • Aliases - this option displays aliases that were defined in the Rules Alias Definition dialog. You can remove the ones you do not need.
icon_sort This icon appears when you select Order by Name in Order option. The icon indicates that the items in this rule are alphabetized.

PHPDoc Tab

In this tab, configure the code style to be applied inside PHPDoc comments. Learn more about documenting PHP code at Creating PHP Documentation Comments.

Item Description
Align parameter names Select this check box to have the &<paramname> elements aligned.
Keep blank lines Select this check box to suppress removing blank lines automatically.
Blank lines around parameters Select this check box to have a blank line inserted above and below the section with @param tags.
Blank line before the first tag Select this check box to have an blank line inserted above the first PHPDoc tag.
Align tag comments Select this check box to have the description elements aligned.
Wrap long lines Select this check box to have the text that exceeds the right margin wrapped to the next line.
Generated Doc Blocks In this area, configure the code style to be applied within generated PHP documentation blocks, see Creating PHP Documentation Comments.
  • Use fully-qualified class names: select this check box to have %product specify a fully class names for properties, function parameters, return and throws values, etc.
  • Type tag: from this drop-down list, choose the tag to use for properties, the available options are @var and @type. According to the PSR5 standards, @var is deprecated and it is recommended that you use @type for properties instead.

Other Tab

Item Description
Indent code in PHP tags Select this check box to have the code enclosed in <?php> tags indented against the opening <?php tag.
Convert True/False constants to upper case Select this check box to have the true and false constants displayed in the upper case.
Convert Null constant to upper case Select this check box to have the null constant displayed in the upper case.
Blank line before return statement Select this check box to have PhpStorm automatically insert a blank line before each return statement.
Spaces around variables/expressions in brackets
  • Select this check box to have PhpStorm insert spaces inside brackets during reformatting only if the brackets enclose a variable or an expression. This setting affects reformatting only if you have not configured force insertion of spaces inside brackets by selecting the Brackets check box under the Within node in the Spaces tab.

    This option helps you keep your code in accordance with the WordPress PHP Coding Standards.

  • If this check box is cleared, the spaces insertion policy depends on the settings under the Within node in the Spaces tab regardless of the type of content inside brackets: if the Brackets check box is selected, spaces are always inserted, if the check box is cleared, spaces are never inserted.
Code Commenting In this area, configure the code style options to be applied to comments.
  • Line comment at first column: - select this check box to have line comments start at the first column, without any indentation. Note that no extra blank spaces are added after the line comment characters. The check box is by default selected.

    When the check box is cleared, the line comments start from the minimum indentation within the selected code block to be commented.

Array declaration style
  • Force short declaration style: select this check bo to have PhpStorm replace the array() constructs with [] in array declarations during reformatting, see Arrays. Syntax for details.
  • Align key-value pairs: select this check box to have the => separators in key-value assignments aligned.

Arrangement Tab

Item Description
Grouping Rules Use this area to set the grouping rules.
  • Keep getters and setters together

    Select this check box to keep getter and setter methods together. By default, this check box is selected.

  • Keep overridden methods together

    Select this check box to group the overridden methods together by class and interface. In order: list, select keep or by name options.

  • Keep dependent methods together

    Select this check box to group the dependent methods together. In order: list, select depth-first or breadth-first options.

Matching rules Use this area to define elements order as a list of rules, where every rule has a set of matches such as modifier or type.
  • add - use this button to add a rule. The empty rule dialog window opens.
  • delete - use this button to remove the rule from the list.
  • edit1 - use this button to edit an existing rule. To see this button, navigate to the rule that you want to edit and click on the button. In pop-up window that opens, modify the rule fields.
  • arrowUp arrowDown - use these buttons to move the selected rule up or down.
Empty rule Use this window to create a new matching rule or edit an existing one. You can select from the following filters:
  • Type - use this filter to choose classes or methods for your rule.
  • Name - use this field to specify entry names in the rule. This filter matches only entry names such as field names, method names, class names and etc. The filter supports regular expressions and uses a standard syntax. The match is performed against the entire name.
  • Order - use this option to select the sorting order for the rule. This option is useful when more than one element uses the same matching rule. In this case, selecting Keep order will keep the same order as was set before the rearrangement and selecting Order by Name will sort the elements with the same matching rule by their names.
  • Aliases - this option displays aliases that were defined in the Rules Alias Definition dialog. You can remove the ones you do not need.
icon_sort This icon appears when you select Order by Name in Order option. The icon indicates that the items in this rule are alphabetized.

See Also

Procedures:

Reference:

Web Resources: