WordPress.org

Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Справочник по функциям

Файлы WordPress содержат большое количество полезных PHP функций. Некоторые из функций, известные как Теги шаблонов, сделаны специально для использования в темах (шаблонах) WordPress. Также есть функции относящиеся к действиям (actions) и фильтрам (filters) (API плагинов), которые используются в основном для разработки плагинов. Остальные предназначены для функционирования ядра WordPress в целом.

Многие из функций ядра WordPress тоже могут быть полезны для разработчиков плагинов (например для уменьшения объема кода их работ), возможно также для разработчиков тем. Данная статья перечисляет большинство функций ядра по разделам; в описании некоторых функций могут встречаться внешние ссылки на более подробную документацию. В каждой функции указываются файлы, в которых она может быть найдена (файлы в директории wp-includes WordPress).

Примечание: Этот справочник относится к версии 2.1 и более поздним версиям WordPress и не включает в себя устаревшие функции. Незавершенная страница для версий 2.0.x может быть найдена здесь: Справочник по функциям 2.0.x (англ.)

Примечание: Функции специфичные для шаблонов, которые перечислены в статье Теги шаблонов и содержатся в файлах wp-includes/themes/*.php, здесь не перечислены.

Вы можете помочь сделать эту страницу более полной!

Ниже небольшой список действий, которые вы можете произвести, чтобы помочь развитию Wordpress:

  • Добавить документацию для недокументированных функций создав подстраницу или хотя бы добавив короткие комментарии в списки ниже. Если вы создали подстраницу для функции, пожалуйста, включите туда информацию и примеры использования, если возможно, то с примерами найденными в Тегах шаблонов.
  • Перечислить здесь больше функций, следуя структуре категорий.
  • Удалить определенные функции из списка, если вы думаете, что они не могут быть полезны для разработчиков плагинов или если они устарели.
  • Исправить ошибки перемещая функции в более подходящие для них категории и, конечно, опечатки. Примечание: это нормально, если функция находится в более чем одной категории.

Прочитайте Свой вклад в WordPress чтобы найти больше информации о том как вы можете приложить свои усилия чтобы сделать свой вклад в WordPress.


Функции по категориям

Функции Записей, Страниц, Вложений и Закладок

Записи

Вставка/удаление записи

Страницы

Произвольное поле (postmeta)

Вложения

Закладки

Другие

Функции Рубрик, Тегов и Таксономии

Рубрики


Создание рубрики

Теги

Таксономия

Функции Пользователя и Автора

Пользователи и Авторы

Пользовательские мета данные

Вставка/удаление Пользователя

Авторизация / Выход

Функции лент (комментариев/новостей и т.п)
Функции Комментариев, Пингов и Трекбеков
Функции Действий, Фильтров и Плагинов

Фильтры

Действия

Плагины

Шоткоды

Функции относящиеся к темам

Функции включения

Другие функции

Функции форматирования
Разные функции

Функции Времени/Даты

Сериализация

Опции

XMLRPC

Локализация

Cron (Планировщик)

Разное

Классы

Следующие классы были созданы разработчиками WordPress и находятся в файлах capabilities.php, classes.php, class-snoopy.php, locale.php, query.php, rewrite.php, script-loader.php, wp-db.php:

  • WP - обработка общих запросов
  • WP_Ajax_Response - обработка AJAX
  • WP_Object_Cache (в прошлом WP_Cache) - Кеш объектов (функции: wp_cache_add, wp_cache_close, wp_cache_delete, wp_cache_flush, wp_cache_get, wp_cache_init, wp_cache_replace, wp_cache_set)
  • WP_Error - обработка ошибок (и функция is_wp_error)
  • WP_Locale - управляет датой и локалями времени
  • WP_Query - Разбор запросов и управление ими, выборка записей (с функциями get_query_var, query_posts, have_posts, in_the_loop, rewind_posts, the_post, wp_old_slug_redirect, setup_postdata, а также Условные теги is_*)
  • WP_Rewrite - Правила перезаписи URL (функции: add_rewrite_rule, add_rewrite_tag, add_feed, add_rewrite_endpoint, url_to_postid)
  • WP_Roles, WP_Role, WP_User - Пользователи и их Возможности - map_meta_cap, current_user_can, get_role, add_role, remove_role
  • WP_Scripts - загрузка JavaScript (функции: wp_print_scripts, wp_register_script, wp_deregister_script wp_enqueue_script)
  • WP_Styles - загрузка CSS стилей (функции: wp_print_styles, wp_register_style, wp_deregister_style, wp_enqueue_style )
  • Отображение древовидных данных - Walker, Walker_Page, Walker_PageDropdown, Walker_Category, Walker_CategoryDropdown
  • wpdb - Интерфейс Базы Данных

Следующие классы были созданы сторонними разработчиками и могут быть найдены в файлах class-IXR.php, class-pop3.php, class-snoopy.php, gettext.php, rss.php, streams.php:

  • IXR - XML-RPC классы, включая IXR_Value, IXR_Message, IXR_Server, IXR_IntrospectionServer, IXR_Request, IXR_Client, IXR_ClientMulticall, IXR_Error, IXR_Date, IXR_Base64
  • Snoopy - HTTP клиент
  • gettext_reader (part of PHP-gettext) - класс Локализации
  • RSS классы (MagpieRSS и RSSCache) (функции: fetch_rss, is_info, is_success, is_redirect, is_error, is_client_error, is_server_error, parse_w3cdtf, wp_rss, get_rss)
  • POP3: обертка над SquirrelMail
  • StreamReader, StringReader, FileReader, CachedFileReader

Официальные и неофициальные справочники

  • WordPress.org PHPDoc - Почти все функции в Wordpress имеют "PHPDoc" заголовки, в которых находится краткое описание их работы. Сайт по ссылке дает возможность просмотреть эти заголовки в удобной форме.
  • Trac Browser - Исходный код WordPress. Выберите 'Tags' для поиска конкретной версии исходного кода, или 'Trunk' для просмотра последней версии.
  • PHPXref для WordPress - Сайт содержит связанные между собой перекрестными ссылками файлы Wordpress, его функции и переменные, которые обычно относятся к последней версии релиза. (Предоставляет удобную навигацию по файлам, функциям и переменным) This redalt.com PHPXref site has the bleeding-edge Trunk version, as well as 1.5 and 2.0, but the Trunk version may not be updating any more. So, there is now a new Trunk Xref site on ftwr.co.uk available.
  • WordPress Function History Table - Список всех функций WordPress с указанием версий, в которых они появились или перешли в раздел «Устаревшие». PlanetOzh рекомендует: "используйте похожий инструмент WordPress Functions Implementation History Tool для более подробной информации (и как более функциональный)"
  • WordPress Variable Report - Список функций WordPress, список версий PHP, которую требует каждая функция, какие переменные/аргументы в функциях уже не используются и какие функции/переменные содержит каждый класс (а также их значения по-умолчанию).
  • WordPress Hooks Table - Список хуков (actions & filters) WordPress со ссылками на файлы, в которых они находятся.
Эта страница помечена как незавершённая. Вы можете помочь проекту, дополнив её.