概要
woocommerce_email_settings_after
は WooCommerce の設定ページにおいて、メール設定の後にカスタムフィールドや追加設定などを挿入するために使用されるフックです。このアクションを使うことで、以下のような機能を実装する際に役立ちます。
- メール設定の追加オプションを挿入。
- カスタム設定値を保存する処理の追加。
- ユーザーに特定の情報を入力させるためのフィールドを追加。
- 設定内容の説明やヘルプテキストを表示。
- メール通知に関する設定をカスタマイズ。
- 外部APIとの連携設定項目を挿入。
構文
add_action('woocommerce_email_settings_after', 'your_custom_function');
function your_custom_function() {
// カスタムコードをここに追加
}
パラメータ
woocommerce_email_settings_after
アクションにはパラメータはありません。
戻り値
このアクションは値を返すことはありません。
使用可能なプラグインのバージョン
- WooCommerce: 3.0以上
- WordPress: 4.0以上
サンプルコード
サンプル1: メール設定のカスタムフィールドの追加
このコードではメール設定の後にカスタムテキストエリアを追加し、設定内容を保存することを実装しています。
add_action('woocommerce_email_settings_after', 'add_custom_email_setting');
function add_custom_email_setting() {
woocommerce_admin_fields(array(
'id' => 'custom_email_setting',
'title' => __('Custom Email Setting', 'woocommerce'),
'type' => 'textarea',
'description' => __('Add any custom information for email settings.', 'woocommerce'),
));
}
引用元: https://docs.woocommerce.com/
サンプル2: ヘルプテキストの挿入
このサンプルコードでは、メール設定の後にヘルプテキストを挿入しています。
add_action('woocommerce_email_settings_after', 'add_help_text');
function add_help_text() {
echo '<p class="description">' . __('Help: Customize your email settings above.', 'woocommerce') . '</p>';
}
引用元: https://woocommerce.com/
サンプル3: SMTP設定オプションの追加
このコードはSMTP設定エリアをメール設定の後に追加するためのものです。
add_action('woocommerce_email_settings_after', 'add_smtp_settings');
function add_smtp_settings() {
?>
<h3><?php _e('SMTP Settings', 'woocommerce'); ?></h3>
<table class="form-table">
<tr valign="top">
<th scope="row"><?php _e('SMTP Host', 'woocommerce'); ?></th>
<td><input type="text" name="smtp_host" value="<?php echo get_option('smtp_host'); ?>" /></td>
</tr>
</table>
<?php
}
引用元: https://wordpress.org/
サンプル4: 設定値の保存
このコードでは、カスタムフィールドの値を保存する処理を実装しています。
add_action('woocommerce_email_settings_after', 'save_custom_email_setting');
function save_custom_email_setting() {
if (isset($_POST['custom_email_setting'])) {
update_option('custom_email_setting', sanitize_textarea_field($_POST['custom_email_setting']));
}
}
引用元: https://developer.wordpress.org/
サンプル5: オプション選択フィールドの追加
このコードでは、選択肢を持つカスタムオプションを追加しています。
add_action('woocommerce_email_settings_after', 'add_option_select');
function add_option_select() {
?>
<tr valign="top">
<th scope="row"><?php _e('Email Option', 'woocommerce'); ?></th>
<td>
<select name="email_option">
<option value="option1"><?php _e('Option 1', 'woocommerce'); ?></option>
<option value="option2"><?php _e('Option 2', 'woocommerce'); ?></option>
</select>
</td>
</tr>
<?php
}
引用元: https://woocommerce.com/
この関数のアクションでの使用可能性
アクション名 | 使用例 |
---|---|
mu_plugin_loaded | |
registered_post_type | |
plugins_loaded | |
wp_roles_init | |
setup_theme | |
after_setup_theme | |
set_current_user | |
init | |
register_sidebar | |
wp_loaded | |
send_headers | |
parse_query | |
pre_get_posts | |
wp | |
template_redirect | |
get_header | |
wp_head |