钩子文档

show_network_site_users_add_existing_form

💡 云策文档标注

概述

show_network_site_users_add_existing_form 是一个 WordPress 过滤器,用于控制是否在 Multisite Users 屏幕上显示“添加现有用户”表单。它允许开发者根据条件动态调整表单的可见性。

关键要点

  • 这是一个过滤器 Hook,用于修改是否显示“添加现有用户”表单的布尔值。
  • 默认值为 true,表示默认显示该表单。
  • 通常与 wp_is_large_network() 函数结合使用,以优化大型网络中的性能。
  • 自 WordPress 3.1.0 版本引入。

代码示例

if ( ! wp_is_large_network( 'users' ) && apply_filters( 'show_network_site_users_add_existing_form', true ) ) {
    // 显示添加现有用户表单的代码
}

注意事项

使用此过滤器时,应确保逻辑与 wp_is_large_network() 检查一致,以避免在大型网络中不必要地显示表单,从而影响性能。


📄 原文内容

Filters whether to show the Add Existing User form on the Multisite Users screen.

Parameters

$boolbool
Whether to show the Add Existing User form. Default true.

Source

if ( ! wp_is_large_network( 'users' ) && apply_filters( 'show_network_site_users_add_existing_form', true ) ) {

Changelog

Version Description
3.1.0 Introduced.