Skip to content

1. Основные принципы, установка

Mikhail Kobzarev edited this page Mar 29, 2023 · 1 revision

Репозиторий https://github.com/mihdan/wp-oop-settings-api - это библиотека для работы с API настроек WordPress, которая использует принципы объектно-ориентированного программирования (ООП). Она позволяет легко создавать страницы настроек для плагинов и тем WordPress, используя ООП-кодирование вместо традиционного процедурного подхода.

Основные принципы этой библиотеки:

  • Использование объектов и классов: API настроек реализуется с помощью объектов и классов, что обеспечивает более гибкий и расширяемый код.
  • Разделение логики и представления: разделение кода на модель, представление и контроллер позволяет создавать настраиваемые страницы настроек без дублирования кода.
  • Использование шаблонов: библиотека поддерживает шаблоны для создания страниц настроек с использованием различных типов полей ввода, таких как текстовые поля, чекбоксы и выпадающие списки.
  • Гибкость и расширяемость: API настроек можно легко расширить путем создания собственных классов для определенных типов полей или настроек.

Для использования этой библиотеки в плагине необходимо следующее:

  1. Скопировать файлы библиотеки в папку плагина.
  2. Создать класс настроек, который наследует основной класс API настроек.
  3. Определить настройки, используя методы класса API настроек, такие как add_section() и add_field().
  4. Создать страницу настроек, используя метод add_settings_page() и передав ему экземпляр класса настроек.

Пример использования этой библиотеки можно найти в папке examples, который находится в корне репозитория.

Для установки библиотеки WP OOP Settings API можно использовать Composer или NPM. Вот инструкции для каждого из этих менеджеров пакетов:

Установка с помощью Composer

  1. Установите Composer на свой компьютер, если он еще не установлен.
  2. Откройте командную строку и перейдите в корневую директорию вашего проекта.
  3. Введите следующую команду: composer require mihdan/wp-oop-settings-api
  4. Дождитесь окончания установки.

Установка с помощью NPM

  1. Установите NPM на свой компьютер, если он еще не установлен.
  2. Откройте командную строку и перейдите в корневую директорию вашего проекта.
  3. Введите следующую команду: npm install wp-oop-settings-api
  4. Дождитесь окончания установки.

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