«Ошибка: страница опций не найдена» на странице настроек для плагина ООП

19

Я разрабатываю плагин, используя в качестве шаблона репозиторий Тома Макфарлина Boilerplate , который использует методы ООП. Я пытался выяснить, почему я не могу правильно отправить свои настройки. Я попытался установить для атрибута action пустую строку, как предложено для другого вопроса, но это не помогло ...

Ниже приведена общая настройка кода, которую я использую ...

Форма (/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>

Для следующего кода предположим, что существуют все обратные вызовы для add_settings_field () и add_settings_section (), кроме 'option_list_selection'.

Класс администрирования плагина (/ {plugin_name} -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
        );
    }
}

Некоторые запрашиваемые обновления:

Изменение атрибута действия на:

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

... просто приводит к ошибке 404. Ниже приведен отрывок из журналов Apache. Обратите внимание, что стандартные сценарии WordPress и CSS-очереди удалены:

# 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

И файл php-errors.log, и файл debug.log, когда WP_DEBUG имеет значение true, пусты.

Класс плагинов (/ enjplugin-name Event-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;

    }

}

Ссылки:

gate_engineer
источник
Описание награды сообщает: «Пожалуйста, предоставьте некоторую информацию о лучших практиках » . Использование синглетонов с частными конструкторами и куча действий внутри них: плохая практика и сложная проверка, однако не ваша вина.
gmazzap
1
используйте ../../options.php после тестирования вашего кода.
Рави Патель
Можете ли вы показать get_plugin_slug ().
vancoder
@vancoder Я отредактировал пост выше с соответствующей информацией ...
gate_engineer
Почему в ваших обратных вызовах очистки в параметрах register_settings есть обратные слэши? Я не думаю, что это сработает.
Бьорн

Ответы:

21

Ошибка «Ошибка: страница параметров не найдена»

Это известная проблема в API настроек WP. Был билет, открытый много лет назад, и он был помечен как решенный, но ошибка сохраняется в последних версиях WordPress. Вот что (теперь удаленная) страница Кодекса говорит об этом :

«Ошибка: страница параметров не найдена». проблема (включая решение и объяснение):

Проблема в том, что фильтр 'whitelist_options' не имеет нужного индекса для ваших данных. Он применяется на options.php # 98 (WP 3.4).

register_settings()добавляет ваши данные в глобальный $new_whitelist_options. Затем это объединяется с глобальным $whitelist_optionsвнутри option_update_filter()(соответственно add_option_whitelist()) обратного вызова (ов). Эти обратные вызовы добавить свои данные в глобальный $new_whitelist_optionsс $option_groupкак индекс. При появлении сообщения «Ошибка: страница параметров не найдена». это означает, что ваш индекс не был распознан. Вводит в заблуждение то, что первый аргумент используется в качестве индекса и имени $options_group, когда происходит фактическая проверка в файле options.php # 112 $options_page, то есть значение $hook_suffix, которое вы получаете как значение @return изadd_submenu_page() .

Короче говоря, простое решение - сделать $option_groupматч $option_name. Другая причина этой ошибки , имеющая недопустимое значение $pageпараметра при вызове либо add_settings_section( $id, $title, $callback, $page )илиadd_settings_field( $id, $title, $callback, $page, $section, $args ) .

Подсказка: $pageдолжна совпадать $menu_slugсо ссылкой на функцию / добавить страницу темы.

Простое исправление

Используя пользовательское имя страницы (в вашем случае: $this->plugin_slug качестве идентификатора раздела поможет обойти проблему. Однако все ваши варианты должны содержаться в одном разделе.

Решение

Для более надежного решения внесите эти изменения в свой Plugin_Name_Admin класс:

Добавить в конструктор:

// 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 );

Добавьте эти методы:

// 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;
    }
}

И изменение add_settings_section()вызовов: $this->add_settings_section().


Другие примечания в вашем коде

  • Ваш код формы правильный. Ваша форма должна быть отправлена ​​в options.php, как указано @Chris_O и указано в документации по API настроек WP. .
  • Пространство имен имеет свои преимущества, но оно может усложнить отладку и снизить совместимость вашего кода (требуется PHP> = 5.3, другие плагины / темы, использующие автозагрузчики и т. Д.). Так что, если нет веской причины для пространства имен вашего файла, не надо. Вы уже избегаете конфликтов имен, заключая код в класс. Сделайте имена своих классов более конкретными иvalidate() обратные вызовы в класс как открытые методы.
  • Сравнивая приведенный вами шаблон плагина с вашим кодом, кажется, что ваш код фактически основан на форке или старой версии шаблона. Даже имена файлов и пути разные. Вы можете перенести свой плагин в последнюю версию, но учтите, что этот шаблон плагина может не подойти для ваших нужд. Он использует синглтоны, которые обычно не поощряются . Есть случаи, когда модель синглтона является разумной , но это должно быть сознательное решение, а не готовое решение.
Стивен М. Харрис
источник
1
Приятно знать, что в API есть ошибка. Я всегда делаю попытку просмотреть код, который я пишу, на наличие ошибок, которые я могу представить. Конечно, это предполагает, что я знаю одну или две вещи.
gate_engineer
Для всех, кто сталкивался с этой проблемой: взгляните на пример ООП в кодексе: codex.wordpress.org/Creating_Options_Pages#Example_.232
maysi
5

Я только что нашел этот пост, когда искал ту же проблему. Решение намного проще, чем кажется, потому что документация вводит в заблуждение: в register_setting () первый аргумент с именем$option_group - это слаг вашей страницы, а не раздел, в котором вы хотите отобразить настройку.

В приведенном выше коде вы должны использовать

    // 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
источник
Это не правильно. Пожалуйста, посмотрите этот рабочий пример (не мой) - gist.github.com/annalinneajohansson/5290405
Xdg
2

При регистрации страницы параметров с:

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

И регистрация настроек с

register_setting( string $option_group, string $option_name );

$option_group должно быть так же, как $menu_slug

Cafer Elgin
источник
1

У меня была та же ошибка, но я получил ее по-другому:

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

Я не знаю, почему это произошло, но, похоже, register_settingне должно быть в обратном вызовеadd_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');

надеюсь, это поможет

Новый 1
источник
0

Я тоже столкнулся с этой проблемой уже несколько дней, эта ошибка прекратилась, когда я добавил в комментариях строку:

// settings_fields($this->plugin_slug);

после этого я перенаправляю на страницу options.php, но пока не могу решить проблему setting_fields.

G.Karles
источник
я исправил это из функции проверки !! ;)
Г.Карлес