„Błąd: nie znaleziono strony opcji” w zgłoszeniu strony ustawień wtyczki OOP

19

Tworzę wtyczkę, korzystając z repozytorium Boilerplate Toma McFarlina jako szablonu, który wykorzystuje praktyki OOP. Próbowałem dowiedzieć się, dlaczego nie mogę poprawnie przesłać moich ustawień. Próbowałem ustawić atrybut akcji na pusty ciąg, jak sugerowano w innym pytaniu tutaj, ale to nie pomogło ...

Poniżej znajduje się ogólna konfiguracja kodu, którego używam ...

Formularz (/views/admin.php):

<div class="wrap">
    <h2><?php echo esc_html( get_admin_page_title() ); ?></h2>
    <form action="options.php" method="post">
        <?php
        settings_fields( $this->plugin_slug );
        do_settings_sections( $this->plugin_slug );
        submit_button( 'Save Settings' );
        ?>
    </form>
</div>

W przypadku następującego kodu załóżmy, że istnieją wszystkie wywołania zwrotne dla add_settings_field () i add_settings_section (), z wyjątkiem „wyboru_listy opcji”.

Klasa administratora wtyczek (/ {nazwa wtyczki} -class-admin.php):

namespace wp_plugin_name;

class Plugin_Name_Admin
{
    /**
     * Note: Some portions of the class code and method functions are missing for brevity
     * Let me know if you need more information...
     */

    private function __construct()
    {
        $plugin              = Plugin_Name::get_instance();

        $this->plugin_slug   = $plugin->get_plugin_slug();
        $this->friendly_name = $plugin->get_name(); // Get "Human Friendly" presentable name

        // Adds all of the options for the administrative settings
        add_action( 'admin_init', array( $this, 'plugin_options_init' ) );

        // Add the options page and menu item
        add_action( 'admin_menu', array( $this, 'add_plugin_admin_menu' ) );


    }

    public function add_plugin_admin_menu()
    {

        // Add an Options Page
        $this->plugin_screen_hook_suffix =
        add_options_page(
            __( $this->friendly_name . " Options", $this->plugin_slug ),
            __( $this->friendly_name, $this->plugin_slug ),
            "manage_options", 
            $this->plugin_slug,
            array( $this, "display_plugin_admin_page" )
        );

    }

    public function display_plugin_admin_page()
    {
        include_once( 'views/admin.php' );
    }

    public function plugin_options_init()
    {
        // Update Settings
        add_settings_section(
            'maintenance',
            'Maintenance',
            array( $this, 'maintenance_section' ),
            $this->plugin_slug
        );

        // Check Updates Option
        register_setting( 
            'maintenance',
            'plugin-name_check_updates',
            'wp_plugin_name\validate_bool'
        );

        add_settings_field(
            'check_updates',
            'Should ' . $this->friendly_name . ' Check For Updates?',
            array( $this, 'check_updates_field' ),
            $this->plugin_slug,
            'maintenance'
        );

        // Update Period Option
        register_setting(
            'maintenance',
            'plugin-name_update_period',
            'wp_plugin_name\validate_int'
        );

        add_settings_field(
            'update_frequency',
            'How Often Should ' . $this->friendly_name . ' Check for Updates?',
            array( $this, 'update_frequency_field' ),
            $this->plugin_slug,
            'maintenance'
        );

        // Plugin Option Configurations
        add_settings_section(
            'category-option-list', 'Widget Options List',
            array( $this, 'option_list_section' ),
            $this->plugin_slug
        );
    }
}

Niektóre wymagane aktualizacje:

Zmiana atrybutu działania na:

<form action="../../options.php" method="post">

... po prostu powoduje błąd 404. Poniżej znajduje się fragment dzienników Apache. Pamiętaj, że domyślne skrypty WordPress i kolejki CSS są usuwane:

# Changed to ../../options.php
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-admin/options-general.php?page=pluginname-widget HTTP/1.1" 200 18525
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-content/plugins/PluginName/admin/assets/css/admin.css?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:15:59:43 -0400] "GET /wp-content/plugins/PluginName/admin/assets/js/admin.js?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:15:59:52 -0400] "POST /options.php HTTP/1.1" 404 1305
127.0.0.1 - - [01/Apr/2014:16:00:32 -0400] "POST /options.php HTTP/1.1" 404 1305

#Changed to options.php
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-admin/options-general.php?page=pluginname-widget HTTP/1.1" 200 18519
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-content/plugins/PluginName/admin/assets/css/admin.css?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:16:00:35 -0400] "GET /wp-content/plugins/PluginName/admin/assets/js/admin.js?ver=0.1.1 HTTP/1.1" 304 -
127.0.0.1 - - [01/Apr/2014:16:00:38 -0400] "POST /wp-admin/options.php HTTP/1.1" 500 2958

Zarówno plik php-error.log, jak i plik debug.log, gdy WP_DEBUG ma wartość true, są puste.

Klasa wtyczek (/{plugin-name}-class.php)

namespace wp_plugin_name;

class Plugin_Name
{
    const VERSION = '1.1.2';
    const TABLE_VERSION = 1;
    const CHECK_UPDATE_DEFAULT = 1;
    const UPDATE_PERIOD_DEFAULT = 604800;

    protected $plugin_slug = 'pluginname-widget';
    protected $friendly_name = 'PluginName Widget';

    protected static $instance = null;

    private function __construct()
    {

        // Load plugin text domain
        add_action( 'init',
                    array(
            $this,
            'load_plugin_textdomain' ) );

        // Activate plugin when new blog is added
        add_action( 'wpmu_new_blog',
                    array(
            $this,
            'activate_new_site' ) );

        // Load public-facing style sheet and JavaScript.
        add_action( 'wp_enqueue_scripts',
                    array(
            $this,
            'enqueue_styles' ) );
        add_action( 'wp_enqueue_scripts',
                    array(
            $this,
            'enqueue_scripts' ) );

        /* Define custom functionality.
         * Refer To http://codex.wordpress.org/Plugin_API#Hooks.2C_Actions_and_Filters
         */

    }

    public function get_plugin_slug()
    {
        return $this->plugin_slug;
    }

    public function get_name()
    {
        return $this->friendly_name;
    }

    public static function get_instance()
    {

        // If the single instance hasn't been set, set it now.
        if ( null == self::$instance )
        {
            self::$instance = new self;
        }

        return self::$instance;

    }

    /**
     * The member functions activate(), deactivate(), and update() are very similar.
     * See the Boilerplate plugin for more details...
     *
     */

    private static function single_activate()
    {
        if ( !current_user_can( 'activate_plugins' ) )
            return;

        $plugin_request = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';

        check_admin_referer( "activate-plugin_$plugin_request" );

        /**
         *  Test to see if this is a fresh installation
         */
        if ( get_option( 'plugin-name_version' ) === false )
        {
            // Get the time as a Unix Timestamp, and add one week
            $unix_time_utc = time() + Plugin_Name::UPDATE_PERIOD_DEFAULT;

            add_option( 'plugin-name_version', Plugin_Name::VERSION );
            add_option( 'plugin-name_check_updates',
                        Plugin_Name::CHECK_UPDATE_DEFAULT );
            add_option( 'plugin-name_update_frequency',
                        Plugin_Name::UPDATE_PERIOD_DEFAULT );
            add_option( 'plugin-name_next_check', $unix_time_utc );

            // Create options table
            table_update();

            // Let user know PluginName was installed successfully
            is_admin() && add_filter( 'gettext', 'finalization_message', 99, 3 );
        }
        else
        {
            // Let user know PluginName was activated successfully
            is_admin() && add_filter( 'gettext', 'activate_message', 99, 3 );
        }

    }

    private static function single_update()
    {
        if ( !current_user_can( 'activate_plugins' ) )
            return;

        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';

        check_admin_referer( "activate-plugin_{$plugin}" );

        $cache_plugin_version         = get_option( 'plugin-name_version' );
        $cache_table_version          = get_option( 'plugin-name_table_version' );
        $cache_deferred_admin_notices = get_option( 'plugin-name_admin_messages',
                                                    array() );

        /**
         * Find out what version of our plugin we're running and compare it to our
         * defined version here
         */
        if ( $cache_plugin_version > self::VERSION )
        {
            $cache_deferred_admin_notices[] = array(
                'error',
                "You seem to be attempting to revert to an older version of " . $this->get_name() . ". Reverting via the update feature is not supported."
            );
        }
        else if ( $cache_plugin_version === self::VERSION )
        {
            $cache_deferred_admin_notices[] = array(
                'updated',
                "You're already using the latest version of " . $this->get_name() . "!"
            );
            return;
        }

        /**
         * If we can't determine what version the table is at, update it...
         */
        if ( !is_int( $cache_table_version ) )
        {
            update_option( 'plugin-name_table_version', TABLE_VERSION );
            table_update();
        }

        /**
         * Otherwise, we'll just check if there's a needed update
         */
        else if ( $cache_table_version < TABLE_VERSION )
        {
            table_update();
        }

        /**
         * The table didn't need updating.
         * Note we cannot update any other options because we cannot assume they are still
         * the defaults for our plugin... ( unless we stored them in the db )
         */

    }

    private static function single_deactivate()
    {

        // Determine if the current user has the proper permissions
        if ( !current_user_can( 'activate_plugins' ) )
            return;

        // Is there any request data?
        $plugin = isset( $_REQUEST['plugin'] ) ? $_REQUEST['plugin'] : '';

        // Check if the nonce was valid
        check_admin_referer( "deactivate-plugin_{$plugin}" );

        // We'll, technically the plugin isn't included when deactivated so...
        // Do nothing

    }

    public function load_plugin_textdomain()
    {

        $domain = $this->plugin_slug;
        $locale = apply_filters( 'plugin_locale', get_locale(), $domain );

        load_textdomain( $domain,
                         trailingslashit( WP_LANG_DIR ) . $domain . '/' . $domain . '-' . $locale . '.mo' );
        load_plugin_textdomain( $domain, FALSE,
                                basename( plugin_dir_path( dirname( __FILE__ ) ) ) . '/languages/' );

    }

    public function activate_message( $translated_text, $untranslated_text,
                                      $domain )
    {
        $old = "Plugin <strong>activated</strong>.";
        $new = FRIENDLY_NAME . " was  <strong>successfully activated</strong> ";

        if ( $untranslated_text === $old )
            $translated_text = $new;

        return $translated_text;

    }

    public function finalization_message( $translated_text, $untranslated_text,
                                          $domain )
    {
        $old = "Plugin <strong>activated</strong>.";
        $new = "Captain, The Core is stable and PluginName was <strong>successfully installed</strong> and ready for Warp speed";

        if ( $untranslated_text === $old )
            $translated_text = $new;

        return $translated_text;

    }

}

Bibliografia:

bramka_inżynier
źródło
Opis nagród informuje: „Proszę podać informacje o najlepszych praktykach . Używanie singletonów z prywatnymi konstruktorami i szereg działań w nich: zła praktyka i trudne do przetestowania, ale nie twoja wina.
gmazzap
1
użyj ../../options.php po przetestowaniu kodu.
ravi patel
Czy możesz pokazać get_plugin_slug ().
vancoder
@vancoder Zredagowałem powyższy post z odpowiednimi informacjami ...
gate_engineer
Dlaczego w twoich wywołaniach odkażających występują odwrotne ukośniki? Nie sądzę, żeby to działało.
Bjorn,

Odpowiedzi:

21

Błąd „Błąd: nie znaleziono strony opcji”

Jest to znany problem w interfejsie API ustawień WP. Było bilet otwarty lat temu i został oznaczony jako rozwiązany - ale powtarzał błędów w najnowszej wersji WordPressa. Oto, co powiedziała (teraz usunięta) strona Kodeksu :

„Błąd: nie znaleziono strony opcji”. problem (w tym rozwiązanie i wyjaśnienie):

Problem polega na tym, że filtr „whitelist_options” nie ma właściwego indeksu dla twoich danych. Zostaje zastosowany w options.php # 98 (WP 3.4).

register_settings()dodaje twoje dane do globalnego $new_whitelist_options. Ten następnie pobiera połączone z globalnym $whitelist_optionswewnątrz option_update_filter()(odp. add_option_whitelist()) Callback (s). Te wywołania zwrotne dodają twoje dane do globalnego $new_whitelist_optionsza pomocą $option_groupindeksu as. Gdy pojawia się komunikat „Błąd: nie znaleziono strony opcji”. oznacza to, że Twój indeks nie został rozpoznany. Mylącą rzeczą jest to, że pierwszy argument jest używany jako indeks i nazywany $options_group, gdy następuje faktyczne wpisanie opcji options.php # 112 $options_page, co jest tym $hook_suffix, z którego otrzymujesz wartość @ return add_submenu_page().

Krótko mówiąc, łatwym rozwiązaniem jest $option_groupdopasowanie $option_name. Inną przyczyną tego błędu jest niepoprawna wartość $pageparametru podczas wywoływania albo add_settings_section( $id, $title, $callback, $page )albo add_settings_field( $id, $title, $callback, $page, $section, $args ).

Wskazówka: $pagepowinien pasować $menu_slugze strony Odwołanie do funkcji / dodaj stronę motywu.

Prosta poprawka

Użycie niestandardowej nazwy strony (w Twoim przypadku $this->plugin_slug:) jako identyfikatora sekcji obejdzie problem. Jednak wszystkie opcje musiałyby być zawarte w jednej sekcji.

Rozwiązanie

Aby uzyskać bardziej niezawodne rozwiązanie, wprowadź następujące zmiany w swojej Plugin_Name_Adminklasie:

Dodaj do konstruktora:

// Tracks new sections for whitelist_custom_options_page()
$this->page_sections = array();
// Must run after wp's `option_update_filter()`, so priority > 10
add_action( 'whitelist_options', array( $this, 'whitelist_custom_options_page' ),11 );

Dodaj te metody:

// White-lists options on custom pages.
// Workaround for second issue: http://j.mp/Pk3UCF
public function whitelist_custom_options_page( $whitelist_options ){
    // Custom options are mapped by section id; Re-map by page slug.
    foreach($this->page_sections as $page => $sections ){
        $whitelist_options[$page] = array();
        foreach( $sections as $section )
            if( !empty( $whitelist_options[$section] ) )
                foreach( $whitelist_options[$section] as $option )
                    $whitelist_options[$page][] = $option;
            }
    return $whitelist_options;
}

// Wrapper for wp's `add_settings_section()` that tracks custom sections
private function add_settings_section( $id, $title, $cb, $page ){
    add_settings_section( $id, $title, $cb, $page );
    if( $id != $page ){
        if( !isset($this->page_sections[$page]))
            $this->page_sections[$page] = array();
        $this->page_sections[$page][$id] = $id;
    }
}

I zmiana add_settings_section()wzywa do: $this->add_settings_section().


Inne uwagi na temat twojego kodu

  • Twój kod formularza jest poprawny. Twój formularz musi zostać przesłany do options.php, jak wskazał mi @Chris_O i jak wskazano w dokumentacji interfejsu API ustawień WP .
  • Przestrzeń nazw ma swoje zalety, ale może komplikować debugowanie i obniża kompatybilność twojego kodu (wymaga PHP> = 5.3, innych wtyczek / motywów, które używają autoloaderów itp.). Więc jeśli nie ma dobrego powodu, aby przestrzeń nazw pliku, nie rób tego. Już unikasz konfliktów nazw, zawijając swój kod w klasie. Sprecyzuj nazwy swoich klas i przenieś swoje validate()wywołania zwrotne do klasy jako metody publiczne.
  • Porównując cytowaną wtyczkę z twoim kodem, wygląda na to, że twój kod jest oparty na rozwidleniu lub starej wersji płyty. Nawet nazwy plików i ścieżki są różne. Możesz migrować wtyczkę do najnowszej wersji, ale pamiętaj, że ta podstawa wtyczki może nie być odpowiednia dla twoich potrzeb. Wykorzystuje singletony, które są ogólnie odradzane . Są przypadki, w których wzorzec singletonu jest rozsądny , ale powinna to być świadoma decyzja, a nie rozwiązanie goto.
Stephen M. Harris
źródło
1
Miło wiedzieć, że w interfejsie API jest błąd. Zawsze próbuję przejrzeć kod, który piszę, w poszukiwaniu błędów, które mogę wprowadzić. Oczywiście zakłada to, że wiem coś lub dwa.
gate_engineer
Dla każdego, kto natknie się na ten problem: spójrz na przykład OOP w kodeksie: codex.wordpress.org/Creating_Options_Pages#Example_.232
22:34
5

Właśnie znalazłem ten post, szukając tego samego problemu. Rozwiązanie jest znacznie prostsze niż się wydaje, ponieważ dokumentacja wprowadza w błąd: w register_setting () pierwszym argumentem o nazwie $option_groupjest twoja strona, a nie sekcja, w której chcesz wyświetlić ustawienie.

W powyższym kodzie powinieneś użyć

    // Update Settings
    add_settings_section(
        'maintenance', // section slug
        'Maintenance', // section title
        array( $this, 'maintenance_section' ), // section display callback
        $this->plugin_slug // page slug
    );

    // Check Updates Option
    register_setting( 
        $this->plugin_slug, // page slug, not the section slug
        'plugin-name_check_updates', // setting slug
        'wp_plugin_name\validate_bool' // invalid, should be an array of options, see doc for more info
    );

    add_settings_field(
        'plugin-name_check_updates', // setting slug
        'Should ' . $this->friendly_name . ' Check For Updates?', // setting title
        array( $this, 'check_updates_field' ), //setting display callback
        $this->plugin_slug, // page slug
        'maintenance' // section slug
    );
86Dev
źródło
To nie jest poprawne. Proszę zobaczyć ten działający przykład (nie mój) - gist.github.com/annalinneajohansson/5290405
Xdg
2

Podczas rejestracji strony opcji z:

add_submenu_page( string $parent_slug, string $page_title, string $menu_title, string $capability, string $menu_slug, callable $function = '' )

I rejestrowanie ustawień za pomocą

register_setting( string $option_group, string $option_name );

$option_group powinien być taki sam jak $menu_slug

Cafer Elgin
źródło
1

Miałem ten sam błąd, ale dostałem go w inny sposób:

// no actual code
// this failed
add_settings_field('id','title', /*callback*/ function($arguments) {
    // echo $htmlcode; 
    register_setting('option_group', 'option_name');
}), 'page', 'section');

Nie wiem, dlaczego tak się stało, ale wydaje się, że register_settingnie powinno to być oddzwanianiemadd_settings_field

// no actual code
// this worked
add_settings_field('id','title', /*callback*/ function($arguments) {echo $htmlcode;}), 'page', 'section');
register_setting('option_group', 'option_name');

mam nadzieję, że to pomoże

Nowy 1
źródło
0

Od kilku dni też mam do czynienia z tym problemem, ten błąd przestał występować, gdy dodałem w komentarzach wiersz:

// settings_fields($this->plugin_slug);

potem przekierowuję na options.php, ale nie mogę jeszcze rozwiązać problemu setting_fields.

G.Karles
źródło
Naprawiłem to z funkcji sprawdzania poprawności !! ;)
G.Karles