web-dev-qa-db-ja.com

Add_settings_section（）コールバックに変数を渡るにはどうすればいいですか？

可能な限り、Settings API関数がプラグインの各設定を呼び出すように自動化しようとしています。 options配列をループ処理し、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()を使えば、関数呼び出しの5番目のパラメータとして、$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
            }
        }
    }
}
settingsapisettings-api
15
Chip Bennett

do_settings_sections という関数を見れば、コールバック関数が実行されている1164行目になります。

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

$ section配列がコールバック関数に渡されていることがわかりますので、$section['id']でコールバックを識別できます。

これがそれ以降を願​​っています。

更新

これは一例です。すべてのセクションの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
    }
 }

do doということは、そのセクションのコールバックでやりたいことをすべてやるということです。

17
Bainternet

これは古い質問ですが、他の誰かが来た場合に備えて、2セントを投入します。これを行う簡単な方法は、add_settings_section()関数の独自の変更を記述することです。これは、コールバックargsパラメーターを最後に追加するだけです。

これは次のようになります（またはそれに似たもの）

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を呼び出すとき、$sectionsパラメーターをBainternetが指摘したように渡します。これは、my_add_settings_section()で$wp_settings_sectionsに追加した配列全体が、コールバック。つまり、callbackargsなど、追加するすべての新しい配列メンバーにアクセスできるため、関数に本格的なコールバックを持たせることができます。

これが明らかであると確信していても、混乱した人が覗き込んだ場合に備えて説明したいと思いました。

4
Cikica

また、特定の関数実装を探すのではなく、より一般的な方法を使うこともできます（つまり、add_settings_sectionが暗黙のうちに何かを渡すかどうかをチェックせずに）。この一般的なアプローチはPHPクロージャを使います。

使い方：関数名を渡すところはどこでも、無名関数を渡す代わりに use を付けます。

例：

の代わりに

foreach ( $ar as $name => value ) {
    add_settings_section(
        $section,
        'something',
        'something-else',
        'callback_name'
    );
}

function callback_name() {
    do_something();
}

あなたが使用することができます：

foreach ( $ar as $name => value ) {
    add_settings_section(
        $section,
        'something',
        'something-else',
        function () use ( $name, $value ) {
            callback_name( $name, $value )
        }
    );
}

function callback_name( $name, $value ) {
    do_something( $name, $value );
}
0
Olga Farber