paginate_links
Функция paginate_links
в WordPress используется для создания навигационных ссылок для постраничного перелистывания. Она часто используется на страницах архивов, таких как блоги или результаты поиска, где нужно разбить содержимое на страницы.
paginate_links( $args );
$args (массив, необязательный): Ассоциативный массив параметров для настройки вывода ссылок.
Основные параметры $args
- base (строка): Базовый URL для страниц. По умолчанию, это значение автоматически определяется.
- format (строка): Формат строки для номера страницы. По умолчанию:
?paged=%#%
. - total (число): Общее количество страниц. По умолчанию — 1.
- current (число): Номер текущей страницы. По умолчанию — 0.
- show_all (логическое): Показывать все ссылки страниц. По умолчанию —
false
. - end_size (число): Количество ссылок на первой и последней страницах. По умолчанию — 1.
- mid_size (число): Количество ссылок, показываемых до и после текущей страницы. По умолчанию — 2.
- prev_next (логическое): Показывать ссылки «Предыдущая» и «Следующая». По умолчанию —
true
. - prev_text (строка): Текст для ссылки «Предыдущая». По умолчанию —
« Previous
. - next_text (строка): Текст для ссылки «Следующая». По умолчанию —
Next »
. - type (строка): Тип возвращаемого значения. Может быть
plain
,array
илиlist
. По умолчанию —plain
. - add_args (массив): Дополнительные аргументы для URL.
- add_fragment (строка): Дополнительный фрагмент URL (например,
#content
).
Примеры использования
В этом примере функция paginate_links
используется для создания навигации на странице архива. Аргументы base
и format
обеспечивают правильное формирование URL для номеров страниц.
Этот пример показывает, как добавить пользовательские тексты для ссылок «Предыдущая» и «Следующая», а также обернуть ссылки в элемент навигации с классом pagination
.
Подробное объяснение
- base: Указывает базовый URL для навигационных ссылок.
str_replace
используется для замены большого числа ($big
) на символ подстановки (%#%
), который будет заменен на номер страницы. - format: Определяет формат строки для номеров страниц.
- current: Указывает текущую страницу.
max( 1, get_query_var( 'paged' ) )
используется для получения текущей страницы, гдеpaged
— это переменная запроса, содержащая номер страницы. - total: Определяет общее количество страниц, используя свойство
max_num_pages
глобальной переменной$wp_query
.
Функция
paginate_links
является мощным инструментом для создания удобной и функциональной навигации по страницам в WordPress. Она позволяет гибко настроить внешний вид и поведение ссылок для постраничного перелистывания, что улучшает пользовательский опыт на вашем сайте.
Функции WordPress
- wp_list_pluck
- has_tag
- wp_add_inline_script
- sanitize_title
- single_term_title
- _nx
- load_theme_textdomain
- disabled
- checked
- redirect_canonical
- is_embed
- has_nav_menu
- get_the_posts_navigation
- wp_get_nav_menu_object
- get_nav_menu_locations
- wp_list_sort
- the_archive_description
- posts_nav_link
- wp_check_browser_version
- get_privacy_policy_url
- get_pagenum_link
- get_next_posts_link
- is_author
- the_title_attribute
- get_the_modified_date
- get_the_title_rss
- wp_trim_words
- has_excerpt
- get_the_excerpt
- get_sample_permalink
- get_bloginfo
- get_delete_post_link
- edit_post_link
- sanitize_title_with_dashes
- is_post_type_archive
- update_post_meta
- add_post_meta
- delete_transient
- get_transient
- set_transient
- register_post_type
- register_taxonomy
- wp_title
- get_post_status
- absint
- wp_loginout
- get_search_query
- locate_template
- get_stylesheet
- get_terms
- wp_lostpassword_url
- get_blog_details
- nocache_headers
- wpmu_activate_signup
- is_ssl
- remove_query_arg
- wp_unslash
- wp_registration_url
- add_query_arg
- get_the_modified_time
- esc_attr_e
- get_post_ancestors
- wp_safe_redirect
- get_the_ID
- get_the_title
- get_permalink
- is_user_logged_in
- wp_login_url
- wp_logout_url
- wp_kses
- the_ID
- post_class
- post_password_required
- get_the_password_form
- the_permalink
- get_category_link
- get_categories
- wp_robots
- get_custom_logo
- remove_theme_support
- current_theme_supports
- wp_get_document_title
- is_404
- is_main_query
- remove_action
- wp_nav_menu
- apply_filters
- register_nav_menus
- wp_script_is
- comments_template
- get_template_part
- get_header
- get_footer
- get_search_form
- add_shortcode
- get_template_directory_uri
- get_query_var
- wp_redirect
- current_user_can
- comments_open
- wp_html_excerpt
- human_time_diff
- is_tax
- is_date
- is_category
- in_the_loop
- is_home
- wp_get_theme
- wp_die
- do_robots
- wp_get_recent_posts
- is_year
- is_time
- is_front_page
- get_children
- get_boundary_post
- get_pages
- home_url
- get_option
- body_class
- wp_footer
- bloginfo
- language_attributes
- wp_head
- is_single
- is_singular
- is_archive
- is_search
- is_page
- add_action
- wp_enqueue_style
- wp_enqueue_script
- get_template_directory
- add_theme_support