From a6e6fa2675570106665f26e7cff9428575373a5f Mon Sep 17 00:00:00 2001
From: Rafael Funchal <rafaelfunchal@gmail.com>
Date: Tue, 17 Sep 2024 15:18:04 -0700
Subject: [PATCH] Adding documentation to WordPress.WP.DiscouragedConstants

---
 .../Docs/WP/DiscouragedConstantsStandard.xml  | 49 +++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 WordPress/Docs/WP/DiscouragedConstantsStandard.xml

diff --git a/WordPress/Docs/WP/DiscouragedConstantsStandard.xml b/WordPress/Docs/WP/DiscouragedConstantsStandard.xml
new file mode 100644
index 000000000..901709cfe
--- /dev/null
+++ b/WordPress/Docs/WP/DiscouragedConstantsStandard.xml
@@ -0,0 +1,49 @@
+<?xml version="1.0"?>
+<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
+    title="Discouraged Constants"
+    >
+    <standard>
+    <![CDATA[
+    The usage of WordPress Constants is discouraged.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: A function is used in the code to retrieve the theme directory.">
+        <![CDATA[
+<img src="
+<?php echo <em>get_template_directory_uri()</em>; ?>
+/img/logo.svg" />
+        ]]>
+        </code>
+        <code title="Invalid: The TEMPLATEPATH constant is used in the code.">
+        <![CDATA[
+<img src="
+<?php echo <em>TEMPLATEPATH</em>;?>
+/img/logo.svg" />
+        ]]>
+        </code>
+    </code_comparison>
+    <standard>
+    <![CDATA[
+    Defining WordPress Constants is discouraged.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: A function is used in the code to retrieve the theme directory.">
+        <![CDATA[
+<img src="
+<?php echo <em>get_template_directory_uri()</em>; ?>
+/img/logo.svg" />
+        ]]>
+        </code>
+        <code title="Invalid: The TEMPLATEPATH constant is set by a theme.">
+        <![CDATA[
+<em>define("TEMPLATEPATH", "foo");</em>
+<img src="
+<?php echo <em>$foo</em>; ?>
+/img/logo.svg" />
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>