Статьи

API настроек WordPress, часть 1: что это такое и почему это важно

Как мы уже неоднократно упоминали здесь, на WP Tuts (и, как вы, несомненно, заметили), никогда не было лучшего времени для разработчика WordPress. Будь то работа с клиентом или разработка продукта (с темами или плагинами), начало работы в экосистеме WordPress — это скорее вопрос «где», а не «как».

WordPress имеет звездную документацию API для разработчиков, независимо от уровня опыта. Но активное сообщество разработчиков и хорошо документированный API не делают платформу невосприимчивой к плохим практикам разработки.

Как и в большинстве аспектов веб-разработки, то, что что-то работает, не означает, что оно было построено правильно. Но как разработчики и мастера, мы должны убедиться, что работа, которую мы выпускаем, работает и построена правильно. Изучение исходного кода для различных тем или плагинов показывает, что разработчики выпускают продукты, которые работают, но которые не спроектированы наилучшим образом. Это особенно верно в отношении параметров темы, страниц меню, проверки и т. Д.

И мы хотим это остановить.

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

Наша конечная цель — сделать эту серию надежным справочным материалом для API настроек независимо от вашего уровня опыта. К концу у вас должно быть четкое понимание API и убедительные примеры того, как все делать правильно.

Чтобы быть полным, нам нужно начать с нуля. Поэтому прежде чем писать какой-либо код или прорабатывать какие-либо примеры, нам необходимо представить API настроек, что это такое и почему это важно.


API настроек определен

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

Достаточно просто, правда?

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

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

Общается с WordPress Core

API настроек предоставляется разработчиками платформы WordPress для упрощения расширения приложения. Не имеет ли смысла использовать функции, предоставляемые авторами самой платформы?

Конечно, вполне возможно обойти эти функции и «грубой силой» нашу собственную функциональность, и никто больше не сможет ее остановить, но это требует ненужной работы от нашего имени, игнорирует рекомендации команды WordPress Core и может в конечном итоге нарушить целостный опыт. приборной панели.

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

Бесплатный материал Out-Of-The_Box

Использование API настроек — это не только гарантия того, что мы подходим к разработке по рекомендованным каналам. Речь идет также о том, чтобы наши пользовательские интерфейсы следовали передовым практикам платформы и чтобы наши данные подвергались дезинфекции с использованием тех же механизмов, что и остальная часть WordPress. Не повредит, что это может сэкономить нам много времени.

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

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

По общему признанию, использование собственных стилей WordPress не является истинной частью API настроек, и вышеизложенное представляет собой некоторую субъективную перспективу, но аспекты API настроек — такие как представление страниц меню — используют собственные стили WordPress. Разве не имеет смысла, что остальная часть вашей работы должна последовать их примеру?

Более безопасный, более устойчивый

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

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

Предстоящая дорожная карта

На этом этапе вы должны четко понимать, что такое API настроек и почему вы должны использовать его в работе с темами и плагинами.

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

  • Меню, разделы и вкладки навигации
  • Регистрация разделов настроек
  • Примитивные элементы (входы, текстовые области, селекторы, переключатели и флажки)
  • Простой, рабочий пример

К концу серии у вас должно быть все, что нужно для создания надежных продуктов на основе WordPress.