Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation for WordPress.DB.RestrictedClasses #2455

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

Add documentation for WordPress.DB.RestrictedClasses #2455

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions WordPress/Docs/DB/RestrictedClassesStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<?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 Classes and Methods"
>
<standard>
<![CDATA[
Avoid touching the database directly with PHP library classes and methods. Use the $wpdb object and associated functions instead.
]]>
</standard>
<code_comparison>
<code title="Invalid: Using the object-orientated mysqli interface">
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of the other code documentation files have the valid case first. Is there any reason this has the invalid cases first?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suspect that most remarks I left for #2453 will also apply to this sniff ?

<![CDATA[
$mysqli = new mysqli(
"example.com",
$db_user,
$db_pass,
$db_name
);

$result = <em>$mysqli->query</em>(
$mysqli,
"SELECT * FROM wp_posts LIMIT 5"
);
]]>
</code>
<code title="Valid: Use WordPress functions">
<![CDATA[
$result = <em>get_posts()</em>;
]]>
</code>
</code_comparison>
<code_comparison>
<code title="Invalid: Using the object-orientated PDO and PDOStatement interfaces to insert a post">
<![CDATA[
$pdo = new PDO(
$dsn,
$db_user,
$db_pass
);

$stmnt = $pdo->prepare(
"INSERT INTO wp_posts (post_title)
VALUES (?)"
);

$stmnt->execute( ['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>
Loading