Записи: посты, страницы, ... (рубрика)
Что такое записи и что в них особенного в структуре движка WordPress, смотрите в статье о записях в WordPress. Ознакомившись со статьей вы хорошо будете представлять что из себя представляют записи и какое место они занимают в структуре движка.
| edit_post_link() | Выводит ссылку (html) на редактирование поста, если пользователю разрешено изменять пост. |
| get_delete_post_link() | Получает ссылку (URL) на удаление поста. |
| get_edit_post_link() | Получает ссылку (URL) на редактирование записи в админ-панели. |
| get_permalink() | Получает постоянную ссылку на запись, для дальнейшего использования в php. |
| get_post_field() | Получает значение любого поля данных поста по переданному ID поста: |
| get_post_status() | Получает статус указанной записи/поста: publish, draft и т.д. |
| get_post_time() | Получает время публикации записи в указанном формате (по умолчанию метку времени unix). Используется внутри цикла WordPress. |
| get_sample_permalink() | Получает образец постоянной ссылки (пермалинка) записи. |
| get_the_content() | Получает контент текущей записи (поста). Используется внутри Цикла WordPress. |
| get_the_date() | Получает дату создания текущего поста. формат вывода даты можно указать произвольный. Используется в цикле WordPress. |
| get_the_excerpt() | Получает цитату (отрывок) поста. Используется внутри цикла WP. |
| get_the_ID() | Возвращает ID текущего поста в цикле. Используется только внутри цикла. |
| get_the_modified_date() | Получает дату (время), когда в последний раз была изменена запись (пост). |
| get_the_modified_time() | Получает время, когда в последний раз была изменена запись (пост). Аналог get_the_modified_date(). |
| get_the_permalink() | Получает, а не выводит на экран, УРЛ записи, которая обрабатывается в текущий момент (в Цикле). Тег шаблона. |
| get_the_time() | Получает время создания текущего поста в указанном формате. Используется внутри Цикла WordPress. |
| get_the_title() | Получает заголовок записи (поста). Можно указать запись заголовок которой нужно получить. |
| get_the_title_rss() | Получает заголовок поста. Используется при выводе заголовка в RSS-ленте. Используется в Цикле. |
| has_excerpt() | Проверяет есть ли у текущего поста отрывок (цитата, короткое описание). Условный тег. |
| post_password_required() | Проверяет защищен пост паролем или нет. Также проверяет правильность пароля, если пароль у поста установлен. |
| register_post_status() | Функция для создания нового или редактирования старого статуса поста, на основе переданных параметров. |
| single_post_title() | Выводит заголовок поста. Предназначен для использования на отдельных страницах записей. |
| the_author() | Выводит имя автора поста. |
| the_content() | Выводит контент текущего поста (записи). |
| the_date() | Выводит на экран или получает дату публикации поста или группы постов (опубликованные в один день). Используется в цикле WordPress. |
| the_excerpt() | Выводит "отрывок" (цитату) поста или первые 55 слов контента, со вставкой в конец |
| the_excerpt_rss() | Выводит на экран краткое описание поста (цитату) или первые 55 слов контента. Используется внутри Цикла WordPress. |
| the_ID() | Выводит ID текущего поста. Используется внутри Цикла WordPress. |
| the_modified_date() | Выводит время (дату), когда пост был изменен. |
| the_permalink() | Выводит УРЛ поста. |
| the_time() | Выводит на экран время (дату) публикации текущей записи в Цикле WordPress. |
| the_title() | Выводит на экран заголовок записи. Принято использовать внутри цикла. |
| the_title_attribute() | Выводит заголовок записи подготовленный для использования в атрибутах html тега. |
Страницы
| get_all_page_ids() | Получает ID всех постоянных страниц типа page. |
| get_page_by_path() | Получает запись по указанному пути этой страницы: parent-page/sub-page. Результат кэшируется. |
| get_page_children() | Собирает дочерние страницы из переданного массива страниц. Обрабатываются все уровни вложенности. |
| get_page_link() | Получает URL (ссылку) постоянной страницы WordPress (записи типа page). |
| get_page_template_slug() | Получает название специального шаблона записи (поста). |
| get_page_uri() | Получает путь (URL без домена) до указанной постоянной страницы. Собирает ярлыки текущей и всех родительских страниц и объединяет их слэшем |
| get_pages() | Получает данные страниц (древовидных типов записей) в виде массива объектов. Кэширует результат в объектный кэш. |
| get_post_ancestors() | Получает ID всех родительских записей к указанной в виде массива. |
| page_template_dropdown() | Получает файлы шаблона для указанного типа записи и выводит их на экран в виде элементов <option> для select поля формы. |
| parent_dropdown() | Получает список дочерних страниц указанной родительской страницы. Выводит HTML список элементов <option> для элемента <select>. |
| wp_dropdown_pages() | Выводит выпадающий список постоянных страниц (список в теге ). |
| wp_link_pages() | Выводит ссылки навигации по страницам, для многостраничных постов (для разделения используется |
| wp_list_pages() | Выводит список постоянных страниц в виде ссылок. |
| wp_page_menu() | Выводит список постоянных страниц блога в виде ссылок на соответствующие страницы. Аналог wp_list_pages(), только есть возможность добавить ссылку "на главную" в начало. |
Типы записей
| add_post_type_support() | Добавляет доп. возможности для указанного типа записи. Например, метабоксы - блоки на странице редактирования записи: редактор, автор, произвольные поля, комментарии и т.д. |
| get_post_permalink() | Получает URL (постоянную ссылку) на запись произвольного типа. |
| get_post_type() | Получает тип записи по переданному ID (post, page, attachment). |
| get_post_type_archive_link() | Возвращает URL (постоянную ссылку) на страницу архива произвольного типа записи. |
| get_post_type_object() | Получает объект (данные) указанного типа записи: post, page, attachment или новый тип записи. Объект содержит все параметры (настройки) типа записи. |
| get_post_types() | Получает данные (объекты) зарегистрированных типов записей. Не сами записи, а данные регистрации типа записи. |
| get_the_post_type_description() | Получает описание текущей архивной страницы типа записи. |
| is_post_type_archive() | Проверяет находится ли пользователь на архивной странице записей произвольного типа. |
| is_post_type_hierarchical() | Проверяет, является ли указанный тип записи древовидным. |
| is_post_type_viewable() | Определяет является ли указанный тип записи публичным (доступным для просмотра во внешней части сайта). Указывать нужно объект типа записи. |
| post_type_archive_title() | Выводит или возвращает заголовок для архивной страницы произвольного типа постов. |
| post_type_exists() | Проверяет зарегистрирован ли указанный тип записи. |
| post_type_supports() | Проверяет поддерживает ли тип записи указанную возможность (метабокс): |
| register_post_type() | Создает новый тип записи или изменяет имеющийся. |
| remove_post_type_support() | Удаляет зарегистрированную возможность у указанного типа записи. |
| set_post_type() | Обновляет тип записи по указанному ID записи. Примеры типов записей: post, page, attachment. |
| unregister_post_type() | Отменяет регистрацию указанного типа записи. Удаляет тип записи. |
Навигация
| get_adjacent_post() | Получает объект соседнего поста (следующего или предыдущего) из указанной таксономии (по умолчанию category). |
| get_adjacent_post_link() | Получает ссылку (HTML тег A) следующий/предыдущий пост из указанной таксономии (по умолчанию category). |
| get_boundary_post() | Получает первый или последний пост на сайта (по дате публикации). |
| get_next_post() | Получает следующий пост (в виде объекта) из указанной таксономии (по умолчанию category). |
| get_next_post_link() | Получает ссылку (тег A) на следующий по дате пост относительно текущего из указанной таксономии (по умолчанию category). |
| get_previous_post() | Получает предыдущий пост (в виде объекта) из указанной таксономии (по умолчанию category). |
| get_previous_post_link() | Получает ссылку (тег A) на предыдущий по дате пост (запись) из указанной таксономии (по умолчанию category). |
| get_the_post_navigation() | Получает ссылки (HTML) на следующую и предыдущую записи. Используется на странице отдельной записи: is_singular(). |
| next_post_link() | Выводит ссылку на следующий по дате пост из указанной таксономии (по умолчанию category). |
| previous_post_link() | Выводит ссылку на предыдущий по дате пост (запись) из указанной таксономии (по умолчанию category). |
| the_post_navigation() | Выводит на экран HTML блок ссылок на следующую и предыдущую записи. Используется на странице отдельной записи: is_singular(). |
Произвольные поля (postmeta)
| add_post_meta() | Добавляет произвольное поле для указанной записи (поста). |
| delete_post_meta() | Удалят все произвольные поля (метаполя) с указанным ключом у указанной записи (поста). |
| get_post_custom() | Получает многомерный массив с данными всех произвольных полей текущего поста. |
| get_post_custom_keys() | Получает массив с ключами произвольных полей, принадлежащих текущей записи. |
| get_post_custom_values() | Получает массив значений произвольных полей с указанным названием у указанной записи (поста). |
| get_post_meta() | Получает значение произвольного поля записи (поста). Позволяет также получить все метаполя. |
| register_post_meta() | Регистрирует метаполе (ключ произвольного поля) для постов. |
| the_meta() | Выводит произвольные поля записи (метаданные из wp_postmeta). Поля выводятся в списке <li>. Скрытые поля игнорируются. |
| update_post_meta() | Обновляет указанное произвольное поле (метаполе) указанной записи (поста) или добавляет новое. |
Запросы
| get_page_by_title() | Получает запись (страницу, пост, произвольный тип записи) по переданному заголовку записи. Делает прямой запрос в БД. |
| get_post() | Получает данные указанной или текущей записи (поста). Возвращает объект WP_Post. |
| get_posts() | Получает записи (посты, страницы, вложения) из базы данных по указанным критериям. Можно выбрать любые посты и отсортировать их как угодно. |
| have_posts() | Проверяет есть ли в |
| in_the_loop() | Проверяет активен ли цикл перебора записей в момент вызова этой функции. Условный тег, чтобы делать что-либо находясь в цикле WordPress. |
| is_404() | Проверяет показывается ли страница ошибки 404 (HTTP 404: страница не найдена). Условный тег. |
| is_archive() | Срабатывает, когда показывается любая из архивных страниц (страница: категории, метки, автора, даты). Условный тег. |
| is_attachment() | Проверяет является ли текущая страница страницей вложения. Условный Тег. |
| is_author() | Проверяет отображается ли страница с постами автора. Можно указать конкретного автора. Условный тег. |
| is_category() | Проверяет показывается ли страница категории или нет. Условный тэг. |
| is_date() | Срабатывает когда отображается страница архива по дате. Условный тег. |
| is_day() | Срабатывает, когда отображается страница архива по дню example.com/2009/08/05. Условный тэг. |
| is_feed() | Проверяет запрашивается ли в текущий момент фид. |
| is_front_page() | Проверяет отображается ли главная (домашняя) страница сайта. Условный тег. |
| is_home() | Проверяет показывается ли страница с последними постами, обычно это главная страница сайта. Условный тэг. |
| is_main_query() | Проверяет в главном ли цикле WordPress выполняется действие. Условный тег. |
| is_month() | Проверяет отображается ли страница архива «посты за месяц» example.com/2009/08. Условный тег. |
| is_new_day() | Проверяющий отличие текущей даты от предыдущей (в цикле). Условный тег. |
| is_page() | Проверяет отображается ли страница "постоянной страницы". Можно указать ID, ярлык или заголовок страницы для проверки. Условный тег. |
| is_paged() | Проверяет отображается ли страница пагинации (страница типа /page/2, /page/3). |
| is_preview() | Проверят находится ли пользователь на странице предпросмотра записи. Условный тег |
| is_search() | Срабатывает, когда отображается страница результатов поиска. Условный тег. |
| is_single() | Проверяет находимся ли мы на странице записи (любого типа). Записи с типом |
| is_singular() | Проверяет просматривается ли страница записи (пост, страница, свой тип записи, вложение). Можно указать тип записи для проверки. Условный тег. |
| is_tag() | Проверят отображается ли страница архива по меткам. Условный тег. |
| is_tax() | Срабатывает на архивной странице произвольной таксономии (новой, пользовательской) или на странице термина. Условный тег. |
| is_time() | Срабатывает на архивных страницах по времени (страница записей за указанное время). Условный тег. |
| is_year() | Срабатывает когда показывается страница-архив с постами за указанный год example.com/2009. Условный тег. |
| query_posts() | Используется самим WordPress при получении записей для текущей страницы (архив авторов, отдельная запись, рубрика, метка). Определяет какие посты будут показаны в базовом Цикле WordPress. Создает базовый Цикл WordPress. Возвращает список записей (постов). |
| rewind_posts() | Перематывает цикл в начало. |
| setup_postdata() | Устанавливает всевозможные данные поста (кроме глобальной переменной $post). |
| the_post() | Устанавливает следующий пост в глобальную переменную |
| wp_count_posts() | Получает количество записей любого типа записей и любых статусов (опубликовано, черновик). |
| wp_get_recent_posts() | Получает последние записи (посты) сайта, включая черновики, запланированные и записи на модерации. Получит 10 последних записей. |
| wp_reset_postdata() | Возвращает глобальную переменную $post в правильное состояние: в соответствие с текущей страницей. |
| wp_reset_query() | Аннулирует данные последнего запроса, созданного для использования в произвольном Цикле WordPress. |
Вставка, удаление, обновл.
| get_default_post_to_edit() | Получает дефолтные данные для формы записи (поста), при добавлении новой записи в админке. |
| wp_delete_post() | Удаляет или перемещает в корзину запись (пост, вложение, страницу, произвольный тип) из базы данных. |
| wp_insert_post() | Безопасно вставляет/обновляет запись в базе данных. |
| wp_publish_post() | Публикует запись. Меняет её статус с future, draft и т.д. на publish. Запускает все хуки необходимые для смены статуса записи. |
| wp_trash_post() | Перемещает указанную запись (пост) в корзину. Если корзина отключена, то запись будет удалена навсегда. |
| wp_update_post() | Обновляет запись (пост) в Базе Данных WordPress. |
Форматы
| get_post_format() | Возвращает формат (тип) поста, например: quote, status, video, audio. |
| has_post_format() | Проверяет наличие указанного формата у записи (поста). Условный тег. |
| set_post_format() | Устанавливает формат записи. |
Ревизии (редакции)
| wp_delete_auto_drafts() | Удаляет авто-черновики (записи со статусом auto-drafts) возрастом более 7 дней. |
| wp_delete_post_revision() | Удаляет ревизию записи по ID. |
| wp_get_post_revision() | Получает ревизию поста по указанной ID ревизии. Если записи с указанным ID нет или это не ревизия вернет null. |
| wp_get_post_revisions() | Получает все ревизии (редакции, изменения) указанной записи (поста). |
| wp_is_post_autosave() | Определяет является ли указанная запись авто-сохранением. |
| wp_is_post_revision() | Определяет является ли указанная запись (пост) ревизией (редакцией записи). |
| wp_revisions_enabled() | Проверят, включены ли ревизии (редакции) для указанной записи. |
| wp_revisions_to_keep() | Определяет сколько последних ревизий (изменений) следует хранить в базе данных для конкретной записи (поста). |
| wp_text_diff() | Получает удобную для чтения HTML-таблицу с различиями между двумя переданными строками (текстами). Используется для сравнения изменений в ревизиях записи. |
Остальное
| comments_open() | Проверяет открыто ли комментирование для указанного поста/записи. |
| get_extended() | Разделяет контент на 2 части до тега <!--more--> и после него. Возвращает массив с полученными частями. |
| get_lastpostdate() | Получает дату и время, когда был опубликована последняя запись на сайте. |
| get_lastpostmodified() | Получает дату и время, когда последний раз была отредактирована запись указанного типа. |
| get_post_embed_html() | Получает готовый HTML код oEmbed встраивания указанной записи. Предполагается использовать этот код для встраивания записи на другом ресурсе. |
| get_post_embed_url() | Получает URL, который нужно использовать в iframe для встраивания указанной записи на другом сайте (oEmbed формат). |
| get_post_parent() | Получает объект родительской записи для указанной или текущей в цикле записи. |
| get_post_stati() | Получает все существующие статусы постов в виде массива имен или массива объектов. |
| get_post_status_object() | Получает объект данных указанного статуса записи (поста). |
| get_post_statuses() | Возвращает массив следующих базовых статусов поста: Draft, Pending, Private, Publish. |
| get_post_timestamp() | Получает время публикации или изменения поста в виде временной метки Unix (1270995315). |
| has_post_parent() | Проверяет, есть ли родительская запись у указанной или текущей в цикле записи. |
| is_sticky() | Проверяет прилеплен ли текущий пост к главной странице сайта. Условный тэг. |
| pings_open() | Проверяет разрешено ли текущему посту получать пинги. Условный тег. |
| post_exists() | Проверяет существует ли уже запись (пост) с указанным заголовком (post_title). Для проверки, в дополнении к обязательному заголовку можно указать еще: post_content и post_date. |
| sanitize_post() | Очищает каждое поле указанного объекта/массива поста. |
| the_shortlink() | Выводит короткую ссылку текущей записи, например: /?p=1234. |
| url_to_postid() | Получает ID записи (поста, страницы) по переданному УРЛ. Разбирает переданную "постоянную ссылку" и по ней пытается получить ID записи. |
| wp_embed_register_handler() | Регистрирует Embed обработчик. Это обработчик, который превращает ссылку в контенте в HTML код. |
| WP_Embed::delete_oembed_caches() | Удаляет весь oEmbed кэш указанной записи (поста). |
| wp_get_canonical_url() | Получает канонический URL записи (поста). |
| wp_get_shortlink() | Возвращает короткую ссылку на статью (пост). |
| wp_oembed_add_provider() | Добавляет oEmbed провайдера. Это URL который будет парсится в контенте для вывода HTML кода с другого сайта. |
| wp_transition_post_status() | Запускает хуки (события) для любых изменений статусов записей (с draft на publish, с publish на private и т.д.). |