Merge pull request #2452 from richardkorthuis/feature/NamingConventio…

…ns_ValidFunctionName_Documentation Add documentation for WordPress.NamingConventions.ValidFunctionName
WordPress · Jun 14, 2024 · d77b020 · d77b020
2 parents 29488fe + 17d67d0
commit d77b020
Showing 1 changed file with 39 additions and 0 deletions.
diff --git a/WordPress/Docs/NamingConventions/ValidFunctionNameStandard.xml b/WordPress/Docs/NamingConventions/ValidFunctionNameStandard.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
+    title="Valid Function Name"
+>
+    <standard>
+    <![CDATA[
+    Use lowercase letters in function names. Separate words using underscores. Do not use double underscores as a prefix.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Valid: lowercase function name.">
+        <![CDATA[
+function <em>prefix_function_name()</em> {}
+        ]]>
+        </code>
+        <code title="Invalid: mixed case function name.">
+        <![CDATA[
+function <em>Prefix_Function_NAME()</em> {}
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Valid: words separated by underscores.">
+        <![CDATA[
+class My_Class {
+    public static <em>method_name()</em> {}
+}
+        ]]>
+        </code>
+        <code title="Invalid: using camel case to separate words.">
+        <![CDATA[
+class My_Class {
+    public static <em>methodName()</em> {}
+}
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>