Skip to content

Commit 6bb0180

Browse files
richardkorthuisrichardkorthuis
committed
Add documentation for WordPress.NamingConventions.ValidFunctionName
1 parent 29488fe commit 6bb0180

File tree

1 file changed

+119
-0
lines changed

1 file changed

+119
-0
lines changed

‎WordPress/Docs/NamingConventions/ValidFunctionNameStandard.xml

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<?xml version="1.0"?>
2+
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3+
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
4+
title="Valid Function Name"
5+
>
6+
<standard>
7+
<![CDATA[
8+
Use lowercase letters in function names. Separate words using underscores. Do not use double underscores as a prefix.
9+
]]>
10+
</standard>
11+
<code_comparison>
12+
<code title="Valid: lowercase function name.">
13+
<![CDATA[
14+
prefix_function_name();
15+
]]>
16+
</code>
17+
<code title="Invalid: mixed case function name.">
18+
<![CDATA[
19+
Prefix_Function_NAME();
20+
]]>
21+
</code>
22+
</code_comparison>
23+
<code_comparison>
24+
<code title="Valid: words separated by underscores.">
25+
<![CDATA[
26+
prefix_function_name();
27+
]]>
28+
</code>
29+
<code title="Invalid: using camel case to separate words.">
30+
<![CDATA[
31+
prefixFunctionName();
32+
]]>
33+
</code>
34+
</code_comparison>
35+
<code_comparison>
36+
<code title="Valid: function name with single underscore prefix.">
37+
<![CDATA[
38+
_prefix_function_name();
39+
]]>
40+
</code>
41+
<code title="Invalid: function name with double underscore prefix.">
42+
<![CDATA[
43+
__prefix_function_name();
44+
]]>
45+
</code>
46+
</code_comparison>
47+
<code_comparison>
48+
<code title="Valid: lower case method name.">
49+
<![CDATA[
50+
$object->prefix_method_name();
51+
]]>
52+
</code>
53+
<code title="Invalid: mixed case method name.">
54+
<![CDATA[
55+
$object->Prefix_Method_NAME();
56+
]]>
57+
</code>
58+
</code_comparison>
59+
<code_comparison>
60+
<code title="Valid: words separated by underscores.">
61+
<![CDATA[
62+
$object->prefix_method_name();
63+
]]>
64+
</code>
65+
<code title="Invalid: using camel case to separate words.">
66+
<![CDATA[
67+
$object->prefixMethodName();
68+
]]>
69+
</code>
70+
</code_comparison>
71+
<code_comparison>
72+
<code title="Valid: method name with single underscore prefix.">
73+
<![CDATA[
74+
$object->_prefix_method_name();
75+
]]>
76+
</code>
77+
<code title="Invalid: method name with double underscore prefix.">
78+
<![CDATA[
79+
$object->__prefix_method_name();
80+
]]>
81+
</code>
82+
</code_comparison>
83+
<code_comparison>
84+
<code title="Valid: lower case static method name.">
85+
<![CDATA[
86+
My_Class::prefix_static_method_name();
87+
]]>
88+
</code>
89+
<code title="Invalid: mixed case static method name.">
90+
<![CDATA[
91+
My_Class::Prefix_Static_Method_NAME();
92+
]]>
93+
</code>
94+
</code_comparison>
95+
<code_comparison>
96+
<code title="Valid: words separated by underscores.">
97+
<![CDATA[
98+
My_Class::prefix_static_method_name();
99+
]]>
100+
</code>
101+
<code title="Invalid: using camel case to separate words.">
102+
<![CDATA[
103+
My_Class::prefixStaticMethodName();
104+
]]>
105+
</code>
106+
</code_comparison>
107+
<code_comparison>
108+
<code title="Valid: static method name with single underscore prefix.">
109+
<![CDATA[
110+
My_Class::_prefix_static_method_name();
111+
]]>
112+
</code>
113+
<code title="Invalid: static method name with double underscore prefix.">
114+
<![CDATA[
115+
My_Class::__prefix_static_method_name();
116+
]]>
117+
</code>
118+
</code_comparison>
119+
</documentation>

0 commit comments

Comments
 (0)