From a289638ec355dae93264e89c9b7ca0da668207a9 Mon Sep 17 00:00:00 2001
From: Paul Wong-Gibbs <djpaul@gmail.com>
Date: Thu, 13 Jun 2024 11:40:14 +0200
Subject: [PATCH] Add documentation for WordPress.DB.RestrictedFunctions

See #1722
---
 .../Docs/DB/RestrictedFunctionsStandard.xml   | 53 +++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 WordPress/Docs/DB/RestrictedFunctionsStandard.xml

diff --git a/WordPress/Docs/DB/RestrictedFunctionsStandard.xml b/WordPress/Docs/DB/RestrictedFunctionsStandard.xml
new file mode 100644
index 0000000000..c0c01a1ccc
--- /dev/null
+++ b/WordPress/Docs/DB/RestrictedFunctionsStandard.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0"?>
+<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
+    title="Restricted Database Functions"
+    >
+    <standard>
+    <![CDATA[
+      Avoid touching the database directly with PHP library functions. Use the $wpdb object and associated functions instead.
+    ]]>
+    </standard>
+    <code_comparison>
+        <code title="Invalid: Using MySQLi library to fetch posts">
+        <![CDATA[
+$results = <em>mysqli_query</em>(
+    $mysql,
+    "SELECT * FROM wp_posts LIMIT 5" 
+);
+        ]]>
+        </code>
+        <code title="Valid: Use WordPress functions">
+        <![CDATA[
+$results = <em>get_posts()</em>;
+        ]]>
+        </code>
+    </code_comparison>
+    <code_comparison>
+        <code title="Invalid: Using MySQLi library to insert a post">
+        <![CDATA[
+<em>mysqli_query</em>(
+    $mysql,
+    "INSERT INTO wp_posts (post_title)
+    VALUES ('Title')" 
+);
+        ]]>
+        </code>
+        <code title="Valid: Use WordPress functions">
+        <![CDATA[
+<em>wp_insert_post</em>( 
+    array( 'post_title' => 'Title' )
+);
+
+// or...
+
+global $wpdb;
+<em>$wpdb->insert</em>( 
+    "{$wpdb->prefix}_posts",
+    array( 'post_title' => 'Title' ),
+    array( '%s' ) 
+);
+        ]]>
+        </code>
+    </code_comparison>
+</documentation>