wp_star_rating()

Выводит HTML-элемент с рейтингом звезд для заданного рейтинга
Функция WordPress
INT 4.4.0, 3.8.0
WordPress Icon
Содержание
  1. Описание функции
  2. Примеры использования
  3. Выводит HTML элемент с рейтингом звездочками для заданного рейтинга
  4. Форматирует рейтинг в указанном формате
  5. Определяет количество оценок, составляющих данный рейтинг
  6. Возвращает HTML код рейтинга в виде строки
  7. Определяет, нужно ли вывести сгенерированный HTML код или вернуть его в виде строки
  8. Вопросы и ответы
  9. Как изменить количество звезд в рейтинге?
  10. Как изменить тип формата рейтинга?
  11. Как изменить количество оценок, участвующих в рейтинге?
  12. Как изменить вывод рейтинга на странице?
  13. Как изменить вывод рейтинга в шаблоне?
  14. Как изменить вывод рейтинга в административной панели?
  15. Функция wp_star_rating()
  16. Использование функции
  17. Параметры функции
  18. Примеры кода
  19. Как изменить вывод рейтинга в RSS-ленте?
  20. Как изменить вывод рейтинга в поисковой выдаче?
  21. Как изменить вывод рейтинга в мобильной версии сайта?
  22. Связанные элементы

Описание функции

Функция wp_star_rating() выводит HTML-элемент с рейтингом звезд для заданного рейтинга.

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

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

wp_star_rating( array $args = array() ): string

Функция wp_star_rating() принимает один необязательный аргумент — массив аргументов для настройки рейтинга звезд. Она возвращает строку с HTML-кодом рейтинга звезд.

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

$args = array(
    'rating' => 4.5, // Рейтинг 4.5
    'type' => 'rating', // Формат рейтинга
    'number' => 10, // Количество оценок
    'echo' => false // Выводить результат или возвращать его
);
$rating_html = wp_star_rating( $args );

В данном примере создается массив $args с настройками рейтинга звезд. Затем вызывается функция wp_star_rating() с этим массивом в качестве аргумента. Результат сохраняется в переменную $rating_html.

  • $args (массив, необязательный): Массив аргументов для настройки рейтинга звезд.
    • rating (int|float): Рейтинг для отображения, выраженный в формате с шагом 0.5 или процентами. По умолчанию 0.
    • type (string): Формат рейтинга. Допустимые значения: ‘rating’ (по умолчанию) или ‘percent’.
    • number (int): Количество оценок, составляющих данный рейтинг. По умолчанию 0.
    • echo (bool): Выводить сгенерированный HTML-код или возвращать его. False для возврата кода. По умолчанию true.
  • Возвращает: (string) HTML-код рейтинга звезд.
<?php
/**
 * Пример использования функции wp_star_rating()
 */
$args = array(
    'rating' => 4.5, // Рейтинг 4.5
    'type' => 'rating', // Формат рейтинга
    'number' => 10, // Количество оценок
    'echo' => false // Выводить результат или возвращать его
);
// Выводит HTML-код рейтинга звезд
$rating_html = wp_star_rating( $args );
// Выводит результат
echo $rating_html;
?>

В данном примере создается массив $args с настройками рейтинга звезд. Затем вызывается функция wp_star_rating() с этим массивом в качестве аргумента. Результат сохраняется в переменную $rating_html. Затем результат выводится с помощью echo.

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

Выводит HTML элемент с рейтингом звездочками для заданного рейтинга


$args = array(
    'rating' => 4.5,
);
 
echo wp_star_rating($args);

Результат:


<span class="wp-star-rating">
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-empty"></span>
</span>

В данном примере используется функция wp_star_rating() для вывода HTML элемента с рейтингом звездочками. В параметрах передается массив $args с указанием рейтинга в виде числа 4.5. Функция возвращает HTML код, который отображает 4 звезды и половину пятой звезды.

Форматирует рейтинг в указанном формате


$args = array(
    'rating' => 3.75,
    'type' => 'percent',
);
 
echo wp_star_rating($args);

Результат:


<span class="wp-star-rating">
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-half"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-empty"></span>
    <span class="wp-star-rating-percent">75%</span>
</span>

В данном примере используется функция wp_star_rating() для форматирования рейтинга в процентном формате. В параметрах передается массив $args с указанием рейтинга в виде числа 3.75 и типа форматирования ‘percent’. Функция возвращает HTML код, который отображает 3 звезды и половину четвертой звезды, а также процентное значение рейтинга.

Определяет количество оценок, составляющих данный рейтинг


$args = array(
    'rating' => 4.2,
    'number' => 10,
);
 
echo wp_star_rating($args);

Результат:


<span class="wp-star-rating">
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-half"></span>
    <span class="wp-star-rating-number">(10)</span>
</span>

В данном примере используется функция wp_star_rating() для определения количества оценок, составляющих данный рейтинг. В параметрах передается массив $args с указанием рейтинга в виде числа 4.2 и количества оценок 10. Функция возвращает HTML код, который отображает 4 звезды и половину пятой звезды, а также количество оценок в скобках.

Возвращает HTML код рейтинга в виде строки


$args = array(
    'rating' => 2.5,
    'echo' => false,
);
 
$rating_html = wp_star_rating($args);
echo $rating_html;

Результат:


<span class="wp-star-rating">
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-half"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-empty"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-empty"></span>
</span>

В данном примере используется функция wp_star_rating() для получения HTML кода рейтинга в виде строки. В параметрах передается массив $args с указанием рейтинга в виде числа 2.5 и параметра echo со значением false. Функция возвращает HTML код, который отображает 2 звезды и половину третьей звезды.

Определяет, нужно ли вывести сгенерированный HTML код или вернуть его в виде строки


$args = array(
    'rating' => 4,
    'echo' => false,
);
 
$rating_html = wp_star_rating($args);
 
// Выводим HTML код
echo $rating_html;
 
// Или возвращаем его в виде строки
return $rating_html;

Результат:


<span class="wp-star-rating">
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon"></span>
    <span class="wp-star-rating-star wp-star-rating-icon wp-star-rating-icon-empty"></span>
</span>

В данном примере используется функция wp_star_rating() для определения, нужно ли вывести сгенерированный HTML код или вернуть его в виде строки. В параметрах передается массив $args с указанием рейтинга в виде числа 4 и параметра echo со значением false. Функция возвращает HTML код, который отображает 4 звезды.

Вопросы и ответы

Как изменить количество звезд в рейтинге?

Для изменения количества звезд в рейтинге используется параметр number функции wp_star_rating(). По умолчанию значение этого параметра равно 0, что означает отсутствие рейтинга.

Пример кода:


$args = array(
    'number' => 5 // Устанавливаем количество звезд в рейтинге равным 5
);
echo wp_star_rating($args);

Как изменить тип формата рейтинга?

Для изменения типа формата рейтинга используется параметр type функции wp_star_rating(). По умолчанию значение этого параметра равно ‘rating’, что означает, что рейтинг выражен в виде оценки.

Пример кода:


$args = array(
    'type' => 'percent' // Устанавливаем тип формата рейтинга как процентный
);
echo wp_star_rating($args);

Как изменить количество оценок, участвующих в рейтинге?

Для изменения количества оценок, участвующих в рейтинге, используется параметр rating функции wp_star_rating(). По умолчанию значение этого параметра равно 0, что означает отсутствие рейтинга.

Пример кода:


$args = array(
    'rating' => 4.5 // Устанавливаем рейтинг равным 4.5
);
echo wp_star_rating($args);

Как изменить вывод рейтинга на странице?

Для изменения вывода рейтинга на странице можно использовать функцию wp_star_rating() с определенными аргументами.

Пример кода:


$args = array(
    'rating' => 4.5,
    'type' => 'percent',
    'number' => 10,
    'echo' => false
);
$rating_html = wp_star_rating($args);
echo $rating_html;

В данном примере рейтинг будет выводиться в виде процентов (type=’percent’) с рейтингом 4.5 (rating=4.5), основанным на 10 оценках (number=10). Результат будет сохранен в переменную $rating_html и затем выведен на страницу.

Как изменить вывод рейтинга в шаблоне?

Для изменения вывода рейтинга в шаблоне можно использовать функцию wp_star_rating() с определенными аргументами.

Пример кода:


$args = array(
    'rating' => get_post_meta(get_the_ID(), 'rating', true),
    'type' => 'rating',
    'number' => 0,
    'echo' => true
);
wp_star_rating($args);

В данном примере рейтинг будет выводиться в виде обычной оценки (type=’rating’) с рейтингом, полученным из мета-поля ‘rating’ текущего поста (rating=get_post_meta(get_the_ID(), ‘rating’, true)). Количество оценок не указано (number=0), а сгенерированный HTML-код будет выведен на страницу с помощью параметра echo (echo=true).

Как изменить вывод рейтинга в административной панели?

Для изменения вывода рейтинга в административной панели можно использовать функцию wp_star_rating() с определенными аргументами.

Пример кода:


$args = array(
    'rating' => get_post_meta($post->ID, 'rating', true),
    'type' => 'rating',
    'number' => 0,
    'echo' => true
);
wp_star_rating($args);

В данном примере рейтинг будет выводиться в виде обычной оценки (type=’rating’) с рейтингом, полученным из мета-поля ‘rating’ текущего поста (rating=get_post_meta($post->ID, ‘rating’, true)). Количество оценок не указано (number=0), а сгенерированный HTML-код будет выведен на страницу с помощью параметра echo (echo=true).

Функция wp_star_rating()

Функция wp_star_rating() используется для вывода HTML элемента с рейтингом звездочками для заданного рейтинга.

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

Использование функции

Для использования функции wp_star_rating() необходимо передать массив аргументов $args. Функция возвращает строку с HTML кодом рейтинга.

Параметры функции

  • $args (array, optional): Массив аргументов для настройки рейтинга.
  • rating (int|float, optional): Рейтинг, который нужно отобразить. Может быть выражен в формате 0.5 или процентов. По умолчанию 0.
  • type (string, optional): Формат рейтинга. Допустимые значения: ‘rating’ (по умолчанию) или ‘percent’.
  • number (int, optional): Количество оценок, составляющих данный рейтинг. По умолчанию 0.
  • echo (bool, optional): Выводить ли сгенерированный HTML код. Если false, то функция вернет код в виде строки. По умолчанию true.

Примеры кода

Примеры кода из документации WordPress:


// Пример использования функции wp_star_rating()
echo wp_star_rating(array(
  'rating' => 4.5,
  'type' => 'rating',
  'number' => 10,
  'echo' => false
));

Как изменить вывод рейтинга в RSS-ленте?

Для изменения вывода рейтинга в RSS-ленте можно использовать фильтр the_content_feed. В этом фильтре можно изменить содержимое записи перед его выводом в RSS-ленту.


// Пример изменения вывода рейтинга в RSS-ленте
function custom_star_rating_feed($content) {
  $content = wp_star_rating(array(
    'rating' => get_post_meta(get_the_ID(), 'rating', true),
    'type' => 'rating',
    'number' => get_post_meta(get_the_ID(), 'number_of_ratings', true),
    'echo' => false
  ));
  return $content;
}
add_filter('the_content_feed', 'custom_star_rating_feed');

Как изменить вывод рейтинга в поисковой выдаче?

Для изменения вывода рейтинга в поисковой выдаче можно использовать фильтр the_title. В этом фильтре можно изменить заголовок записи перед его выводом в поисковую выдачу.


// Пример изменения вывода рейтинга в поисковой выдаче
function custom_star_rating_search($title) {
  $rating = wp_star_rating(array(
    'rating' => get_post_meta(get_the_ID(), 'rating', true),
    'type' => 'rating',
    'number' => get_post_meta(get_the_ID(), 'number_of_ratings', true),
    'echo' => false
  ));
  return $rating . $title;
}
add_filter('the_title', 'custom_star_rating_search');

Как изменить вывод рейтинга в мобильной версии сайта?

Для изменения вывода рейтинга в мобильной версии сайта можно использовать фильтр the_content. В этом фильтре можно изменить содержимое записи перед его выводом на мобильных устройствах.


// Пример изменения вывода рейтинга в мобильной версии сайта
function custom_star_rating_mobile($content) {
  if (wp_is_mobile()) {
    $content = wp_star_rating(array(
      'rating' => get_post_meta(get_the_ID(), 'rating', true),
      'type' => 'rating',
      'number' => get_post_meta(get_the_ID(), 'number_of_ratings', true),
      'echo' => false
    )) . $content;
  }
  return $content;
}
add_filter('the_content', 'custom_star_rating_mobile');

Функция wp_star_rating() позволяет выводить HTML элемент с рейтингом звездочками для заданного рейтинга. С помощью параметров функции можно настроить формат и количество оценок, а также выбрать, выводить ли сгенерированный HTML код или вернуть его в виде строки. Фильтры the_content_feed, the_title и the_content позволяют изменить вывод рейтинга в RSS-ленте, поисковой выдаче и мобильной версии сайта соответственно.

Связанные элементы

  • Функция add_filter(): регистрирует функцию обратного вызова для выполнения фильтрации данных.
  • Функция add_action(): регистрирует функцию обратного вызова для выполнения действия в определенном месте кода.
  • Функция get_template_part(): подключает файл шаблона из текущей темы WordPress.
  • Функция wp_enqueue_style(): регистрирует стили для загрузки на фронтенде WordPress.
  • Функция wp_enqueue_script(): регистрирует скрипты для загрузки на фронтенде WordPress.
  • Хук init: вызывается при инициализации WordPress и позволяет регистрировать дополнительные функции и действия.
  • Хук wp_enqueue_scripts: вызывается при загрузке скриптов и стилей на фронтенде WordPress.
  • Класс WP_Query: используется для выполнения запросов к базе данных WordPress и получения соответствующих записей.
  • Класс WP_Widget: используется для создания виджетов, которые могут быть добавлены в боковые панели или другие области сайта.
Обсуждение