wake-up-neo.net

Help Tabs with: add_help_tab () callback - Wie funktioniert das Argument?

Ich habe gerade versucht, eine einfache Hilferegisterkarte aus einer Klasse heraus hinzuzufügen (Beispiel zum Testen unten). Ich wollte einen Helfer/Callback-Fn verwenden, um den Inhalt für verschiedene Hilfe-Registerkarten vorzubereiten. Nach Kern nimmt die Funktion einige Argumente:

WP 3.3 /wp-admin/includes/screen.php LINE 722

     // If it exists, fire tab callback.
     if ( ! empty( $tab['callback'] ) )
        call_user_func_array( $tab['callback'], array( $this, $tab ) );

Aus irgendeinem Grund erhalte ich im Rückruf das vollständige WP_Screen-Objekt, anstatt nur den Tabulator. Siehe Pastebin hier .

Hier ist das Beispiel. Für Ihre Bequemlichkeit, als Plugin, so ist das Testen einfacher (auf Post-Screens).

<?php
/**
 * Plugin Name: Help Tab Test Case
 * Plugin URI:  http://unserkaiser.com
 * Description: Add Help Tab test case
 */
class example_help
{
    public $tabs = array(
         'EXAMPLE' => array(
             'title'   => 'TEST ME!'
            ,'content' => 'FOO'
         )
    );

   static public function init()
    {
        $class = __CLASS__ ;
        new $class;
    }

    public function __construct()
    {
        add_action( "load-{$GLOBALS['pagenow']}", array( $this, 'add_tabs' ), 20 );
    }

    public function add_tabs()
    {
        foreach ( $this->tabs as $id => $data )
        {
            get_current_screen()->add_help_tab( array(
                 'id'       => $id
                ,'title'    => __( $data['title'], 'some_textdomain' )
                ,'content'  => $data['content']
                ,'callback' => array( $this, 'prepare' )
            ) );
        }
    }

    /* HELPER */
    public function prepare( $tab )
    {
error_reporting( E_ALL );
// FAILS: return blank
// _dump( $tab['tabs'] );
// No error output on screen
var_dump( $tab );

// I can dump it using my own function, 
// that adds the data to a global and then calls & prints it on shutdown
// See Pastebin for content
// _dump( $tab );
        return printf( 
             '<p>%s</p>'
            ,__( 'test', 'dmb_textdomain' )
        );
    }
}
add_action( 'load-post.php', array( 'example_help', 'init' ) );
add_action( 'load-post-new.php', array( 'example_help', 'init' ) );

Bearbeiten:

Wenn ich im Rückruf nur print $tab ausgebe, erhalte ich Array als Ausgabezeichenfolgeüberden tatsächlichen Inhalt (WP_Screen ist ein Objekt). Ich habe versucht, alle Teile des Arrays ohne Ergebnis zu sichern (weißer Bildschirm, kein Fehler).

3
kaiser

OK. Die Antwort istNICHTeinfach, aber nach einigem Ausprobieren, Lesen des Kerns usw. habe ich herausgefunden, was das Problem ist:

Der Rückruf (deranstelle vondes contentverwendet werden sollte) akzeptiert zwei Argumente: $current_screen und $tab.

So sieht $tab aus, wenn er für einen einzelnen Tab ausgegeben wird.

Array
(
    [title] => TEST ME
    [id] => EXAMPLE_A
    [content] => 
    [callback] => Array
        (
            [0] => dmb_help Object
                (
                    [tabs] => Array
                        (
                            [EXAMPLE_A] => Array
                                (
                                    [title] => TEST ME
                                    [content] => FOO
                                )

                            [EXAMPLE_B] => Array
                                (
                                    [title] => TEST ME ALSO
                                    [content] => BAR
                                )

                        )

                )

            [1] => prepare
        )

)

WICHTIGE INFORMATIONEN: Du bist nicht !! (auf keinen Fall) dürfen Leerzeichen innerhalb eines idname __- Strings verwendet werden. Dann können Sie den eigentlichen Inhalt aus dem Objekt abrufen:

public function prepare( $screen, $tab )
{
    printf( 
         '<p>%s</p>'
        ,__( 
             $tab['callback'][0]->tabs[ $tab['id'] ]['content']
            ,'some_textdomain' 
         )
    );
}

Sie sollten contentvollständig im Eingabearray ablegen (bis Sie beim Durchlaufen mehrerer Hilfe-Registerkarten keine sich wiederholenden Inhalte mehr hinzufügen möchten).

Letztes Arbeitsbeispiel:

Hier ist der Arbeitstext als Plugin.

<?php
/**
 * Plugin Name: Help Tab Test Case
 * Plugin URI:  http://unserkaiser.com
 * Description: Add Help Tab test case
 */
class example_help
{
    public $tabs = array(
        // The assoc key represents the ID
        // It is NOT allowed to contain spaces
         'EXAMPLE' => array(
             'title'   => 'TEST ME!'
            ,'content' => 'FOO'
         )
    );

    static public function init()
    {
        $class = __CLASS__ ;
        new $class;
    }

    public function __construct()
    {
        add_action( "load-{$GLOBALS['pagenow']}", array( $this, 'add_tabs' ), 20 );
    }

    public function add_tabs()
    {
        foreach ( $this->tabs as $id => $data )
        {
            get_current_screen()->add_help_tab( array(
                 'id'       => $id
                ,'title'    => __( $data['title'], 'some_textdomain' )
                // Use the content only if you want to add something
                // static on every help tab. Example: Another title inside the tab
                ,'content'  => '<p>Some stuff that stays above every help text</p>'
                ,'callback' => array( $this, 'prepare' )
            ) );
        }
    }

    public function prepare( $screen, $tab )
        {
            printf( 
             '<p>%s</p>'
            ,__( 
                     $tab['callback'][0]->tabs[ $tab['id'] ]['content']
                ,'dmb_textdomain' 
             )
        );
    }
}
// Always add help tabs during "load-{$GLOBALS['pagenow'}".
// There're some Edge cases, as for example on reading options screen, your
// Help Tabs get loaded before the built in tabs. This seems to be a core error.
add_action( 'load-post.php', array( 'example_help', 'init' ) );
add_action( 'load-post-new.php', array( 'example_help', 'init' ) );
4
kaiser

Wenn Sie nicht wissen, wie viele oder welche Argumente Ihren Rückruf erreichen, probieren Sie diese beiden nützlichen PHP-Funktionen aus:

func_num_args()

und

func_get_args()

Der erste zeigt Ihnen, wie viele Argumente gesendet werden. Die zweite gibt Ihnen ein Array mit den Argumenten.

public function prepare(){

   echo 'Number of arguments: ' . $func_num_args();
   echo 'Arguments:';
   var_dump( func_get_args() );

}
1
Ralf912