phpcs.xml

<?xml version="1.0"?>
<ruleset name="PHP_CodeSniffer">
  <description>The coding standard for disciple-tools theme</description>

  <!-- This should be the same as for disciple-tools plugin -->

  <!-- To check the code for style issues, run:

       $ phpcs

       It will automatically find phpcs.xml and apply its rules.

       These rules have been selected to be similar to Wordpress's style guide,
       which we encourage you to follow:

       https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/

       The main difference is that we use four spaces for indentation, not hard
       tabs. I highly recommend using an editor that supports
       http://editorconfig.org/ so that your editor automatically uses the
       right settings for this project.
  -->

  <file>.</file>

  <exclude-pattern>vendor/*</exclude-pattern>
  <exclude-pattern>includes/admin/libraries/plugin-update-checker/*</exclude-pattern>

  <arg name="extensions" value="php,inc,lib"/>
  <arg value="n"/>

  <!--
    Prevent errors caused by WordPress Coding Standards not supporting PHP 8.0+.
    See https://github.com/WordPress/WordPress-Coding-Standards/issues/2035
  -->
  <ini name="error_reporting" value="E_ALL &#38; ~E_DEPRECATED" />

  <!-- To get a list of all currently enabled sniffs, run: phpcs -e -->

  <!-- To get a list of all available standards, run phpcs -i. To get a list of
       the sniffs in a standard, run phpcs -e \-\-standard=STANDARD -->

  <!-- For whatever reason, to get the WordPress rules to work, you have to
       include all of WordPress, which includes a bunch of other rules not in
       the WordPress namespaces. -->
  <rule ref="WordPress">
    <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
    <exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />
    <exclude name="WordPress.NamingConventions.ValidVariableName.NotSnakeCaseMemberVar" />

    <!-- We currently don't want these rules that WordPress imports: -->
    <exclude name="Generic.Functions.OpeningFunctionBraceBsdAllman" />
    <exclude name="Generic.Functions.OpeningFunctionBraceKernighanRitchie" />
    <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedELSE" />
    <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedELSEIF" />
    <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedIF" />
    <exclude name="Generic.Commenting.DocComment.Empty" />
    <exclude name="Generic.Commenting.DocComment.LongNotCapital" />
    <exclude name="Generic.Commenting.DocComment.MissingShort" />
    <exclude name="Generic.Commenting.DocComment.ShortNotCapital" />
    <exclude name="Generic.Commenting.DocComment.SpacingAfter" />
    <exclude name="Generic.Commenting.DocComment.SpacingBeforeTags" />
    <exclude name="Generic.PHP.ForbiddenFunctions.FoundWithAlternative" />
    <exclude name="Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed" />
    <exclude name="Universal.Operators.DisallowShortTernary" />
    <exclude name="PSR2.ControlStructures.SwitchDeclaration.BodyOnNextLineCASE" />
    <exclude name="PSR2.ControlStructures.SwitchDeclaration.BreakIndent" />
    <exclude name="PSR2.ControlStructures.SwitchDeclaration.SpaceBeforeColonCASE" />
    <exclude name="PSR2.Files.ClosingTag.NotAllowed" />
    <exclude name="Squiz.Commenting.BlockComment.CloserSameLine" />
    <exclude name="Squiz.Commenting.BlockComment.NoCapital" />
    <exclude name="Squiz.Commenting.BlockComment.NoEmptyLineBefore" />
    <exclude name="Squiz.Commenting.BlockComment.NoNewLine" />
    <exclude name="Squiz.Commenting.BlockComment.WrongEnd" />
    <exclude name="Squiz.Commenting.ClassComment.Missing" />
    <exclude name="Squiz.Commenting.ClassComment.SpacingAfter" />
    <exclude name="Squiz.Commenting.ClassComment.WrongStyle" />
    <exclude name="Squiz.Commenting.DocCommentAlignment.NoSpaceAfterStar" />
    <exclude name="Squiz.Commenting.DocCommentAlignment.SpaceBeforeStar" />
    <exclude name="Squiz.Commenting.FileComment.EmptyAuthorTag" />
    <exclude name="Squiz.Commenting.FileComment.Missing" />
    <exclude name="Squiz.Commenting.FileComment.MissingPackageTag" />
    <exclude name="Squiz.Commenting.FileComment.SpacingAfterComment" />
    <exclude name="Squiz.Commenting.FileComment.SpacingAfterOpen" />
    <exclude name="Squiz.Commenting.FileComment.WrongStyle" />
    <exclude name="Squiz.Commenting.FunctionComment.Missing" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamType" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamName" />
    <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag" />
    <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop" />
    <exclude name="Squiz.Commenting.FunctionComment.SpacingAfter" />
    <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType" />
    <exclude name="Squiz.Commenting.FunctionComment.WrongStyle" />
    <exclude name="Squiz.Commenting.FunctionCommentThrowTag.Missing" />
    <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
    <exclude name="Squiz.Commenting.InlineComment.NoSpaceBefore" />
    <exclude name="Squiz.Commenting.InlineComment.SpacingAfter" />
    <exclude name="Squiz.Commenting.InlineComment.SpacingBefore" />
    <exclude name="Squiz.Commenting.InlineComment.WrongStyle" />
    <exclude name="Squiz.Commenting.VariableComment.Missing" />
    <exclude name="Squiz.Commenting.VariableComment.MissingVar" />
    <exclude name="Squiz.Commenting.VariableComment.WrongStyle" />
    <exclude name="Squiz.ControlStructures.ControlSignature.NewlineAfterOpenBrace" />
    <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseBrace" />
    <exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseParenthesis" />
    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceBeforeBrace" />
    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction" />
    <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.ContentAfterBrace" />
    <exclude name="Squiz.PHP.DisallowMultipleAssignments.Found" />
    <exclude name="Squiz.PHP.EmbeddedPhp.ContentAfterEnd" />
    <exclude name="Squiz.PHP.EmbeddedPhp.ContentAfterOpen" />
    <exclude name="Squiz.PHP.EmbeddedPhp.ContentBeforeEnd" />
    <exclude name="Squiz.PHP.EmbeddedPhp.ContentBeforeOpen" />
    <exclude name="Squiz.PHP.EmbeddedPhp.NoSemicolon" />
    <exclude name="Squiz.PHP.EmbeddedPhp.SpacingBeforeClose" />
    <exclude name="Squiz.Strings.ConcatenationSpacing.PaddingFound" />
    <exclude name="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines" />
    <exclude name="Squiz.WhiteSpace.SuperfluousWhitespace.EndFile" />
    <exclude name="WordPress.Arrays.ArrayDeclarationSpacing.AssociativeKeyFound" />
    <exclude name="WordPress.Arrays.ArrayIndentation.CloseBraceNotAligned" />
    <exclude name="WordPress.Arrays.ArrayIndentation.ItemNotAligned" />
    <exclude name="WordPress.Arrays.ArrayIndentation.MultiLineArrayItemNotAligned" />
    <exclude name="WordPress.Arrays.ArrayKeySpacingRestrictions.NoSpacesAroundArrayKeys" />
    <exclude name="WordPress.Arrays.CommaAfterArrayItem.CommaAfterLast" />
    <exclude name="WordPress.Arrays.CommaAfterArrayItem.NoComma" />
    <exclude name="WordPress.Arrays.CommaAfterArrayItem.NoSpaceAfterComma" />
    <exclude name="WordPress.Arrays.CommaAfterArrayItem.SpaceAfterComma" />
    <exclude name="WordPress.Arrays.CommaAfterArrayItem.SpaceBeforeComma" />
    <exclude name="WordPress.Arrays.ArrayDeclarationSpacing.AssociativeArrayFound" />
    <exclude name="WordPress.PHP.YodaConditions.NotYoda" />
    <exclude name="WordPress.WhiteSpace.ControlStructureSpacing.NoSpaceAfterCloseParenthesis" />
    <exclude name="WordPress.WhiteSpace.ControlStructureSpacing.NoSpaceBetweenStructureColon" />
    <exclude name="WordPress.WhiteSpace.ControlStructureSpacing.OpenBraceNotSameLine" />
    <exclude name="WordPress.WhiteSpace.OperatorSpacing.NoSpaceAfter" />
    <exclude name="WordPress.WP.EnqueuedResourceParameters.MissingVersion" />
    <exclude name="WordPress.WP.EnqueuedResourceParameters.NoExplicitVersion" />

    <exclude name="PEAR.Files.IncludingFile" />
    <exclude name="WordPress.Security.EscapeOutput.ExceptionNotEscaped" />
    <exclude name="Generic.Files.OneObjectStructurePerFile" />
  </rule>

  <rule ref="Generic.Classes">
    <exclude name="Generic.Classes.OpeningBraceSameLine" />
  </rule>

  <rule ref="Universal.Arrays">
    <exclude name="Universal.Arrays.DisallowShortArraySyntax" />
    <exclude name="Universal.Arrays.MixedArrayKeyTypes" />  <!--@todo-->
    <exclude name="Universal.Arrays.MixedKeyedUnkeyedArray" />  <!--@todo-->
  </rule>

  <rule ref="Universal.Files">
    <exclude name="Universal.Files.SeparateFunctionsFromOO" />
  </rule>

  <rule ref="Universal.CodeAnalysis">
    <exclude name="Universal.CodeAnalysis.NoEchoSprintf" />
  </rule>

  <rule ref="Universal.ControlStructures">
    <exclude name="Universal.ControlStructures.DisallowLonelyIf" />
    <exclude name="Universal.ControlStructures.DisallowAlternativeSyntax" />
    <exclude name="Universal.ControlStructures.IfElseDeclaration" />
  </rule>

  <rule ref="NormalizedArrays.Arrays">
    <exclude name="NormalizedArrays.Arrays.CommaAfterLast" />
  </rule>

  <rule ref="PSR12.Functions">
    <exclude name="PSR12.Functions.ReturnTypeDeclaration.SpaceBeforeColon" />
  </rule>

  <rule ref="Modernize.FunctionCalls">
    <exclude name="Modernize.FunctionCalls.Dirname" />
  </rule>

  <!-- Keeping these ones: -->
  <rule ref="Generic.ControlStructures.InlineControlStructure"/>
  <rule ref="Generic.Debug.ClosureLinter"/>
  <rule ref="Generic.Files.ByteOrderMark"/>
  <rule ref="Generic.Files.LineEndings"/>
  <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
  <rule ref="Generic.Formatting.SpaceAfterCast"/>
  <rule ref="Generic.NamingConventions.ConstructorName"/>
  <rule ref="Generic.NamingConventions.UpperCaseConstantName"/>
  <rule ref="Generic.PHP.DeprecatedFunctions"/>
  <rule ref="Generic.PHP.LowerCaseConstant"/>
  <rule ref="Generic.PHP.LowerCaseKeyword"/>
  <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
  <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
  <rule ref="Generic.WhiteSpace.ScopeIndent">
    <properties>
      <property name="indent" value="4"/>
      <property name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT_OPEN_TAG"/>
    </properties>
  </rule>
  <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
  <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
    <properties>
      <property name="equalsSpacing" value="1"/>
      <property name="requiredSpacesAfterOpen" value="1"/>
      <property name="requiredSpacesBeforeClose" value="1"/>
    </properties>
  </rule>
  <rule ref="Squiz.PHP.DiscouragedFunctions"/>
  <rule ref="PEAR.Functions.FunctionCallSignature">
    <properties>
      <property name="requiredSpacesAfterOpen" value="1"/>
      <property name="requiredSpacesBeforeClose" value="1"/>
    </properties>
    <exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket"/>
    <exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine"/>
    <exclude name="PEAR.Functions.FunctionCallSignature.MultipleArguments"/>
  </rule>
  <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
  <rule ref="PEAR.NamingConventions.ValidClassName"/>
  <!--<rule ref="WordPress.NamingConventions.PrefixAllGlobals">-->
  <!--<properties>-->
  <!--<property name="prefixes" type="array" value="dt,Disciple_Tools" />-->
  <!--</properties>-->
  <!--</rule>-->

  <!-- Maybe these rules will be enabled in the future: -->
  <!-- <rule ref="Generic.Files.LineLength"/> -->
  <!-- <rule ref="Generic.Commenting.DocComment"/> -->

  <!-- Rejecting these ones: -->
  <!-- <rule ref="Generic.Commenting.Todo"/> -->
  <!-- <rule ref="Generic.CodeAnalysis.EmptyStatement"/> -->
  <!-- <rule ref="Generic.Formatting.MultipleStatementAlignment"/> -->
  <!-- <rule ref="Generic.Functions.OpeningFunctionBraceBsdAllman"/> -->
  <!-- <rule ref="Generic.PHP.DisallowShortOpenTag"/> -->
  <!-- <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/> -->
  <!-- <rule ref="PEAR.NamingConventions.ValidFunctionName"/> -->
  <!-- <rule ref="PEAR.NamingConventions.ValidVariableName"/> -->
  <!-- <rule ref="PSR2.Files.ClosingTag"/> -->
  <!-- <rule ref="Squiz.PHP.ForbiddenFunctions"/> -->
  <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>

  <rule ref="WordPress.Security.ValidatedSanitizedInput">
    <properties>
      <property name="customUnslashingSanitizingFunctions" type="array">
        <element value="dt_recursive_sanitize_array" />
      </property>
    </properties>
  </rule>

</ruleset>