phpcs.xml

<?xml version="1.0"?>
<ruleset name="AWPCP">
    <arg value="s" />

    <exclude-pattern>vendor/*</exclude-pattern>
    <exclude-pattern>tests/*</exclude-pattern>
    <exclude-pattern>bin/*</exclude-pattern>
    <exclude-pattern>stubs.php</exclude-pattern>
	<exclude-pattern>node_modules/*</exclude-pattern>
    <exclude-pattern>build/*</exclude-pattern>

    <rule ref="WordPress">
        <exclude name="Generic.WhiteSpace.DisallowSpaceIndent.SpacesUsed" />
        <exclude name="Generic.Commenting.DocComment" />
        <exclude name="Generic.Files.LineEndings.InvalidEOLChar" />
        <exclude name="Squiz.Commenting.FunctionComment" />
        <exclude name="WordPress.Files.FileName.InvalidClassFileName" />
        <exclude name="WordPress.Files.FileName.NotHyphenatedLowercase" />
        <exclude name="WordPress.PHP.YodaConditions.NotYoda" />
        <exclude name="Squiz.Commenting.VariableComment" />
        <exclude name="Squiz.Commenting.ClassComment" />
        <exclude name="Squiz.Commenting.FileComment" />
        <exclude name="Generic.Arrays.DisallowShortArraySyntax.Found" />
        <exclude name="Universal.Arrays.DisallowShortArraySyntax.Found" />
        <exclude name="Squiz.Commenting.BlockComment" />
        <exclude name="Squiz.Commenting.FunctionCommentThrowTag.Missing" />
        <exclude name="WordPress.NamingConventions.ValidHookName.UseUnderscores" />
        <exclude name="PEAR.NamingConventions.ValidClassName" />

        <!-- Temporary exclusions -->
        <exclude name="WordPress.WP.Capabilities.RoleFound" />
        <exclude name="WordPress.WP.I18n.MissingTranslatorsComment" />
        <exclude name="PEAR.Functions.FunctionCallSignature.SpaceAfterOpenBracket" />
        <exclude name="PEAR.Functions.FunctionCallSignature.SpaceBeforeCloseBracket" />
        <exclude name="PEAR.Files.IncludingFile.BracketsNotRequired" />
        <exclude name="NormalizedArrays.Arrays.ArrayBraceSpacing" />
        <exclude name="PEAR.Functions.FunctionCallSignature.MultipleArguments" />
        <exclude name="Squiz.ControlStructures.ControlSignature" />
        <exclude name="WordPress.Arrays.ArrayDeclarationSpacing" />
        <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.SpaceAfterFunction" />
        <exclude name="Squiz.PHP.EmbeddedPhp" />
        <exclude name="WordPress.WhiteSpace.ControlStructureSpacing" />
        <exclude name="WordPress.WhiteSpace.OperatorSpacing.NoSpaceAfter" />
        <exclude name="WordPress.WhiteSpace.OperatorSpacing.NoSpaceBefore" />
        <exclude name="WordPress.WhiteSpace.OperatorSpacing.SpacingBefore" />
        <exclude name="Generic.WhiteSpace.ArbitraryParenthesesSpacing" />
        <exclude name="Squiz.Functions.FunctionDeclarationArgumentSpacing" />
        <exclude name="WordPress.Arrays.ArrayKeySpacingRestrictions" />
        <exclude name="Generic.Functions.FunctionCallArgumentSpacing" />
        <exclude name="PEAR.Functions.FunctionCallSignature.ContentAfterOpenBracket" />
        <exclude name="PEAR.Functions.FunctionCallSignature.CloseBracketLine" />

        <exclude name="WordPress.WP.GlobalVariablesOverride.Prohibited" />
        <exclude name="WordPress.PHP.DontExtract.extract_extract" />
        <exclude name="Generic.ControlStructures.InlineControlStructure.NotAllowed" />
        <exclude name="Universal.Files.SeparateFunctionsFromOO.Mixed" />
        <exclude name="Generic.Files.OneObjectStructurePerFile.MultipleFound" />
        <exclude name="WordPress.NamingConventions.ValidVariableName.VariableNotSnakeCase" />
        <exclude name="Squiz.Strings.DoubleQuoteUsage.NotRequired" />
        <exclude name="Squiz.Commenting.InlineComment" />
    </rule>

    <rule ref="Generic.WhiteSpace.ScopeIndent">
        <properties>
            <property name="indent" value="4" />
            <property name="tabIndent" value="false" />
        </properties>
        <exclude name="Generic.WhiteSpace.ScopeIndent.Incorrect" />
        <exclude name="Generic.WhiteSpace.ScopeIndent.IncorrectExact" />
    </rule>

    <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>

    <rule ref="WordPress.Arrays.ArrayIndentation">
        <properties>
            <property name="tabIndent" value="false" />
        </properties>
    </rule>

    <rule ref="WordPress.WP.I18n">
		<properties>
			<property name="text_domain" type="array">
				<element value="another-wordpress-classifieds-plugin" />
			</property>
		</properties>
	</rule>

	<rule ref="WordPress.Security.EscapeOutput">
		<properties>
			<property name="customAutoEscapedFunctions" type="array">
                <element value="awpcp_esc_attr" />
                <element value="awpcp_esc_textarea" />
                <element value="awpcp_esc_plaintext" />
                <element value="wp_nonce_url" />
                <element value="awpcp_print_error" />
                <element value="awpcp_print_message" />
                <element value="awpcp_render_info_message" />
                <element value="awpcp_render_error_message" />
                <element value="awpcp_render_warning" />
                <element value="awpcp_render_categories_dropdown_options" />
                <element value="awpcp_html_hidden_fields" />
                <element value="awpcp_html_attributes" />
            </property>
		</properties>
	</rule>

    <!--
        Template files rely on variables passed in via extract() from the
        rendering layer. The static analyser cannot detect that, so we
        suppress NonPrefixedVariableFound globally for template directories
        instead of polluting every template with phpcs:ignore comments.
    -->
    <rule ref="WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedVariableFound">
        <exclude-pattern>*/templates/*</exclude-pattern>
        <exclude-pattern>*/admin/templates/*</exclude-pattern>
        <exclude-pattern>*/frontend/templates/*</exclude-pattern>
    </rule>

    <!--
        Installer and one-shot upgrade tasks only run during plugin
        activation or scheduled migrations. Caching adds no value to write
        operations or schema changes, so we exclude the NoCaching warning
        for those code paths.
    -->
    <rule ref="WordPress.DB.DirectDatabaseQuery.NoCaching">
        <exclude-pattern>installer.php</exclude-pattern>
        <exclude-pattern>*/includes/upgrade/*</exclude-pattern>
        <exclude-pattern>*/includes/cron/*</exclude-pattern>
        <exclude-pattern>*/includes/models/*</exclude-pattern>
        <exclude-pattern>*/includes/payment-term-fee.php</exclude-pattern>
        <exclude-pattern>*/includes/credit-plan.php</exclude-pattern>
        <exclude-pattern>*/includes/payment-terms-table.php</exclude-pattern>
        <exclude-pattern>*/includes/admin/class-list-table-restrictions.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/legacy.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/deprecated.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/routes.php</exclude-pattern>
    </rule>

    <!--
        Schema changes (ALTER TABLE, CREATE TABLE) are only performed by
        the installer and the upgrade task handlers. There is no caching
        layer to invalidate and no read path to migrate to, so the warning
        adds no value for those files.
    -->
    <rule ref="WordPress.DB.DirectDatabaseQuery.SchemaChange">
        <exclude-pattern>installer.php</exclude-pattern>
        <exclude-pattern>*/includes/upgrade/*</exclude-pattern>
    </rule>

    <!--
        AWPCP predates the introduction of the post meta layer, so model
        classes still talk to custom tables directly. The warning is kept
        on for ad-hoc query sites elsewhere in the codebase.
    -->
    <rule ref="WordPress.DB.DirectDatabaseQuery.DirectQuery">
        <exclude-pattern>installer.php</exclude-pattern>
        <exclude-pattern>*/includes/upgrade/*</exclude-pattern>
        <exclude-pattern>*/includes/cron/*</exclude-pattern>
        <exclude-pattern>*/includes/models/*</exclude-pattern>
        <exclude-pattern>*/includes/payment-term-fee.php</exclude-pattern>
        <exclude-pattern>*/includes/credit-plan.php</exclude-pattern>
        <exclude-pattern>*/includes/payment-terms-table.php</exclude-pattern>
        <exclude-pattern>*/includes/admin/class-list-table-restrictions.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/legacy.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/deprecated.php</exclude-pattern>
        <exclude-pattern>*/includes/functions/routes.php</exclude-pattern>
        <exclude-pattern>*/includes/class-awpcp.php</exclude-pattern>
        <exclude-pattern>functions.php</exclude-pattern>
        <exclude-pattern>*/admin/admin-panel.php</exclude-pattern>
    </rule>

    <!-- Check for cross-version support for PHP 5.6 and higher. -->
    <config name="testVersion" value="5.6-"/>
</ruleset>