本教程将详细介绍如何在woocommerce单产品页面上，为管理员用户精确显示商品的实际库存数量，而普通客户则只看到商品有无库存状态。通过利用`woocommerce_get_availability_text`过滤器，我们可以有条件地向特定用户角色追加库存数量信息，从而实现更精细化的库存管理显示，避免直接使用短代码重复显示库存状态的局限性。
引言：管理员与客户的库存信息需求差异
在WooCommerce商店中，默认情况下，产品页面的库存信息通常只显示“有库存”或“无库存”这样的状态，这对于普通客户而言已经足够。然而，对于网站管理员或店铺经理来说，他们可能需要更精确的库存数量，以便进行库存管理、补货决策或客户咨询。直接通过短代码尝试显示库存数量可能会遇到挑战，例如输出的仍然是格式化的“有库存”文本，而不是具体的数字。本教程将提供一个优雅的解决方案，通过WooCommerce的过滤器机制，有条件地为特定用户角色追加实际库存数量。
核心问题：如何为特定用户显示精确库存数量
许多开发者尝试通过自定义短代码或直接调用WooCommerce函数来获取库存数量。例如，使用wc_get_stock_html()函数，它会根据WooCommerce设置输出格式化的库存状态文本（如“有库存”或“无库存”），而非纯粹的数字。为了满足管理员查看精确数量的需求，我们需要一个方法来修改或增强现有的库存可用性文本，而不是替换它或在其旁边单独显示。
解决方案：利用 woocommerce_get_availability_text 过滤器
WooCommerce提供了一个名为woocommerce_get_availability_text的过滤器，允许开发者修改产品可用性文本。通过这个过滤器，我们可以检测当前用户的角色，如果用户是管理员或店铺经理，就在原有的可用性文本后追加实际的库存数量。
以下是实现此功能的代码示例：
/**
* WC：为管理员和店铺经理在前端显示产品实际库存数量
* 通过修改产品可用性文本实现
*/
add_filter( 'woocommerce_get_availability_text', 'a3w_woocommerce_get_availability_text', 10, 2 );
function a3w_woocommerce_get_availability_text( $availability, $product ) {
// 检查当前用户是否具有管理WooCommerce的权限
// 'manage_woocommerce' 权限通常赋予管理员和店铺经理
// 如果只想针对管理员，可以使用 'administrator'
if ( current_user_can( 'manage_woocommerce' ) ) {
// 获取产品的实际库存数量
$stock_quantity = $product->get_stock_quantity();
// 将库存数量追加到原有的可用性文本后
// 使用 sprintf 进行格式化，确保输出整洁
$availability .= sprintf( ' ( %d )', $stock_quantity );
}
// 返回修改后的可用性文本
return $availability;
}代码解析
-
add_filter( 'woocommerce_get_availability_text', 'a3w_woocommerce_get_availability_text', 10, 2 );:
- woocommerce_get_availability_text 是WooCommerce提供的一个过滤器钩子，用于修改产品可用性文本。
- a3w_woocommerce_get_availability_text 是我们将要定义的自定义函数，用于处理过滤逻辑。
- 10 是优先级，数字越小，函数执行越早。
- 2 表示我们的函数将接受两个参数：$availability（当前的可用性文本）和$product（产品对象）。
-
function a3w_woocommerce_get_availability_text( $availability, $product ) { ... }:
- 这是我们的回调函数。它接收当前的可用性文本和产品对象。
-
if ( current_user_can( 'manage_woocommerce' ) ) { ... }:
- current_user_can() 是WordPress的一个函数，用于检查当前登录用户是否具有指定的权限。
- 'manage_woocommerce' 是WooCommerce为管理店铺操作而设定的权限，通常管理员和店铺经理都拥有此权限。
- 如果您只想让管理员看到精确库存，可以将 'manage_woocommerce' 替换为 'administrator'。
- 这个条件判断确保了只有特定用户角色才能看到额外的库存数量信息。
-
$stock_quantity = $product->get_stock_quantity();:
- $product 对象是WooCommerce产品实例，它提供了多种方法来获取产品信息。
- get_stock_quantity() 方法用于获取产品的实际库存数量，返回一个整数。
-
$availability .= sprintf( ' ( %d )', $stock_quantity );:
- sprintf() 函数用于格式化字符串。%d 是一个占位符，表示将 $stock_quantity 作为整数插入到括号中。
- $availability .= ... 将格式化后的库存数量字符串追加到原有的 $availability 文本之后。
实际效果展示
对管理员/店铺经理显示：Availability: In stock ( 18 ) （有库存 ( 18 )） Availability: Out of stock ( 0 ) （无库存 ( 0 )）
对普通客户显示：Availability: In stock （有库存） Availability: Out of stock （无库存）
注意事项与最佳实践
- 代码放置位置： 将上述代码片段放置在您的WordPress子主题的 functions.php 文件中。强烈不建议直接修改父主题的文件，因为主题更新会覆盖您的更改。
-
用户权限选择： 根据您的具体需求，灵活选择 current_user_can() 中的权限。
- 'administrator'：仅限管理员。
- 'manage_woocommerce'：管理员和店铺经理。
- 您也可以创建自定义角色和权限，并在此处使用它们。
- 显示格式定制： sprintf( ' ( %d )', $stock_quantity ) 这部分可以根据您的喜好进行调整，例如修改括号样式、添加前缀文字等。
- 性能考量： 这种方法对性能影响极小，因为它只在生成可用性文本时执行一次简单的条件判断和字符串拼接。
- 兼容性： 该方法利用WooCommerce的内置过滤器，具有良好的兼容性，不易受WooCommerce版本更新的影响。
总结
通过巧妙地利用woocommerce_get_availability_text过滤器并结合用户权限判断，我们可以轻松地实现为特定用户角色（如管理员）在WooCommerce单产品页面上显示精确库存数量的需求。这种方法比尝试使用短代码更为集成和高效，它直接增强了WooCommerce原有的库存显示功能，提供了更专业和精细化的库存管理视图，同时保持了对普通客户的简洁体验。
