WordPress: Функции для работы с путями

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

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

    <link rel="shortcut icon" href="http://xxx.xx/ ... " />
    

Итак поехали:

1. Перейдите в каталог плагинов WordPress: wp-content/plugins
2. Создайте новую директорию для плагина под названием favicon
3. Найдите подходящее изображение 16x16 и сохраните его в папке плагина под именем favicon.png
4. Зайдите в директорию плагина и создайте php-файл: favicon.php
5. Откройте ваш новый файл в редакторе кода и добавьте заголовок в верхней части файла плагина:

   /*
       Plugin Name: Plugin Header favicon
       Plugin URI:
       Description: Этот плагин добавляет favicon в хедер страницы.
       Version: 1.0
       Author: Somebody
       Author URI: http://xxxxxx.xx/
       License: GPLv2
   */
   

6. Добавьте следующую строку кода, чтобы зарегистрировать функцию, которая будет вызываться когда WordPress подготавливает блок head страницы:

   add_action ('wp_head', 'page_header_favicon');
   

7. Далее реализуем функцию page_header_favicon:

   function page_header_favicon() {
       $icon_url = plugins_url( '/wordpress/122-funkcii-dlya-raboty-s-putyami.html/favicon.ico', __FILE__ ) ?>
       <link rel="shortcut icon" href="<?php echo $icon_url ?>" />
   <?php }
   

8. Сохраните и закройте файл плагина. Больше кода в нем не будет.
9. Идем в админку нашего сайта во вкладку Plugins
10. Находим наш плагин в списке и активируем его
11. Теперь перейдите на главную страницу вашего сайта и обновите её чтобы увидеть что браузер показывает ваш значок favicon

Как это работает...

Функция plugins_url - это утилитарная функция, используется в сочетании с PHP константой __FILE__ и именем файла нашего значка favicon. plugins_url - дает нам возможность быстро получить URL-адрес в директорию плагина. Функция plugins_url может вызываться с параметрами или без. В первом случае функция вернет строку: URL-адрес, добавив путь, переданный в качестве первого параметра в расположении файла указанном в качестве второго аргумента. Во второй ситуации (без параметров) функция вернет строку: местоположение каталога плагина.

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

• get_theme_root() : Возвращает адрес директории куда устанавливаются темы (wp-content/themes)
• get_template_directory_uri(): Возвращает URI в директорию текущей активной темы
• admin_url(): Возвращает URI в директорию wp-admin (http://xxxxx.xx/wp-admin/)
• content_url(): Возвращает URI в директорию wp-content (http://xxxxx.xx/wp-content)
• site_url() и home_url(): Возвращает адрес сайта
• includes_url(): Возвращает URI в директорию wp-includes (http://xxxxx.xx/wp-includes/)
• wp_upload_dir(): Вернет массив, где хранится информация о директориях с файлами, загруженные пользователем

Более полный список утилитарных функций для работы с путями в WordPress

Предыдущие статьи этого цикла:

1. WordPress: С чего начинаются плагины
2. WordPress: Добавление контента в тег head страниц

На этом пока все, комментарии как всегда приветствуются...