Рубрика: Функции WordPress

Функции WordPress это специально сделанные для платформы WordPress, PHP функции. Основные функции Wordpress, относятся к Тегам Шаблонов и созданы специально для использования в шаблонах (темах) WordPress.

Все статьи рубрики:

Функция the_category

Игорь Серов

the_category

Функция the_category отображает ссылку на категорию или категории, к которой принадлежит сообщение. Этот тег должен быть использован в течение Loop (основного цикла).

Применение

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

Использование

<?php the_category( $separator, $parents, $post_id ); ?>

более подробно:

the_category( string $separator = '', string $parents = '', int $post_id = false )

Параметры

Все параметры НЕ обязательные.

$separator (строка), Разделитель между ссылками.

По умолчанию: выведет ссылки в списке <ul>

$parents (строка) , определяет как показывать ссылки, если текущая категория является дочерней.

Может принимать:

  • multiple — показывать отдельно ссылки на родительскую и дочернюю категории, сохраняя порядок (родитель/предок);
  • single — показать одну ссылку, на категорию в которой находится пост, но текстом ссылки станет вся структура вложенности поста в категории (родитель/предок).

По умолчанию: просто выводятся категории, к которым принадлежит пост (никакая связь не учитывается)

$post_id (число)

ID поста, категории которого нужно вывести.

По умолчанию: текущий пост ($post->ID)

Пример

Пост находится в категории «Деревянный Дом». Это дочерняя категория рубрики «Дом».

Применив

<?php the_category(' / ', 'multiple'); ?>

Получим результат:

Дом/Деревянный дом и это будут две отдельные ссылки.

Если применить

<?php the_category(' / ', 'single'); ?>

Получим результат:

Дом/Деревянный  и это будет одно общая ссылка,на категорию Деревянный дом.в которой находится пост.

 

Еще функции

Функция category_description

Игорь Серов

category_description

Функция category_description назначение

Функция category_description возвращает описание рубрики, которое задается на вкладке Записи>>>Рубрики, ссылка «Исправить» под рубрикой в административной панели сайта.

Применение

При использовании функция размещается в шаблоне архивов (archive.php), в условном операторе  is_category (). В противном случае эта функция будет останавливать обработку страниц архива.

Как использовать

<? php echo category_description ( $category_id ); ?>

Параметры

$category_id (число), ID категории.

если НЕ указать ID, то используется описание текущей рубрики.

Примеры использования

<?php echo category_description(77); ?>

Результат: Описание категории с ID=77

<div><strong><?php single_cat_title('В этой категории вы найдете:'); ?>
 </strong>: <?php echo category_description(); ?></div>

Результат. В этой категории вы найдете:
далее «Описание категории», созданное при редактировании рубрики в админ. панели сайта.

Пример с названием рубрики:

<?php echo category_description(); ?>

<h1 class="archive-title"><?php single_cat_title('<Вы на странице рубрики:'); ?></h1>

Подробно в статье: Красиво оформить и оптимизировать страницы рубрик WordPress сайта

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

Скрытый текст

 

Функция the_excerpt()

Игорь Серов

the_excerpt()

Отображает выдержку после публикации. Фильтрует отображаемую выдержку.

Источник

Файл: wp-includes/post-template.php Строка 351-361.

function the_excerpt() {

/**

* Filters the displayed post excerpt.

*

* @since 0.71

*

* @see get_the_excerpt()

*

* @param string $post_excerpt The post excerpt.

*/

Назначение

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

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

В автоматически генерированном отрывке будут удалены все короткие коды и теги. Он обрезается до границы слова, а длина по умолчанию составляет 55 слов.

Excerpt является альтернативой использования тега more. В то время, как тег more требует, чтобы автор вручную создавал «разделение» в посте и участвует в создании ссылки «читать дальше»,  Excerpt делает всё в автоматическом режиме и не требует простановки автором никаких тегов.

Тег <! - more -> требуется, чтобы шаблоны использовали функцию the_content (), тогда как для использования отрывков достаточно разработчикам шаблонов явно выбрать, показывать ли полные сообщения (используя the_content () ) или выдержки (используя the_excerpt () ).

Еще функции

Функция the_content

Игорь Серов

Функция

the_content

Назначение

Функция the_content выводит контент текущего поста (записи).

Применение

Функция the_content выводит контент текущего поста (записи) шаблона, должена использоваться внутри Цикла WordPress или на станице записи (single.php, page.php).

Использование

<?php the_content( $more_link_text, $strip_teaser ); ?>

Параметры

  • $more_link_text – Параметр Строка, добавляется опционально. Задает текст для отображения ссылки «далее», «дополнительно». Значение по умолчанию: «Читать далее →».
  • $stripteaser – Логический параметр, добавляется опционально. Обрезает содержимое перед тегом комментарии. По умолчанию значение: FALSE. Работает только при показе одиночных записей (single.php).

Источник

Расположен в wp-includes/post-template.php строка 230

Пример

Изменяет стандартный текст ссылки, который выводится функцией, после отрывка по тегу <!—more—>

<?php the_content('Перейти ко всей статье...');>

Функция the_tags

Игорь Серов

Функция

the_tags

Назначение

Функция the_tags, выводит ссылки на метки, которые относятся к посту. Если у поста нет меток, то функция выведет ссылку на категорию, связанную с постом.

Использование

<?php the_tags( $before, $separator, $after ); ?>

Параметры

  • $before (строка), Текст перед ссылками. По умолчанию: ‘Tags: ‘
  • $separator (строка), Разделитель между ссылками.  По умолчанию: ‘, ‘
  • $after (строка), Текст после ссылок.  По умолчанию: нет

Пример

Выведем метки в списке <ul>:

<?php the_tags('<ul><li>','</li><li>','</li></ul>'); ?>

Функция the_post_thumbnail

Игорь Серов

Функция

the_post_thumbnail

Назначение

Функция the_post_thumbnail выводит html код картинки-миниатюры поста пустое значение, если картинка отсутствует.

Применение

Этот тег шаблона, функция the_post_thumbnail, должен использоваться внутри Цикла WordPress

Использование

<?php the_post_thumbnail( $size, $attr ); ?>
the_post_thumbnail( string|array $size = 'post-thumbnail', string|array $attr = '' )

Источник

Файл: wp-includes / post-thumbnail-template.php

function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
    echo get_the_post_thumbnail( null, $size, $attr );
}

Параметры

$size (строка/массив)

Размер миниатюры, которую нужно получить. Может быть строкой с условными размерами: thumbnail, medium, large, full или массив из двух элементов (ширина и высота картинки): array(60, 60).

По умолчанию: ‘post-thumbnail’, то есть размер который устанавливается для текущей темы функцией set_post_thumbnail_size()

$attr (строка/массив)

Массив атрибутов, которые нужно добавить получаемому html тегу img (alt — альтернативное название).

По умолчанию:

Пример

<?php // Post featured image
if(has_post_thumbnail()) {
if (!is_single()){ ?><a href="<?php the_permalink(); ?>" title=
"<?php printf( $SMTheme->_( 'permalink' ), the_title_attribute( 'echo=0' ) ); ?>"> <?php }
the_post_thumbnail(
array($SMTheme->get( 'layout', 'imgwidth' ), $SMTheme->get( 'layout', 'imgheight' )),
array("class" => $SMTheme->get( 'layout','imgpos' ) . " featured_image")
);
if (!is_single()){ ?></a><?php }
}
?>

Цикл WordPress: что такое the loop WordPress

Игорь Серов
Цикл WordPress

В понимании кода WordPress большое значение имеет понятие цикла WordPress.  Цикл WordPress также называют «loop», «the loop», «the loop WordPress».

Читать дальше …

Функция tag_description

Игорь Серов

tag_description

Функция tag_description получает описание метки, которое задается при создании/редактировании метки в админ-панели.

Применение

Функция tag_description возвращает текст, в виде описания метки или ничего , если описание не создано или его не удалось получить

Использование

<?php tag_description( $tag_id ); ?>

Параметры

$tag_id (число), ID метки, описание которой нужно получить.

По умолчанию: ID метки, страница которой отображается

Пример

 Выведем описание метки с ID 43:

<?php echo 'Описание метки: ' . tag_description('43'); ?>

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

Функция get_post

Игорь Серов

get_post

Назначение

Функция get_post в качестве аргумента принимает ID записи и возвращает хранящуюся в базе данных информацию о ней. Формат возвращаемых данных зависит от параметра $output.

Функция get_post используется в posts_nav_link(), wp_get_recent_posts(), get_children().

Использование


<?php get_post( $post, $output ); ?>

Параметры

$post

(Необходим ) ID записи, которую вы бы хотели «достать».

Вам нужно подставлять именно переменную со значением ID (напр. $id), а не просто цифру, равную ID (напр. 7). В последнем случае получите критическую ошибку. (Only variables can be passed for reference или Cannot pass parameter 1 by reference)

По умолчанию(Default) : None

$output

(Необязательно) Определяет формат возвращаемых данных.

  • OBJECT — возвращает объект
  • ARRAY_A — возвращает ассоциативный массив, в котором индексами служат названия полей в базе данных, а значениями данные из этих полей
  • ARRAY_N — возвращает числовой массив с данными из полей

По умолчанию : OBJECT

Пример: Вывод заголовка поста с ID 7

<?php
$my_id = 7;
$post_id_7 = get_post($my_id); 
$title = $post_id_7->post_title;
?>

Возвращаемые значения get_post()

В случае ошибки эта функция возвращает null.

String (строка) и Integer (целое) это типы параметров тегов.

Возвращаемые поля:

ID

ID поста

post_author

ID автора поста

post_date

Дата и время создания поста (ГГГГ-ММ-ДД ЧЧ:ММ:СС)

post_date_gmt

Дата и время создания поста по Гринвичу (GMT) (ГГГГ-ММ-ДД ЧЧ:ММ:СС)

post_content

Содержание поста

post_title

Заголовок поста

post_category

ID рубрики к которой принадлежит пост. Важно помнить, что это значения всегда будет равно 0 начиная с WordPress 2.1 Для определения рубрики или рубрик, в которых находится запись используйте get_the_category().

post_excerpt

Выдержка из поста (отрывок текста)

post_status

Статус поста (publish|pending|draft|private|static|object|attachment|inherit|future)

comment_status

Статус комментирования (open|closed|registered_only)

ping_status

Статус пингов и трекбеков (open|closed)

post_password

Пароль поста

post_name

Приставка к URL поста (slug, ее видно в URL, если включена опция ЧПУ)

to_ping

URL для пингов

pinged

URL, которые уже были «пингованы»

post_modified

Дата и время последнего редактирования поста (ГГГГ-ММ-ДД ЧЧ:ММ:СС)

post_modified_gmt

Дата и время последнего редактирования поста по Гринвичу (GMT) (ГГГГ-ММ-ДД ЧЧ:ММ:СС)

post_content_filtered

post_parent

ID родительской поста (для вложений, например и т.п.)

guid

Ссылка на пост. Можно сказать, что это текущая ссылка на конкретный пост.

menu_order

Число определяющее «рейтинг» поста (влияет на порядок вывода страниц в списке)

post_type

Тип записи (post|page|attachment)

post_mime_type

Mimе-тип (для вложений, проч.)

comment_count

Число комментариев.

Еще функции

Параметры тегов шаблона

Игорь Серов

Теги шаблона являются PHP функциями, которые вы можете вставлять в ваши шаблоны динамических WordPress-страниц. Как PHP функции, многие теги шаблонов принимают аргументы, или параметры.
Читать дальше …