Статьи

Стандарты кодирования WordPress: введение

Когда дело доходит до создания продуктов на основе WordPress, мы несколько прокляты (или благословенны, в зависимости от того, как вы это видите) с обоюдоострым мечом: поскольку WordPress написан на PHP, относительно легко получить WordPress — или Сам проект — делать все, что мы хотим, все время избегая лучших практик.

Но возникает вопрос: какой смысл в API или формальных стандартах кодирования, если мы просто собираемся их игнорировать?

Мы много писали об API WordPress в предыдущих статьях, и мы затронули стандарты кодирования WordPress, но мы никогда не углублялись в стандарты кодирования, не понимали каждый их аспект и почему они иметь значение.

Так что в этой серии мы собираемся делать именно это.


Прежде чем взглянуть на все, что мы собираемся охватить, я думаю, что важно понять, почему стандарты кодирования имеют значение.

WordPress широко используется многими людьми, использующими множество сайтов. Там используется много кода, который построен поверх основного приложения. Это означает, что есть разработчики и дизайнеры, которые работают над поддержанием этих баз кода.

Проблема возникает, когда человек, который изначально не писал код, застрял в улучшении, управлении и исправлении ошибок в проекте. Предположим, что первый человек не следовал стандартам кодирования, но тот, кто сейчас поддерживает код, привык к передовым методам.

Теперь им приходится иметь дело с кодом, который совсем не похож на код WordPress.

И это действительно суть вопроса: код, который составляет наши темы, наши плагины и наши приложения, в идеале должен выглядеть так, как будто один разработчик написал код.

Вот что обеспечивают стандарты кодирования.

К сожалению, стандарты либо игнорируются, либо недостаточно проповедуются, несмотря на то, что они хорошо документированы. Вот где эта серия статей вступает в игру: мы собираемся подробно изучить каждый из стандартов, чтобы евангелизировать, понимать и побуждать друг друга начать делать лучшую работу.


Эта серия будет включать семь статей в дополнение к этой вводной части.

Вот где мы движемся с этой конкретной серией:

  1. Соглашения об именах и аргументы функций. Мы посмотрим, как мы должны называть наши переменные, методы и классы так, чтобы они были понятными, простыми для понимания и понятными для нас и других разработчиков.
  2. Использование одинарных кавычек и двойных кавычек — одинарные кавычки и двойные кавычки приводят к различному поведению в PHP, и в WordPress есть время и место для использования. В этой статье мы рассмотрим примеры каждого из них и обоснование того, что мы делаем.
  3. Отступы, использование пробелов и конечные пробелы — пробелы играют большую роль в написании кода на основе WordPress. В этой статье мы рассмотрим причины, по которым отступы и пробелы имеют значение, а также когда использовать вкладки и когда использовать пробелы.
  4. Стиль скобок, регулярные выражения и теги PHP — разные языки стиля C используют разный синтаксис. В этой статье мы рассмотрим, как правильно разместить фигурные скобки в коде на WordPress. Мы также собираемся изучить правильный способ включения регулярных выражений, а также некоторые полезные советы и рекомендации по использованию тегов PHP.
  5. Тернарный оператор и условия Yoda — условные операторы являются краеугольным камнем программирования и широко используются в WordPress. PHP предлагает ярлык для операторов if / else, а WordPress предпочитает оценивать условные выражения иначе, чем те, которые часто поддерживают другие языки. Здесь мы рассмотрим все вышеперечисленное.
  6. Запросы к базе данных и форматирование запросов SQL. Существует полный API для выполнения запросов к базе данных WordPress, но также есть способы запуска необработанного SQL. Если вам когда-нибудь нужно идти по этому пути, есть верный способ сделать это. В этой статье мы рассмотрим именно это.
  7. Объединяя все вместе — Наконец, мы собираемся обобщить все, что мы обсуждали на протяжении всей серии, чтобы убедиться, что мы все на одной странице, и призвать нас двигаться вперед с лучшей работой, придерживаясь стандарты.

Когда дело доходит до ведения блога, часто предполагается, что автор является экспертом в данной теме, но правда в том, что, хотя я твердо верю, что мы должны следовать стандартам кодирования и что я стараюсь придерживаться их в меру своих возможностей Я изучаю вещи каждую неделю.

Я много раз нарушал стандарты кодирования, и я уверен, что некоторые из вас тоже.

Цель этой серии — вместе пройтись по стандартам, чтобы мы могли стать лучшими разработчиками, как только закончим.