Объективные лучшие практики разработки плагинов?

Тестирование вашего плагина

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

Основываясь на этом ответе от Итана Зайферта на вопрос о тестировании, вот хорошие практики, которым стоит следовать:

• Модульные тесты должны проверять минимально возможное поведение, которое может выполнять класс.
• На уровне функционального тестирования вы можете тестировать ваш код с зависимостями WordPress.
• В зависимости от функционала вашего плагина — рассмотрите возможность использования тестов на основе Selenium, которые проверяют наличие данных в DOM с помощью ID.

Забота о будущих версиях WordPress и темы

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

Проверяйте, устарели ли функции непосредственно в вашей теме.

Это пример, "как это может выглядеть".

if ( ! function_exists( 'wp_some_fn' ) ) 
{
    $theme_data = wp_get_theme();
    $error = new WP_Error( 'wp_some_fn', sprintf( __( 'Функция %1$s устарела. Пожалуйста, сообщите автору', TEXTDOMAIN ), "Тема: {$theme_data->Name}: Версия {$theme_data->Version}" );

    // прерывание
    if ( is_wp_error( $error ) )
        return print $error->get_error_message();
} 
// иначе, если нет ошибки - функция работает и существует
wp_some_fn();

Для правильной/лучшей практики обработки ошибок см. этот ответ: ссылка

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

Используйте осмысленные имена

Давайте осмысленные имена хукам и фильтрам (классам, функциям и переменным), чтобы люди могли идентифицировать их даже через год, когда уже не помнят, откуда взялся этот кусочек кода. Не имеет значения, если имена хуков/фильтров получатся длинными. Например: youruniquename_hook/filter_whatitdoes.

• Если ваш файл содержит класс с именем "dbdbInit", то файл, содержащий этот класс, должен называться "dbdbInit.class.php".
• Если внутри вашего класса dbdbInit есть функция, которая регистрирует, например, пользовательские типы записей, назовите её register_custom_post_types().
• Если у вас есть массив, содержащий имена пользовательских типов записей, назовите переменную, в которой хранится этот массив, $custom_post_type_names.
• Если у вас есть функция, обрабатывающая массив, назовите её function array_handler( $array ) { // обработать массив}.
• Просто старайтесь называть вещи так, чтобы по имени было понятно, что они делают или к чему относятся.

Ещё один совет: если вам приходится отлаживать код, в 99% случаев вы получаете сообщения не только для своего кода, но и для WordPress. Поэтому старайтесь использовать один и тот же префикс, например "dbdb", для своих классов, публичных функций и переменных/объектов. Так вы сможете легко найти их среди сотен файлов. (WordPress загружает 64 файла до вашей темы и около 1,550 функций, не говоря уже о хуках и фильтрах.)

Отделение от основного кода WordPress

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

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

Использование wp options для строк вывода плагина

Для того чтобы сделать плагин простым в использовании и настройке, все строки вывода должны быть изменяемыми. Лучший способ реализовать это - использовать wp-options для хранения строк вывода и предоставить интерфейс для изменения значений по умолчанию. Плагин не должен использовать отображаемые строки, которые нельзя легко изменить через бэкенд плагина.

Пример: Sociable - предоставляет возможность изменить фразу, которая появляется перед иконками "поделиться и насладиться:"

Используйте хуки удаления, активации и деактивации

Для этого существуют три разных хука:

• Удаление register_uninstall_hook();
• Деактивация register_deactivation_hook();
• Активация register_activation_hook();

Подробная инструкция с рабочим примером доступна здесь..