WordPress 如何传递变量到 add_settings_section() 回调？

问题描述

我试图尽可能地自动化插件中每个设置的 Settings API 函数调用。循环选择数组，并输出 add_settings_section()和 add_settings_field()简单：

add_settings_section()：

$oenology_hooks_tabs = oenology_hooks_get_settings_page_tabs();
foreach ( $oenology_hooks_tabs as $tab ) {
    $tabname = $tab['name'];
    $tabtitle = $tab['title'];
    $tabsections = $tab['sections'];
    foreach ( $tabsections as $section ) {
        $sectionname = $section['name'];
        $sectiontitle = $section['title'];
        $sectiondescription = $section['description'];
        // Add settings section
        add_settings_section(
            'oenology_hooks_' . $sectionname . '_section',
            $sectiontitle,
            'oenology_hooks_' . $sectionname . '_text',
            'oenology_hooks_' . $tabname . '_tab'
        );
    }
}

和`add_settings_field()：

global $oenology_hooks;
$oenology_hooks = oenology_hooks_get_hooks();

foreach ( $oenology_hooks as $hook ) {
    $hookname = $hook['name'];
    $hooktitle = $hook['title'];
    $hooktab = $hook['tab'];
    $hooksection = $hook['section'];
    add_settings_field(
        'oenology_hooks_' . $hookname,
        $hooktitle,
        'oenology_hooks_setting_callback',
        'oenology_hooks_' . $hooktab . '_tab',
        'oenology_hooks_' . $hooksection . '_section',
        $hook
    );
}

使用 add_settings_field()，通过将 $hook 变量传递给回调，我可以轻松地编写一个通用回调函数，作为函数调用中的第五个参数：

function oenology_hooks_setting_callback( $hook ) {
    $oenology_hooks_options = get_option( 'plugin_oenology_hooks_settings' ); 
    $hookname = $hook['name'];
    $hooktitle = $hook['title'];
    $hookdescription = $hook['description'];
    $hooktype = $hook['type'];
    $hooktab = $hook['tab'];
    $hooksection = $hook['section'];
    $inputvalue = $hookname . '_hide';
    $inputname = 'plugin_oenology_hooks_settings[' . $inputvalue . ']';
    $textareaname = 'plugin_oenology_hooks_settings[' . $hookname . ']';
    $textareavalue = $oenology_hooks_options[$hookname];
    if ( 'Filter' == $hooktype ) {
        ?>
        <input type="checkbox" name="<?php echo $inputname; ?>" value="<?php echo $inputvalue;?>" <?php checked( true == $oenology_hooks_options[$inputvalue]  ); ?> />
        <span>Hide <?php echo $hooktitle; ?> content?</span><br />
        <?php
    }
    ?>
    <span class="description"><?php echo $hooktype; ?> Hook: <?php echo $hookdescription; ?></span><br />
    <textarea name="<?php echo $textareaname; ?>" cols="80" rows="3" ><?php 
        echo esc_textarea( $textareavalue ); 
    ?></textarea>
    <?php 
}

但是，似乎 add_settings_section()没有类似的 $args 参数; 因此，我不能使用相同的方法将 $section 变量传递给回调。

因此，我的问题是：有没有办法将变量传递给 add_settings_section()回调，或者其他一些方法来创建类似于 add_settings_field()的回调？

编辑：

@Bainternet 钉了它！这是我的工作代码：

/**
 * Callback for add_settings_section()
 * 
 * Generic callback to output the section text
 * for each Plugin settings section. 
 * 
 * @param   array   $section_passed Array passed from add_settings_section()
 */
function oenology_hooks_sections_callback( $section_passed ) {
    global $oenology_hooks_tabs;
    $oenology_hooks_tabs = oenology_hooks_get_settings_page_tabs();
    foreach ( $oenology_hooks_tabs as $tab ) {
        $tabname = $tab['name'];
        $tabsections = $tab['sections'];
        foreach ( $tabsections as $section ) {
            $sectionname = $section['name'];
            $sectiondescription = $section['description'];
            $section_callback_id = 'oenology_hooks_' . $sectionname . '_section';
            if ( $section_callback_id == $section_passed['id'] ) {
                ?>
                <p><?php echo $sectiondescription; ?></p>
                <?php
            }
        }
    }
}

最佳解决方案

如果您仔细查看 do_settings_sections 函数更具体地执行回调函数的行 1164：

call_user_func($section['callback'], $section);

您可以看到 $ section 数组被传递给回调函数，因此您可以通过 $section['id']来识别回调

希望这样做。

Update

这里是一个例子，如果你所有部分的 add_settings_section 回调命名为 oenology_hooks_section_callback，那么你可以这样识别：

function oenology_hooks_section_callback($section_passed){
    if ($section_passed['id'] == 'whatever_section_id'){
        //do stuff
    }
    if ($section_passed['id'] == 'whatever_section_id_number2'){
        //do other stuff
    }
 }

并且做的东西我的意思是做任何你想做的那个部分回调。

次佳解决方案

我知道这是一个古老的问题，但我会把我的两分钱，以防万一有人来; 这样做的一个更简单的方法是写你自己修改的 add_settings_section()函数，这只会在它的末尾添加一个回调参数参数。

这看起来像这样 (或类似的东西)

function my_add_settings_section($id, $title, $callback, $page, $callbackargs) {

global $wp_settings_sections;

if ( !isset($wp_settings_sections) ) 
{
    $wp_settings_sections = array();
}

if ( !isset($wp_settings_sections[$page]) )
{
    $wp_settings_sections[$page] = array();
}

if ( !isset($wp_settings_sections[$page][$id]) )
{
    $wp_settings_sections[$page][$id] = array();
}

$wp_settings_sections[$page][$id] = array( 'id' => $id, 'title' => $title, 'callback' => $callback, 'callbackargs' => $callbackargs, 'page' => 'page' );
}

现在，您只需使用这个而不是本机 wordpress 函数，并通过'callbackargs'数组键以通常的方式访问您的回调参数，就像这样

function oenology_hooks_sections_callback( $section_passed ) {
   // Our callback arguments  
   $section_passed['callbackargs']
}

我们可以用来传递给其他一些功能：

 function oenology_hooks_sections_callback( $section_passed ) {
   // Our callback arguments  
   $args = $section_passed['callbackargs'];
   some_other_function( $args );
}

或者回调参数可以是我们使用的数组本身：

function oenology_hooks_sections_callback( $section_passed ) {
   // Our callback arguments  
   if ( $section_passed['callbackargs']['stuff'] !== 'things' ) 
   {
       echo 'stuff is not things!";
   }
}

这一切都是可能的，因为所有 add_settings_section()都是向 $wp_settings_sections 全局变量添加一个新的数组成员，新的数组成员可以是一个数组，它包含任意数量的具有不同名称的键，可以使用任何知道它们的函数那里。当 do_settings_sections 调用 call_user_func_array 时，它会按照 Bainternet 的说法通过 $sections 参数，这意味着我们在 my_add_settings_section()中添加到 $wp_settings_sections 的整个阵列被传递到我们的回调中，这意味着我们可以访问我们添加到的每个新的阵列成员，如 callbackargs，允许我们的功能有一个完整的回调。

即使我确信这可能是明显的，我以为我会解释它，以防万一有困惑的人看。

参考文献

How to pass variable to add_settings_section() callback?

注：本文内容整合自 Google/Baidu/Bing 辅助翻译的英文资料结果。如果您对结果不满意，可以加入我们改善翻译效果：薇晓朵技术论坛。

WordPress 如何传递变量到 add_settings_section() 回调？