WooCommerce显示精准库存数量教程

本教程详细介绍了如何在WooCommerce单品页为管理员用户展示商品的精确库存数量，而非仅显示有货/缺货状态。通过利用`woocommerce_get_availability_text`过滤器钩子，我们可以在不影响普通客户体验的前提下，为特定用户角色（如管理员或商店经理）动态添加库存数值，实现精细化的信息展示。

在WooCommerce商店中，通常我们希望向普通客户展示商品的库存状态，例如“有货”或“缺货”。然而，对于内部管理人员（如管理员或商店经理），往往需要查看商品的精确库存数量，以便进行库存管理和销售决策。本文将详细指导您如何实现这一需求，确保只有特定用户角色能看到精确的库存数值。

理解问题：为何默认方法不适用

许多开发者可能首先想到通过自定义短代码来获取并显示库存。例如，尝试使用global $product; echo wc_get_stock_html( $product ); 或 echo $product->get_stock_quantity();。然而，wc_get_stock_html() 函数会根据WooCommerce的设置输出预定义的库存状态文本，而直接输出$product->get_stock_quantity()虽然能得到数值，但通常需要更精细的控制，例如将其集成到现有的“有货/缺货”文本中，并仅对特定用户显示。

直接在短代码中尝试类似以下逻辑：

function custom_product_stock_display() {
    if ( current_user_can( 'administrator' ) ) {
        global $product;
        if ( $product ) {
            return '
可用库存 (管理员): ' . $product->get_stock_quantity() . '
';
        }
    }
    return ''; // 普通用户不显示任何内容
}
add_shortcode( 'admin_stock', 'custom_product_stock_display' );

虽然这种方法可以显示库存，但它会创建一个独立的显示区域。更优雅的解决方案是，在现有“有货/缺货”文本的旁边直接追加精确库存数量，并且仅对管理员可见。

解决方案：利用 woocommerce_get_availability_text 过滤器

WooCommerce提供了一个名为 woocommerce_get_availability_text 的过滤器钩子，允许我们在商品可用性文本被显示到前端之前对其进行修改。这是实现我们目标的最理想方式，因为它直接作用于库存状态文本本身。

实现步骤

1. 打开主题的 functions.php 文件 将以下代码片段添加到您的WordPress子主题的 functions.php 文件中。强烈建议使用子主题，以避免在主题更新时丢失您的自定义更改。

2. 添加过滤器代码

   /**
    * WC：仅对管理员和商店经理在前端显示商品精确库存数量
    *
    * 该函数通过 'woocommerce_get_availability_text' 过滤器钩子，
    * 在商品可用性文本后追加精确库存数量，且仅对特定用户角色可见。
    *
    * @param string   $availability 默认的可用性文本（例如“有货”、“缺货”）。
    * @param WC_Product $product      当前的商品对象。
    * @return string 修改后的可用性文本。
    */
   add_filter( 'woocommerce_get_availability_text', 'custom_add_product_quantity_for_admins', 10, 2 );
   
   function custom_add_product_quantity_for_admins( $availability, $product ) {
       // 检查当前用户是否拥有 'manage_woocommerce' 权限
       // 您也可以替换为 'administrator' 仅限管理员，或根据需要添加其他条件
       if ( current_user_can( 'manage_woocommerce' ) ) {
           // 获取商品的精确库存数量
           $stock_quantity = $product->get_stock_quantity();
           // 将精确库存数量追加到现有可用性文本后
           $availability .= sprintf( ' ( %d )', $stock_quantity );
       }
       return $availability;
   }

代码解析

• add_filter( 'woocommerce_get_availability_text', 'custom_add_product_quantity_for_admins', 10, 2 );

  • woocommerce_get_availability_text：这是WooCommerce提供的一个过滤器钩子，它在生成商品可用性文本时触发。
  • custom_add_product_quantity_for_admins：这是我们将要执行的回调函数，用于修改文本。
  • 10：优先级，数字越小越早执行。
  • 2：表示回调函数接受两个参数。

• function custom_add_product_quantity_for_admins( $availability, $product )

  • $availability：这是由WooCommerce生成的原始库存可用性文本（例如“有货”）。
  • $product：这是当前的 WC_Product 对象，我们可以通过它访问商品的各种属性，包括库存数量。

• if ( current_user_can( 'manage_woocommerce' ) )

  • 这是一个权限检查。current_user_can() 函数用于判断当前用户是否拥有指定的权限。
  • 'manage_woocommerce'：此权限通常授予商店经理和管理员。如果您只想让管理员看到，可以将其更改为 'administrator'。您也可以根据需要定义其他自定义权限。

• $stock_quantity = $product->get_stock_quantity();

  • $product->get_stock_quantity()：这是获取商品精确库存数量的方法。

• $availability .= sprintf( ' ( %d )', $stock_quantity );

  • sprintf() 函数用于格式化字符串。这里我们将获取到的 $stock_quantity 插入到 ( %d ) 格式中。
  • $availability .= ...：这表示将格式化后的库存数量追加到原始的 $availability 文本后面。

• return $availability;

  • 修改后的 $availability 文本被返回，WooCommerce将使用这个新文本进行显示。

效果展示

• 对管理员/商店经理显示：可用性：有货 ( 18 ) 或 可用性：缺货 ( 0 )

• 对普通客户显示：可用性：有货 或 可用性：缺货

注意事项与最佳实践

• 使用子主题： 务必将代码放置在子主题的 functions.php 文件中，以确保在父主题更新时您的自定义代码不会被覆盖。
• 权限控制： 根据您的实际需求选择合适的 current_user_can() 权限。'manage_woocommerce' 适用于商店经理和管理员，而 'administrator' 则仅限于管理员。
• 代码健壮性： 虽然WooCommerce通常会提供 $product 对象，但在某些极端情况下，可以考虑添加 if ( $product ) 检查以增加代码的健壮性。
• 缓存： 如果您使用了页面缓存插件，请在添加或修改代码后清除缓存，以确保更改立即生效。
• 自定义格式： 您可以根据需要修改 sprintf() 中的格式字符串，例如，如果您希望显示为 [库存: 18]，可以将其改为 sprintf( ' [库存: %d]', $stock_quantity )。

总结

通过利用 woocommerce_get_availability_text 过滤器钩子，我们能够以一种优雅且非侵入性的方式，为WooCommerce商店的管理员和商店经理提供商品的精确库存数量信息，而不会影响普通客户的购物体验。这种方法灵活且易于实现，是管理商品库存信息展示的有效策略。