钩子文档

{$option}

💡 云策文档标注

概述

本文档介绍了 WordPress 中用于过滤列表表格每页显示项目数量的动态 Hook。该 Hook 名称基于 $option 参数,对应不同类型的列表表格,允许开发者自定义每页显示的项目数。

关键要点

  • Hook 名称是动态的,如 edit_comments_per_page、edit_post_per_page 等,具体取决于列表表格类型。
  • 参数 $per_page 为整数,表示每页显示的项目数,默认值为 20。
  • 通过 apply_filters 调用,返回过滤后的整数。
  • 相关函数包括 WP_Screen::render_per_page_options() 和 WP_List_Table::get_items_per_page(),用于渲染和获取每页项目数。
  • 该 Hook 自 WordPress 2.9.0 版本引入。

📄 原文内容

Filters the number of items to be displayed on each page of the list table.

Description

The dynamic hook name, $option, refers to the per_page option depending on the type of list table in use. Possible filter names include:

  • edit_comments_per_page
  • sites_network_per_page
  • site_themes_network_per_page
  • themes_network_per_page
  • users_network_per_page
  • edit_post_per_page
  • edit_page_per_page
  • edit_{$post_type}_per_page
  • edit_post_tag_per_page
  • edit_category_per_page
  • edit_{$taxonomy}_per_page
  • site_users_network_per_page
  • users_per_page

Parameters

$per_pageint
Number of items to be displayed. Default 20.

Source

return (int) apply_filters( "{$option}", $per_page );

Changelog

Version Description
2.9.0 Introduced.