钩子文档

wp_sitemaps_users_pre_max_num_pages

💡 云策文档标注

概述

wp_sitemaps_users_pre_max_num_pages 是一个 WordPress 过滤器钩子,用于在用户站点地图生成前修改其最大页数。返回非空值可短路默认生成过程,直接使用该值。

关键要点

  • 过滤器名称:wp_sitemaps_users_pre_max_num_pages
  • 作用:过滤用户站点地图的最大页数,在生成前生效
  • 参数:$max_num_pages(int|null),默认值为 null
  • 返回值:返回非 null 值将短路生成,直接使用该值
  • 相关函数:WP_Sitemaps_Users::get_max_num_pages()
  • 引入版本:5.5.0

代码示例

$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );

📄 原文内容

Filters the max number of pages for a user sitemap before it is generated.

Description

Returning a non-null value will effectively short-circuit the generation, returning that value instead.

Parameters

$max_num_pagesint|null
The maximum number of pages. Default null.

Source

$max_num_pages = apply_filters( 'wp_sitemaps_users_pre_max_num_pages', null );

Changelog

Version Description
5.5.0 Introduced.