usces_tax() / 表示系関数

購入に必要な消費税を出力する(フロントエンド)

説明

購入内容確認ページにて、消費税額を出力します。
この関数は、グローバル変数 $usces_entries['order']['tax'] を返すだけ処理を行います。

使い方

<?php usces_tax( $usces_entries, $out ); ?>

パラメータ

data
配列) global $usces_entries
この配列は、$usces->cart->get_entry() でも取得できます。
out
文字列) 戻り値の出力を echo するか return するかを決める。
初期値は 空白(echo)。
  • 'return' - return する
  • 空白(引数無し) - echo する(初期値)

戻り値

(文字列)
通貨フォーマットされた消費税額。

注意

グローバル変数 $usces_entries['order']['tax'] に消費税額がセット(登録・更新)されるタイミングは、購入内容確認ページが表示される時です。従って、内容確認ページを表示する前は、この関数では消費税を表示することができません。この場合の消費税の算出は $usces->getTax( $totalprice ) を使用します。

用例

<?php global $usces_entries; usces_tax( $usces_entries ); ?>
wc_templates に記述する場合は、global $usces_entries; は書く必要がありません。

<?php global $usces; $usces_entries = $usces->cart->get_entry(); usces_tax( $usces_entries ); ?>

フック

変更履歴

  • 1.4 にて導入されました。

ソースファイル

usc-e-shop/functions/template_func.php

関連資料