WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru
Главная Функции Прочие функции

Рубрика: Прочие функции

Файловая система (WP_Filesystem)

copy_dir()

Копирует папку из одного места в другое, используя API файловой системы WordPress. Предполагается, что функция WP_Filesystem() уже была вызвана и сконфигурирована.

list_files()

Получит список файлов из указанной директории и из всех вложенных в нее директорий (до 100 уровней вложенности).

unzip_file()

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

Регистрация script и style

add_editor_style()

Подключает файл стилей css для визуального редактора TinyMCE.

wp_add_inline_script()

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

wp_add_inline_style()

Добавляет дополнительный блок CSS стилей. CSS добавляются прямо в html документ, после основных (указанных) стилей.

wp_dequeue_script()

Отменяет подключение скрипта, который был добавлен в очередь ранее.

wp_deregister_script()

Удаляет ранее зарегистрированный скрипт.

wp_enqueue_code_editor()

Подключает все необходимое (скрипты, стили, настройки, языки) для использования встроенного в WordPress редактора кода.

wp_enqueue_editor()

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

wp_enqueue_media()

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

wp_enqueue_script()

Правильно подключает скрипт (JavaScript файл) на страницу.

wp_enqueue_style()

Правильно добавляет файл CSS стилей. Регистрирует файл стилей, если он еще не был зарегистрирован.

wp_localize_jquery_ui_datepicker()

Локализует (переводит) jQuery скрипт выбора даты: jQuery UI datepicker.

wp_localize_script()

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

wp_register_script()

Регистрирует файл скрипта, чтобы в дальнейшем подключать его используя функцию wp_enqueue_script(), которая сохраняет последовательность загрузки скриптов.

wp_register_style()

Регистрирует CSS файл в WordPress. После регистрации файл можно добавить в html документ с помощью функции wp_enqueue_style().

wp_script_add_data()

Добавляет данные к подключенным на странице скриптам с помощью wp_enqueue_script(). Используйте когда, например нужно выводить скрипт только для «IE 6» или «lt IE 9» (меньше IE 9).

wp_script_is()

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

wp_style_add_data()

Добавляет данные для подключаемых с помощью wp_enqueue_style() файлов стилей. Используйте когда, например нужно подключить стили только для IE.

wp_style_is()

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

Опции сайта (настройки)

add_option()

Добавляет настройку (название и значение опции) в Базу Данных. Ничего не делает, если опция уже существует.

admin_url()

Получает URL админ-панели сайта. Учитывает протоколы (http и https).

delete_option()

Удаляет настройки (запись из таблицы wp_options в БД).

get_bloginfo()

Возвращает информацию о блоге из настроек. Копия bloginfo(), только эта функция получает результат в переменную, а не выводит его на экран.

get_home_url()

Получает УРЛ-ссылку на главную страницу сайта, без закрывающего слэша. Можно указать ID сайта в сети. Идентична функции home_url().

get_option()

Получает значение указанной настройки (опции).

get_site_url()

Получает URL сайта.

home_url()

Возвращает УРЛ главной страницы сайта. Учитывает протокол SSL.

is_ssl()

Проверяет используется ли защищенный протокол HTTPS (SSL). Условный тег.

site_url()

Получает URL сайта (где установлено ядро движка WordPress) с соответсвующим протоколом (https, если срабатывает условие is_ssl).

update_option()

Обновляет значение опции (настройки) в базе данных. Ожидает не экранированную строку.

wp_load_alloptions()

Загружает в кэш все авто-загружаемые опции WordPress. Получает все опции сайта.

Временные опции (transients)

delete_expired_transients()

Удаляет все просроченные временные опции (транзитные опции).

delete_transient()

Удаляет временную опцию.

get_transient()

Получает значение временной опции.

set_transient()

Устанавливает или обновляет временную опцию.

Основной запрос WP

add_query_arg()

Добавляет указанные параметры GET запроса в текущий или указанный URL.

get_queried_object()

Получает текущий объект запроса (полная информация о посте, метках, рубриках и т.д.).

get_queried_object_id()

Получает ID текущего объекта запроса. Это может быть: запись, рубрика, метка, другой элемент таксономии, архив автора.

get_query_var()

Получает переменные запроса (параметры запроса) из WP_Query, который устанавливается в глобальную переменную $wp_query.

get_search_query()

Получает поисковой запрос (строку).

get_status_header_desc()

Получает описание указанного кода HTTP статуса ответа сервера, например 404.

is_embed()

Проверят является ли запрос запросом на страницу встраивания записи (embede).

is_robots()

Проверяет запрос ли это к файлу robots.txt. Условные тег.

redirect_canonical()

Проверяет текущий URL (запрос) и определяет нужно ли перенаправить на другой URL или нет.

remove_query_arg()

Удаляет указанные параметры GET запроса из URL: ?parametr=value&param2=val2.

wp{}

Устанавливает основной запрос (среду WordPress).

Дата/время

calendar_week_mod()

Преобразовывает введенное число в дни с начала недели: введем 8, получим 1 (8-7), 15=1 (15-7*2).

current_time()

Возвращает текущее время сайта, учитывается настройка временной зоны на сайте (timezone). В каком формате вернуть результат можно указать произвольно. mysql: YYYY-MM-DD HH:MM:SS, unix: 1335820033, произвольный формат: d. M. Y.

get_calendar()

Выводит календарь на экран (по умолчанию текущий месяц).

get_date_from_gmt()

Переводит дату в часовом поясе GMT/UTC в локальный часовой пояс сайта. Принимает дату в формате Y-m-d H:i:s.

get_gmt_from_date()

Переводит локальную дату сайта (исходя из настроек временной зоны) в часовой пояс GMT/UTC. Принимает дату в формате Y-m-d H:i:s.

get_weekstartend()

Получает штамп времени (timestamp) начала и конца недели, к которой относится указанная дата.

human_time_diff()

Определяет разницу между двумя переданными метками времени и возвращает результат в формате удобном для чтения: 1 минута, 5 часов, 10 дней, 3 месяца, 1 год (1 min, 5 hours, 10 days). Относительные даты.

mysql2date()

Переводит дату из формата MySQL (Y-m-d H:i:s) в указанный формат. Формат указывается идентично функции date() в PHP.

Вспомогательные

__return_empty_array()

Просто возвращает пустой массив: array(). Вспомогательная функция WordPress.

__return_empty_string()

Просто возвращает пустую строку: ''. Вспомогательная функция WordPress.

__return_false()

Просто возвращает false. Вспомогательная функция WordPress.

__return_null()

Просто возвращает null. Вспомогательная функция WordPress.

__return_true()

Просто возвращает true. Вспомогательная функция WordPress.

__return_zero()

Просто возвращает 0. Вспомогательная функция WordPress.

build_query()

Собирает строку параметров запроса URL из переданного простого/ассоциативного массива.

get_page_hierarchy()

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

get_temp_dir()

Получает директорию (папку) на сайте в которую можно записывать (сохранять) временные файлы.

is_email()

Проверяет является ли переданная строка e-mail адресом.

is_serialized()

Проверяет переданное значение, является ли оно сериализованной строкой.

is_serialized_string()

Проверяет находится ли "строка" в переданных сериализованных данных. Т.е. была ли серриализованна отдельная строка.

map_deep()

Применяет указанную функцию к значениям переданного массива/объекта. Рекурсивная функция.

maybe_serialize()

Сериализует переданные данные, если нужно.

maybe_unserialize()

Десериализует переданное значение, если оно сериализовано или просто возвращает переданное значение.

path_join()

Объединяет (склеивает) два переданных системных пути в один, если второй указанный путь не абсолютный, иначе просто вернет второй путь.

seems_utf8()

Проверяет строку, написана ли она в UTF-8 кодировке.

stripslashes_deep()

Проходит по массиву, объекту, скаляру и удаляет экранирующие слэши (\) у строковых значений.

timer_stop()

Получает или выводит время выполнения PHP скрипта с момента начала генерации страницы и до момента вызова этой функции.

urlencode_deep()

Проходит по всем элементам массива и обрабатывает все значения функцией urlencode(). Можно передать строку.

wp_array_slice_assoc()

Оставляет в переданном массиве только элементы, ключи которого совпадают со значениями элементов второго массива.

wp_basename()

Получает последний компонент из указанного пути или URL, получает все что после последнего /. Копия PHP функции basename() только дружественна к локализации (l18n).

wp_debug_backtrace_summary()

Получает трассировку с названиями функций — список названий всех функций/методов, которые были вызваны для того, чтобы добраться до текущего места в коде (откуда была вызвана эта функция).

wp_doing_ajax()

Проверяет, является ли текущий запрос AJAX запросом WordPress.

wp_extract_urls()

Использует регулярное выражение, чтобы «вытащить» все ссылки (URL) из переданного текста.

wp_filter_object_list()

Фильтрует массив объектов по указанным параметрам (key=>value) и получает объекты из переданного массива, которые подходят под указанные критерии.

wp_generate_uuid4()

Генерирует случайных код UUID (уникальную строку), состоящий из букв и цифр. Создает UUID (Universally unique identifier) версии 4.

wp_html_split()

Разбирает переданный текст (в виде HTML кода) на HTML теги и комментарии, возвращает массив значений: теги и их текст.

wp_is_numeric_array()

Определяет является ли переданная переменная массивом с числовыми индексами.

wp_is_uuid()

Проверяет, является ли указанная строка UUID строкой.

wp_json_encode()

Кодирует переданную переменную в JSON формат. Проверяет строки и переводит их в UTF-8.

wp_kses_array_lc()

Переводит все ключи указанного массива в нижний регистр (ABC в abc). Ключи вложенных массивов также обрабатываются.

wp_kses_hair()

Получает список атрибутов html тега (в виде массива) из переданной строки с атрибутами.

wp_kses_uri_attributes()

Получает список HTML-атрибутов, в которых (по спецификации) должен указываться URL-адрес.

wp_list_filter()

Фильтрует массив объектов и получает из массива те объекты, которые подходят по указанным параметрам (key=>value).

wp_list_pluck()

Собирает в массив указанное поле из вложенных массивов многомерного массива.

wp_list_sort()

Сортирует массив объектов или массив массивов по одному или нескольким полям.

wp_make_link_relative()

Изменяет переданный УРЛ: делает из него относительный. Удаляет http или https протокол и домен, оставляя / в начале: http://site.ru/foo станет /foo

wp_mkdir_p()

Рекурсивное создание директории (папки) по указанному пути. Задает права родителей создаваемым папкам.

wp_normalize_path()

Заменяет обратные слэши (в windows) на прямые слэши и двойные слэши на одинарные.

wp_parse_args()

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

wp_parse_id_list()

Обрабатывает/очищает массив чисел (ID) или строку где числа разделены запятыми или пробелами. Вернет массив чисел.

wp_parse_slug_list()

Создает массив ярлыков из строки слов разделенных запятыми, пробелами. Значения массив очищается через sanitize_title(). Можно сразу передать массив, чтобы просто его очистить.

wp_parse_str()

Разбирает, парсит строку запроса, например, foo=1&foo2=2 и создает из нее массив данных.

wp_parse_url()

Разбирает переданный URL на компоненты. Унифицирует работу PHP функции parse_url() (обёртка для неё).

wp_rand()

Генерирует случайное число между указанных min и max.

wp_reset_vars()

Устанавливает указанные переменные как глобальные (global), если они указаны в $_GET / $_POST запросе.

wp_send_json()

Кодирует переданную переменную в JSON, печатает результат на экран (echo) и обрывает работу скрипта (die). Используется для возврата данных при AJAX запросах.

wp_send_json_error()

Возвращает JSON данные. Используется для возврата ошибок в AJAX запросах. Ответ будет всегда содержать элемент success=false. Обрывает работу php скрипта (die).

wp_send_json_success()

Возвращает JSON данные. Используется для возврата успешных ответов в AJAX запросах. Ответ будет всегда содержать элемент success=true. Обрывает работу php скрипта (die).

wp_slash()

Добавляет слэши (\), экранирует строку или массив строк.

wp_spaces_regexp()

Возвращает регулярное выражение совпадающее со всеми видами пробелов (переносы строк, невидимые символы и т.д.).

wp_sprintf()

Вариант PHP функции sprintf() от WordPress. Поддерживает %l (list - список) в передаваемом формате.

wp_tempnam()

Создает пустой временный перезаписываемый файл с уникальным именем во временном каталоге. После использования файл обязательно нужно удалить с помощью unlink();

wp_unslash()

Удаляет слэши из переданной строки, или из строковых элементов переданного массива или свойств объекта. Массив может быть любой вложенности.

wp_validate_boolean()

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

Админ-панель

add_menu_page()

Добавляет пункт (страницу) верхнего уровня в меню админ-панели (в один ряд с постами, страницами, пользователями и т.д.).

add_meta_box()

Добавляет дополнительные блоки (meta box) на страницы редактирования/создания постов, постоянных страниц или произвольных типов записей в админ-панели.

add_options_page()

Добавляет дочернюю страницу (подменю) в меню админ-панели «Параметры» (Settings).

add_submenu_page()

Добавляет дочернюю страницу (подраздел) указанного главного меню в админ-панели.

add_theme_page()

Добавляет подменю в меню "внешний вид" (Appearance) в админ-панели.

do_meta_boxes()

Выводит любые метабоксы зарегистрированные для страницы админ-панели и определенного контекста, с помощью функции add_meta_box().

get_admin_url()

Получает ссылку (URL) к админ-части сайта.

get_current_screen()

Возвращает объект данных о странице админ-панели. Т.е. получает данные о текущем экране в админ-панели WordPress.

includes_url()

Получает URL на папку wp-includes с учетом протокола https.

is_admin()

Проверяет находится ли пользователь в админ-панели сайта (консоль или любая другая страница админки). Условный тег.

remove_menu_page()

Удаляет пункты меню верхнего уровня (записи, медиафайлы, ссылки, страницы) в админ-панели.

remove_meta_box()

Удаляет Блоки на страницах редактирования/создания постов, постоянных страниц и произвольных типов записей.

remove_submenu_page()

Удаляет подпункт пункта меню в админ-панели WordPress. Например, Параметры->Постоянные ссылки.

wp_add_dashboard_widget()

Добавляет виджет (метабокс) в консоль (основная страница админ-панели сайта, мультисайта).

wp_maintenance()

Прекращает работу сайта и выводит сообщение о технических работах (сайт в режиме разработки).

Защита

check_admin_referer()

Проверяет, был ли текущий запрос отправлен со страницы админки. Также, проверяется проверочный код nonce. В случае ошибки обрывает работу скрипта.

check_ajax_referer()

Проверяет Ajax запрос, на соответствие nonce коду. Обрывает работу скрипта через die, если проверка не пройдена.

wp_create_nonce()

Создает уникальный защитный ключ на короткий промежуток времени (от 12 до 24 часов).

wp_generate_password()

Генерирует случайный пароль. Можно указать длину и символы для генерации.

wp_hash()

Хеширует переданную строку и возвращает полученный хэш-код.

wp_hash_password()

Шифрует переданный текст. Шифр всегда получается уникальный. Используется для шифрования паролей.

wp_http_validate_url()

Проверяет можно ли безопасно использовать указанный URL в HTTP запросе, например в HTTP API.

wp_kses_post()

Очищает переданную строку, оставляя в ней HTML теги разрешенные для публикации в записи для текущего пользователя.

wp_nonce_ays()

Останавливает выполнение сценария PHP и выводит заглушку: "Вы уверены, что хотите сделать это?".

wp_nonce_field()

Выводит проверочное (защитное, одноразовое) скрытое поле для формы.

wp_nonce_url()

Добавляет в URL проверочный ключ nonce, который используется для защиты: ?_wpnonce=9d6bd884a1.

wp_referer_field()

Создает скрытое поле формы input со значением URL текущей страницы, чтобы затем проверить это значение через HTTP_REFERER.

wp_salt()

Получает секретный ключ (salt), который добавляется в хэш.

wp_sanitize_redirect()

Очищает указанный URL, чтобы его можно было безопасно использовать при редиректах.

wp_verify_nonce()

Проверяет переданный проверочный код nonce.

Ссылки (закладки, блогролл)

edit_bookmark_link()

Выводит ссылку на редактирование текущей закладки (ссылки), если пользователь авторизирован и имеет право на редактирование.

get_bookmark()

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

get_bookmarks()

Получает массив данных о ссылках блогролла (Админка -> Ссылки -> Ссылки).

wp_list_bookmarks()

Выводит на экран список ссылок, указанных на странице "Администрирование > ссылки".

SQL

dbDelta()

Создает или изменяет таблицы базы данных на основе переданного SQL запроса на создание таблицы.

esc_sql()

Подготавливает строку к использованию в SQL запросе. Защищает от SQL инъекций. Может принимать массив строк для обраотки.

get_meta_sql()

По переданным параметрам создает JOIN и WHERE части SQL запроса для метаданных, которые можно использовать в основном запросе.

get_num_queries()

Получает количество запросов которое было сделано к базе данных WordPress до момента вызова этой фукнции.

get_posts_by_author_sql()

Функция вернет WHERE часть SQL запроса, в котором будет учитываться статус записи 'private' для авторизованных пользователей.

like_escape()

Используйте взамен wpdb::esc_like(). Подготавливает строку для использования в LIKE выражении SQL запроса. С версии 4.0 считается устаревшей!

sanitize_sql_orderby()

Проверяет можно ли использовать переданную строку в ORDER BY части SQL запроса.

Метаданные

add_metadata()

Добавляет мета (дополнительные) данные к любому объекту (запись, комментарий, пользователь).

delete_metadata()

Удаляет метаданные указанного объекта (пост, юзер, коммент).

get_metadata()

Получает метаданные указанного объекта (пост, комментарий, пользователь).

is_protected_meta()

Проверяет указанный ключ метаполя, не является ли он защищенным (внутренним).

register_meta()

Регистрирует метаполе (ключ произвольного поля).

sanitize_meta()

Очищает значение мета данных. Сама функция ничего не делает, а примеряет фильтр "sanitize_{$meta_type}_meta_{$meta_key}", через который разные мета данные можно очистить по-разному.

update_metadata()

Обновляет метаданные для указанного объекта (пост, юзер, коммент). Если указанных данных не найдено, то они будут добавлены, как новые.

Без рубрики

cache_javascript_headers()

Устанавливает заголовки (headers) для Javascript файла и кэширует его на 10 дней.

do_robots()

Выводит на экран контент для файла robots.txt. Устанавливает HTTP заголовок файла. С её помощью создается динамический файл robots.txt.

download_url()

Загружает файл (УРЛ) во временный каталог PHP, работает на основе HTTP класса WordPress.

is_blog_installed()

Проверяет установлен ли сайт. Проверяется наличие опции siteurl и таблиц в базе данных. Результат кэшируется.

is_wp_error()

Проверяет переданную переменную является ли она специальной ошибкой (объектом WP_Error).

maybe_convert_table_to_utf8mb4()

Конвертирует поля таблицы в кодировку utf8mb4_unicode_ci, если в таблице есть поля с кодировкой utf8_ или utf8mb4_.

nocache_headers()

Устанавливает заголовки, которые предотвращают кэширование во всех браузерах.

show_admin_bar()

Позволяет отключить "Панель инструментов" (Админ Бар). Технически функция включает/отключает "Панель" для лицевой части (фронтэнда). В админ-панели "Панель" отключить невозможно.

wp_check_browser_version()

Проверяет нужно ли обновить браузер пользователя.

wp_die()

Останавливает выполнение PHP скрипта и выводит отформатированное HTML сообщение.

wp_editor()

Выводит на экран поле формы textarea со стандартным визуальным и HTML редактором WP (TinyMCE). Можно использовать в шаблоне, на страницах типа: запись, постоянная страница и т.д.

wp_magic_quotes()

Изменяет глобальные переменные $_GET, $_POST, $_REQUEST, $_COOKIE, $_SERVER - добавляет в их значения волшебные кавычки.

wp_mail()

Отправляет письмо на почту. Похожа на mail() в PHP.

wp_oembed_get()

Встраивает объект по УРЛ. Пытается получить HTML код из переданного УРЛ на основе поддерживаемых oEmbed WordPress.

wp_redirect()

Перенаправляет (редиректит) на указанный УРЛ, можно указать статус редиректа (301, 302...).

wp_safe_redirect()

Безопасное перенаправление. Перенаправляет с помощью wp_redirect() предварительно проверив хост на наличие в базе разрешенных хостов.

wp_star_rating()

Выводит HTML рейтинга (звездочки) для указанного рейтинга.

wp_timezone_choice()

Получает удобный список временных зон в формате <option> для использования в <select>.

Помощники для форм (form)

checked()

Используется в checkbox и radio полях формы. Сделана для удобства, проверяет два значения и если они совпадают выводит атрибут checked='checked' для текущего поля формы.

disabled()

Сравнивает два переданных значения и если они совпадают выводит на экран атрибут "disabled" для поля html формы.

form_option()

Выводит на экран очищенное значение указанной опции сайта. Используется при выводе значения опции для value атрибута тега input.

readonly()

Сравнивает 2 значения, если они совпадают выводит строку readonly='readonly'. Используется для тега <input>.

selected()

Сравнивает 2 значения, если они совпадают выводит строку "selected='selected'". Для использования в выпадающем списке <select>, в теге <option>.

Emoji (эмодзи)

wp_encode_emoji()

Конвертирует эмодзи (emoji) символы в переданной строке в их HTML код (&#x1f31b).

wp_staticize_emoji()

Конвертирует emoji символы в переданном тексте в html элементы <img>.