Посібник із покращення стандартів кодування WordPress
Якщо ви розробник, то, безумовно, ви прагнете вдосконалити свої стандарти кодування. Кожна мова програмування та їх CMS / Frameworks встановили свої власні стандарти кодування. У цій статті ми вивчаємо, як вдосконалити стандарти кодування WordPress.
Ми написали статтю про вдосконалення стандартів кодування PHP. Спочатку слід перевірити цю статтю, перш ніж приступати до стандартів кодування для розробки WordPress.
Помилки, які ми робимо під час програмування WordPress
Кожна розробка має різні рішення. Можливо, кожен розробник реалізує різний спосіб / логіку для отримання однакових результатів. Це природно у світі програмування.
Наприклад, скажімо, ми додали nonce у нашу форму реєстрації, щоб уникнути атак CSRF.
<form method="post">
<?php wp_nonce_field( 'signup_nonce', 'signup_form_nonce' ); ?>
</form>Подаючи форму, ми повинні перевірити, чи правильний nonce чи ні. Зазвичай розробник, який не знає про стандарти кодування, робить це наступним чином.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( $_POST['signup_form_nonce'], 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>У наведеному вище коді немає нічого поганого. Але це погана практика. Отримуючи значення текстового поля, ми повинні використовувати sanitize_text_field()та wp_unslash()функціонувати на значеннях поля введення.
Метод sanitize_text_field виконує наступний процес у фоновому режимі.
- Перевірки на наявність недійсних UTF-8
- Перетворює одиничні <символи в сутність
- Видаляє всі теги
- Видаліть розриви рядків, вкладки та зайвий пробіл
- Смужкові октети
Метод wp_unsplash видаляє скісні риски з рядка або масиву рядків.
Сказавши це, наш попередній код повинен сподобатися нижче.
<?php
if (! isset( $_POST['signup_form_nonce']) ||! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['signup_form_nonce']) ), 'signup_nonce')) {
print 'Sorry, your nonce did not verify.';
exit;
} else {
// process form data
}
?>Це один із прикладів. Є ще кілька помилок, які ми робимо в програмуванні WordPress.
Встановіть бібліотеку стандартів кодування WordPress
Ця бібліотека допоможе нам вдосконалити наші стандарти кодування в розробці WordPress і встановити нас як кращого розробника WordPress.
Щоб встановити цю бібліотеку, відкрийте командний рядок у кореневому каталозі проекту та запустіть наведену нижче команду.
composer create-project wp-coding-standards/wpcs --no-dev
Примітка: Для запуску наведеної вище команди у вашій системі повинен бути встановлений композитор.
Після запуску команди вона створить папку з назвою ‘wpcs’ у вашому кореневому каталозі проекту.
Ми припускаємо, що ви прочитали нашу статтю про вдосконалення стандартів кодування PHP, і ви встановили бібліотеку PHP_CodeSniffer всередині папки ‘php_codesniffer’ в кореневому каталозі проекту.
Далі нам потрібно зареєструвати стандарти WordPress у конфігурації PHP_CodeSniffer. Відкрийте командний рядок у розділі ‘php_codesniffer / vendor / bin’ і запустіть команду нижче.
phpcs --config-set installed_paths /path/to/wpcs
Замініть ‘/ path / to / wpcs’ вашим шляхом. У нашому випадку на платформі Windows ми пишемо команду наступним чином.
phpcs --config-set installed_paths D:wampwwwwp1wpcs
Давайте з’ясуємо наші помилки та вдосконалимо стандарти кодування WordPress
Ми встановили з нашою бібліотекою. Тепер настав час знайти свої помилки та уникнути їх наступного разу.
Скажімо, ми створили плагін ‘test-plugin’ і ми повинні перевірити файл під назвою ‘core.php’.
Відкрийте командний рядок у каталозі ‘wpcs / vendor / bin’ і запустіть команду нижче.
phpcs --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Після запуску команди ви отримаєте запит про помилки та попередження. Усі ці помилки та попередження видно, оскільки ми не дотримувались стандартних практик кодування для розробки WordPress.
Хороша частина полягає в тому, що ми отримуємо детальний звіт про номери рядків та способи виправлення конкретної помилки. Нам просто потрібно вивчити рекомендації та виправити помилки по черзі.
phpcbf команда також може виправити деякі незначні помилки, такі як відступ, пробіли тощо.
phpcbf --standard=WordPress D:wampwwwwp1wp-contentpluginstest-plugincore.php
Ми сподіваємось, ви розумієте, як використовувати бібліотеку стандартів кодування WordPress для вдосконалення стандартів кодування WordPress. Якщо у вас є якісь запитання чи пропозиції, залиште коментар нижче.