Записи: пости, сторінки, … (рубрика)
Що таке записи і що в них особливого в структурі движка 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) наступний/попередній пост із зазначеної таксономії (за замовчуванням). |
| get_boundary_post() | Отримує перший або останній пост на сайті (за датою публікації). |
| get_next_post() | Отримує наступний пост (як об’єкт) із зазначеної таксономії (за умовчанням category). |
| get_next_post_link() | Отримує посилання (тег A) на наступний за датою пост щодо поточного із зазначеної таксономії (за замовчуванням category). |
| get_previous_post() | Отримує попередній пост (у вигляді об’єкта) із зазначеної таксономії (за замовчуванням). |
| 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() | Перевіряє чи є у поточного запиту WP результати висновку, тобто. чи є пости, які можна вивести для поточної сторінки. Умовний тег. |
| 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. Визначає global $post , встановлює WP_Query::in_the_loop = true і перемикає на наступний пост у циклі. |
| 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 і т.д.). |