usces_get_custom_field_value / ユーティリティー関数

Welcart専用のカスタムフィールドの値を取得

説明

Welcart 専用のカスタムフィールドの値を取得します。
この関数で取得できるカスタムフィールドは以下の4つです。

  • カスタム・オーダーフィールド・・・・発送支払方法ページで表示されるフィールド
  • カスタム・カスタマーフィールド・・・・お客様情報入力ページで表示されるフィールド
  • カスタム・デリバリーフィールド・・・・発送支払方法ページで、別配送先を指定するときに表示されるフィールド
  • カスタム・メンバーフィールド・・・・会員登録、編集時に表示されるフィールド

使い方

$company_name = usces_get_custom_field_value( $field, $key, $id, $out );

パラメータ

field
文字列)カスタムフィールド区分
区分は以下の4つ
order・・・カスタム・オーダーフィールド
customer・・・カスタム・カスタマーフィールド
delivery・・・カスタム・デリバリーフィールド
member・・・カスタム・メンバーフィールド
key
文字列)カスタムフィールド登録時に設定したフィールドキー
id
数値)オーダーIDまたはメンバーID
カスタム・メンバーフィールドのみメンバーIDを指定し、他はオーダーIDを指定する
out
文字列) 戻り値の出力を echo するか return するかを決める。
初期値は 空白(echo)。

  • ‘return’ – return する
  • 空白(引数無し) – echo する(初期値)

戻り値

カスタムフィールドの値
  • ‘return’ – そのままreturn
  • 空白(引数無し) – echo

注意

カスタム・オーダーフィールド、カスタム・カスタマーフィールド、カスタム・デリバリーフィールドは、カートページ設定より登録できます。また、カスタム・メンバーフィールドはメンバーページ設定より登録できます。

用例

$company_name = usces_get_custom_field_value( 'customer', 'company', $order_id, 'return' );
$hobby = usces_get_custom_field_value( 'member', 'hobby', $member_id, 'return' );

フック

  • 利用できるフックはありません。

ソースファイル

usc-e-shop/functions/template_func.php

関連資料

  • $usces->get_order_meta_value()
  • usces_custom_field_info() ・・・ 入力されたカスタムフィールドの情報を表示する
  • usces_has_custom_field_meta()