Чтобы код WordPress везде был оформлен в одном стиле и удобно читался в ядре, плагинах и темах, рекомендуется соблюдать стандарты написания кода, которые приняты разработчиками WordPress. Эти стандарты очень похожи на стандарт PEAR , однако есть и кардинальные отличия. Рекомендую ознакомится с ними и при создании плагинов или тем, по возможности, их соблюдать.

Кроме стандартов к написанию самого кода PHP, также есть стандарты документирования кода - это комментарии к функциям и хукам: PHP Documentation Standards (англ.)

Одинарные и двойные кавычки

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

Echo "Link name"; echo "$linkname";

Вторая строка в этом примере не очищает выводимые переменные, а это необходимо делать в целях безопасности. Поэтому для такой записи, переменные должны быть очищены заранее. В целом, такую запись можно считать неприемлемой! См. раздел учебника безопасный вывод .

Отступы

Отступ должен всегда показывать логическую структуру кода. Используйте табуляцию (клавиша Tab), а не пробелы - это дает больше гибкости. Пробелы стоит использовать, когда нужно выравнять что-либо внутри строки.

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

If (условие) { $foo = "somevalue"; $foo2 = "somevalue2"; $foo_bar = "somevalue3"; $foo5 = "somevalue4"; }

А так код выглядит, если показать невидимые символы табуляции и пробела:

If (условие) { ---$foo.....= "somevalue"; ---$foo2....= "somevalue2"; ---$foo_bar.= "somevalue3"; ---$foo5....= "somevalue4"; }

Для ассоциативных массивов, значения должны начинаться с новой строки. Рекомендуется ставить «последнюю» запятую при перечислении элементов массива - так удобнее добавлять новые элементы...

$my_array = array(---"foo"...=> "somevalue", ---"foo2"..=> "somevalue2", ---"foo3"..=> "somevalue3", ---"foo34".=> "somevalue3",);

Стиль фигурных скобок

Фигурные скобки должны использоваться для всех блоков в стиле, как показано ниже:

If (условие) { action1(); action2(); } elseif (условие2 && условие3) { action3(); action4(); } else { defaultaction(); }

Если идет длинный блок, его по возможности нужно разбить на два или более коротких блоков или функций. Если такой длинный блок необходим, добавьте краткий комментарий в конце, чтобы можно было понять, что именно закрывает фигурная скобка. Такой подход логично применять для блока с 35 и более строк.

Следует комментировать любой код, который интуитивно не понятен.

Используйте фигурные скобки всегда, даже если они не требуются.

If (условие) { action0(); } if (условие) { action1(); } elseif (условие2) { action2a(); action2b(); } foreach ($items as $item) { process_item($item); }

Обратите внимание, что требование использовать фигурные скобки всегда означает, что одиночные конструкции в стиле одной строки - запрещены.

$var = "dangerous""; // необработанные данные, которые могут быть экранированы или не экранированы $id = some_foo_number(); // данные ожидаются как число, но мы не уверены $wpdb->query($wpdb->prepare("UPDATE $wpdb->posts SET post_title = %s WHERE ID = %d", $var, $id));

%s используется для строк и %d для целых чисел. Обратите внимание, что они не "в кавычках" ! $wpdb->prepare() сам экранирует строки и добавляет кавычки, если надо. Преимущество prepare() в том, что не нужно помнить о ручном использовании esc_sql() , а также, что строка запроса с плейсхолдерами более наглядна, чем если бы там использовались переменные обернутые в esc_sql() .

Запросы базы данных

Старайтесь не писать прямых запросов к базе данных. Если есть подходящая функция, а их в WP много, которая может получить необходимые данные - используйте ее.

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

Имена классов, функций, файлов, констант, переменных

Имена функций, переменных, хуков

Используйте строчные буквы a-z в переменных, хуках и названиях функций и никогда CamelCase . Разделяйте отдельные слова нижним подчеркиванием _ . Не сокращайте имена переменных без необходимости; пусть код будет однозначным и само-документированным.

Function some_name($some_variable) { [...] }

Имена классов

Нужно использовать слова с Заглавных_Букв, разделенные подчеркиванием. Любые сокращения (акронимы, аббревиатуры) должны быть ПРОПИСНЫМИ.

Class Walker_Category extends Walker { [...] } class WP_HTTP { [...] }

Константы должны быть словами в ВЕРХНЕМ_РЕГИСТРЕ, разделенные нижним подчеркиванием:

Define("DOING_AJAX", true);

Названия файлов

Должны быть понятные и должны также содержать только строчные буквы, а слова должны разделяться дефисом - .

My-plugin-name.php

Названия файлов классов

Должны быть основаны на имени класса с приставкой class- , подчеркивания в имени класса заменены дефисом, например WP_Error становится:

Class-wp-error.php

Этот стандарт именования файлов справедлив для всех существующих и новых файлов с классами. Однако существуют файлы исключения: class.wp-dependencies.php , class.wp-scripts.php , class.wp-styles.php . Эти файлы имеют префикс class. , точка после слова class вместо дефиса.

Понятные значения переменных в параметрах функций

Булевам, предпочтительны строковые значения. Т.е. вместо true/false при вызове функций лучше использовать какую-то объясняющую значение параметра строку.

Плохой код:

Function eat($what, $slowly = true) { ... } eat("mushrooms"); eat("mushrooms", true); // что означает true? eat("dogfood", false); // что означает false, противоположность true?

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

Хороший код:

Function eat($what, $speed = "slowly") { ... } eat("mushrooms"); eat("mushrooms", "slowly"); eat("dogfood", "quickly");

Когда нужно больше параметров функции, используйте массив $args . Он даже лучше!

Очень хороший код:

Function eat($what, $args) { ... } eat("noodles", array("speed" => "moderate"));

Интерполяция для имен динамических хуков

Для удобства чтения и обнаружения, хуки с переменными в названии должны быть интерполирован (заключен в фигурные скобки { и }), и не должны конкатенироваться:

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

// правильно do_action("{$new_status}_{$post->post_type}", $post->ID, $post); // неправильно do_action($new_status ."_". $post->post_type, $post->ID, $post);

Там, где это возможно, динамические значения в именах тегов также должны быть максимально краткими и точными. $user_id гораздо понятнее чем, скажем, $this->id .

Тернарный оператор

Тернарные операторы хороши, но в них рекомендуется всегда проверять правдивое утверждение, а не ложное. Иначе он просто вводит в заблуждение из-за двойного отрицания. Исключение - это использование! empty() , потому что по-другому иногда просто сложно записать.

Как нужно проверять:

// (если условие выполняется = true) ? (то делаем это) : (иначе это); $music_type = ("jazz" == $music) ? "cool" : "blah"; // (если значение не пустое - ! empty) ? (то делаем это) : (иначе это);

Как не следует писать:

// (если условие не выполняется!= true) ? (то делаем это) : (иначе это); $music_type = ("jazz" != $music) ? "blah" : "cool";

Условия Магистра Йоды

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

If (true == $the_force) { $victorious = you_will($be); }

Если пропустить второй знак = в приведенном примере (признаться, это происходит даже с самыми опытными из нас), то мы получим ошибку PHP и сразу её увидим, потому что код не будет работать. А вот если бы конструкция была обратной - $the_force = true , то условие всегда будет выполняться и никакой ошибки мы не увидим, и можем пропустить такой серьезный баг, который к тому же иногда сложно отловить!

К такому «перевернутому» написанию просто нужно привыкнуть.

Это относится и к == , != , === и!== . «Условия Йоды» для < , > , <= или >= значительно труднее читать и тут их лучше не использовать.

Умный код

Если говорить коротко, то читаемость кода должна быть на первом плане, она важнее краткости или каких-то не очевидных, но удобных сокращений.

Isset($var) || $var = some_function(); // или! isset($var) && $var = some_function();

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

If (! isset($var)) { $var = some_function(); }

Оператор подавления ошибок @

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

В то время как этот оператор существует в ядре, он часто используется потому что лень нормально обработать переменную. Его использование настоятельно не рекомендуется , так как даже PHP документация заявляет:

Внимание: На сегодняшний день оператор "@" подавляет вывод сообщений даже о критических ошибках, прерывающих работу скрипта. Помимо всего прочего, это означает, что если вы использовали "@" для подавления ошибок, возникающих при работе какой-либо функции, в случае если она недоступна или написана неправильно, дальнейшая работа скрипта будет остановлена без каких-либо уведомлений.

Flector 5

WP-Syntax

Несколько раз в комментариях меня спрашивали, что за плагин я использую для вставки кода в текст статей и комментариев. Так вот, отвечаю - это WP-Syntax . На самом деле плагинов для вставки кода не один десяток и какой именно из этих плагинов использовать решать только вам. Мне же понравился WP-Syntax тем, что он очень прост в использовании, поддерживает синтаксис кучи языков программирования, а также умеет исправлять испорченный визуальным редактором код, преобразовывая HTML -коды символов в сами символы.

Скачиваем плагин с его домашней страницы и устанавливаем его:

1. Распаковываем архив.

2. Копируем папку wp-syntax в /wp-content/plugins/ .

3. Заходим в админку блога на вкладку "Плагины " и активируем плагин.

Никаких настроек в плагине нет и после активации плагина вы уже можете начать вставлять код в ваши статьи. Правильный синтаксис вставки кода выглядит так:

Код

, где LANGUAGE это обозначение языка программирования, а line="1" это необязательный параметр, указывающий плагину включить нумерацию строк кода с указанного номера. Список обозначения языков программирования вы можете посмотреть , но для большинства языков обозначение будет равно названию языку (php , java , css , perl , sql и др.). Примеры использования:

1. PHP , без нумерации строк.

\\ n" ; } ?>

2. JAVA , c нумерацией строк.

1 2 3 4 5

public class Hello { public static void main(String args) { System .out .println ("Hello World!" ) ; } }

public class Hello { public static void main(String args) { System.out.println("Hello World!"); } }

3. Ruby , c нумерацией строк, начиная с 18 строки.

18 19 20 21 22

class Example def example(arg1) return "Hello: " + arg1.to_s end end

class Example def example(arg1) return "Hello: " + arg1.to_s end end

Одна из интересных особенностей плагина состоит в том, что он умеет преобразовать HTML -коды символов в сами символы. То есть с этой функцией вам не придется беспокоиться насчет того, что визуальный редактор испортит вам вставленный код (сами теги

 и 

должны быть вставлены не в визуальном редакторе). Для этого надо использовать параметр escaped="true" и тогда код вида:

 
Hello
 

превратится в:

> Hello>

Hello

Если честно, то про эту функцию с escaped="true" я узнал совсем недавно, а до этого мне приходилось хранить весь используемый код в отдельном текстовом файле и вставлять его лишь после полного написания статьи и перед нажатием кнопки "Опубликовать ". После того, как я оценил удобство использования этой функции на другие плагины подсветки синтаксиса мне даже и смотреть не хочется:)

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

#button { font-weight: bold; border: 2px solid #fff; }

Чтобы получить результат, аналогичный приведенному выше фрагменту, заключите свой код в эти теги:

Ваш код

Параметр «language» определяет язык и правила подсветки синтаксиса. Поддерживаются следующие значения:

• actionscript3
• coldfusion
• csharp
• delphi
• erlang
• fsharp
• groovy
• javascript
• javafx
• matlab
• powershell
• python
• scala

Если значение параметра «language» не задано, используется значение «text» (без подсветки синтаксиса).
Код между тегами «code» будет автоматически закодирован для отображения, поэтому вам не стоит беспокоиться об элементах HTML или о чем-либо подобном.

Параметры конфигурации

Теги также поддерживают множество параметров конфигурации, которые можно использовать для настройки внешнего вида. Их применение совсем необязательно.

• autolinks (true/false) — Каждый URL в коде отображается как гиперссылка. Значение по умолчанию: true.
• collapse (true/false) — Если задано значение true, при загрузке страницы область кода будет свернута. Для того, чтобы развернуть ее, нужно будет кликнуть по ней. Это полезно для больших фрагментов кода. По умолчанию задано значение false.
• firstline (номер) — Определяет, с какого числа начинается нумерация строк. Значение по умолчанию: 1.
• gutter (true/false) — Если задано значение false, номера строк будут скрыты. Значение по умолчанию: true.
• highlight (номера, разделенные запятыми) — Номера строк, которые будут выделены, например, «4,7,19».
• hmtlscript (true/false) — Если задано значение true, выполняется подсветка HTML/XML-кода. Это полезно при публикации смешанного кода, например, PHP внутри HTML. Работает только с некоторыми языками. Значение по умолчанию: false.
• light (true/false) — Если задано значение true, номера строк и панель инструментов будут скрыты. Это полезно при размещении фрагмента кода из одной-двух строк. Значение по умолчанию: false.
• padlinenumbers (true/false/целое число) — Позволяет контролировать дополнение номеров строк нулями. Значение true задает автодополнение, значение false отключает дополнение, число задает фиксированное количество знаков для номеров строк.
• toolbar (true/false) — Если задано значение false, при наведении на код не будет появляться панель инструментов с кнопками. Значение по умолчанию: true.
• wraplines (true/false) — Если задано значение false, будет отключен перенос строк. При наличии длинных строк появится горизонтальная полоса прокрутки.
• title (строка) – заголовок для кода. Может быть полезным в сочетании с параметром collapse .

Примеры использования вышеописанных параметров:

Эта строка не выделена. Эта строка выделена. Эта строка выделена. Эта строка не выделена. Это короткий фрагмент кода с дополнением номеров строк нулями до 4 знаков. //В этом примере отключен перенос строк. Чтобы прочитать текст полностью, вам придется воспользоваться полосой прокрутки. Кроме того, в данном примере отключена нумерация строк и спрятана панель инструментов.

А это фрагмент кода побольше. Здесь выбран язык PHP и выделена строка номер 12.

WordPress.com Code Example

WordPress.com Code Example

Эта строка выделена. Очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень-очень длинная строка. WordPress.com

Благодарности
Для реализации данной возможности используется проект SyntaxHighlighter (автор Alex Gorbatchev) . Пользователи могут установить соответствующий

Всех начинающих вебмастеров пугает и отталкивает работа с кодом – они опасаются навредить своему сайту, добавляя в него HTML или PHP, вставив его не в том место. Конечно же, если в WordPress код поставить не туда, то можно и всё испортить. Однако эта CMS настолько хорошо заточено под новичков, что ошибиться будет сложно.

В данной статье мы рассмотрим, как без риска вставить в WordPress код HTML или PHP. Но для начала – зачем это может пригодиться.

Зачем вставлять в WordPress код

У вебмастера в течение жизни сайта может возникнуть нужда установить на WordPress код, который должен выполняться на страницах. Это может понадобиться от разнообразных причин: например, установить счётчик посещаемости, какой-нибудь необычный виджет, добавить шаблону индивидуальности.

WordPress предлагает два способа установки кода. Рассмотрим их.

Установка с помощью виджета «Текст»

Для того, что бы установить на WordPress код с помощью виджета, необходимо перейти в пункт меню в консоли «Внешний вид», и подпункт «Виджеты». Среди следует найти «Текст» и переместить его в нужную область мышкой.

Виджет раскроется и можно будет заполнить его заголовок, а также поместить необходимый код в соответствующее поле. После нажатия на кнопку «Сохранить», операция будет выполняться на страницах сайта.

Данный способ установки на WordPress кода подходит для выполнения операций на HTML, PHP и даже JavaScript. Этот метод часто используется, так как он лёгок, и он хорошо подходит новичкам.

Установка в файл

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

Чтобы установить на WordPress код непосредственно в файл, требуется знать, за какую область сайта отвечает тот или иной файл. Здесь нельзя дать точных рекомендаций, так как в разных шаблонах разные файлы выполняют те или иные функции. Однако кое-что о файлах тем, вы можете узнать . Кроме установки на WordPress кода в файл шаблона, это можно сделать и в файлы самой CMS.

WordPress – это одна из самых популярных CMS. Изначально WordPress создавался как блоговый движок, но из-за популярности данной системы управления сайтом разработано множество дополнений и плагинов, что позволяет создавать различные виды сайтов. Конечно, как и в других движках в WP, много разных подводных камней, о которых нужно знать вебмастеру.

Основные функции движка WordPress

В документации WordPress несколько сотен PHP-функций, но большинство из них используется очень редко при решении каких-то специфических задач. Я отобрал небольшое количество функций WordPress, которые применяются чаще всего при разработке тем и виджетов...

Заголовок H1 в WordPress

В этой статье рассмотрим, как избежать дублирования заголовка первого уровня H1 в WordPress. Есть известное правило, что заголовок первого уровня H1 должен быть только один на странице, но большинство тем оформления WordPress сделано таким образом, что H1 ...

Создание виджетов WordPress

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

Как очистить head в WordPress от ненужного кода?

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

Бесконфликтное подключение скриптов и стилей в WordPress

Бесконфликтный метод необходим по нескольким причинам: предотвращает конфликт при подключении одного скрипта разными плагинами. При таком подключении метод позволяет объединить несколько js файлов в один и отдавать в сжатом виде браузеру для оптимизации...