OOPプラグインの設定ページの提出に関する「エラー:オプションページが見つかりません」


19

Tom McFarlinのBoilerplateリポジトリをテンプレートとして使用して、OOPプラクティスを利用するプラグインを開発しています。設定を正しく送信できない理由を正確に把握しようとしています。ここで別の質問で提案されているように、アクション属性を空の文字列に設定しようとしましたが、それは助けにはなりませんでした...

以下は、私が使用している一般的なコード設定です...

フォーム(/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>

以下のコードでは、 'option_list_selection'を除き、add_settings_field()およびadd_settings_section()のすべてのコールバックが存在すると仮定します。

プラグイン管理クラス(/{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

WP_DEBUGがtrueの場合、php-errors.logファイルとdebug.logファイルの両方が空です。

プラグインクラス(/{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;

    }

}

参照:


恵みの説明レポート:「に関するいくつかの情報を提供してくださいベストプラクティスを。プライベートコンストラクターとその中の一連のアクションでシングルトンを使用する:ただし、悪い練習ではなく、テストが難しく、あなたのせいではありません。
gmazzap

1
コードをテストした後、.. / .. / options.phpを使用します。
ラヴィパテル14

get_plugin_slug()を見せてください。
ヴァンコーダー14

私は...関連情報を上記のポストを編集した@vancoder
gate_engineer

register_settingsのサニタイズコールバックにバックスラッシュがあるのはなぜですか?私はそれがうまくいくとは思わない。
ビヨン14

回答:


21

「エラー:オプションページが見つかりません」バグ

これは、WP設定APIの既知の問題です。何年も前に開かれたチケットがあり、解決済みとマークされていましたが、バグはWordPressの最新バージョンに残っています。これは、(現在削除されている)Codexページがこれについて言ったことです:

「エラー:オプションページが見つかりません。」問題(解決策と説明を含む):

問題は、「whitelist_options」フィルターがデータの正しいインデックスを取得していないことです。options.php#98(WP 3.4)に適用されます。

register_settings()グローバルにデータを追加します$new_whitelist_options。これは、グローバルに統合されます $whitelist_options内部option_update_filter()(それぞれ add_option_whitelist())コールバック(S)。これらのコールバック$new_whitelist_optionsは、$option_groupasインデックスを使用してデータをグローバルに追加します。「エラー:オプションページが見つかりません」が発生した場合。インデックスが認識されていないことを意味します。誤解を招くようなことは、最初の引数がインデックスとして使用して命名されていることで$options_group、とき#112が反対起こるoptions.phpの実際のチェック$options_pageで、$hook_suffixあなたがから@return値として取得し、add_submenu_page()

要するに、簡単な解決策は$option_group一致させること$option_nameです。このエラーの別の原因は$pageadd_settings_section( $id, $title, $callback, $page )またはの呼び出し時にパラメーターの値が無効であることですadd_settings_field( $id, $title, $callback, $page, $section, $args )

ヒント:関数リファレンス/テーマの追加ページから$page一致$menu_slugする必要があります。

簡単な修正

$this->plugin_slugセクションIDとしてカスタムページ名(あなたの場合:)を使用すると、問題を回避できます。ただし、すべてのオプションを1つのセクションに含める必要があります。

溶液

より堅牢なソリューションを得るには、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()


コードに関するその他の注意事項

  • フォームコードは正しいです。@Chris_Oが私に指摘したように、そしてWP設定API ドキュメントに示されているように、フォームはoptions.phpに送信する必要があります
  • Namespacingには利点がありますが、デバッグがより複雑になり、コードの互換性が低下します(PHP> = 5.3、オートローダーを使用する他のプラグイン/テーマなどが必要です)。したがって、ファイルの名前空間を作成する正当な理由がない場合は、そうしないでください。コードをクラスにラップすることで、すでに名前の競合を回避しています。クラス名をより具体的にし、validate()コールバックをパブリックメソッドとしてクラスに持ち込みます。
  • 引用したプラグインボイラープレートをコードと比較すると、コードは実際にはフォークまたは古いバージョンのボイラープレートに基づいているようです。ファイル名とパスも異なります。プラグインを最新バージョンに移行することもできますが、このプラグインのボイラープレートはニーズに合わない可能性があることに注意してください。一般的には推奨されないシングルトンを使用ます。シングルトンパターンが賢明な場合もありますが、これはgotoソリューションではなく、意識的な決定である必要があります。

1
apiにバグがあることを知ってうれしいです。私は常に、導入する可能性のあるバグについて記述したコードを調べてみます。もちろん、それは私が1つか2つを知っていることを前提としています。
gate_engineer 14

この問題に出くわした場合:codexのOOPの例をご覧ください
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
    );

これは正しくありません。(ない鉱山)この作業例を参照してください- 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


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

これが役立つことを願っています


0

私も数日この問題に直面してきましたが、次の行にコメントを入れるとこのエラーは止まりました。

// settings_fields($this->plugin_slug);

その後、私はoptions.phpにリダイレクトしてsetting_fieldsいますが、まだ問題を解決できません。


検証機能から修正しました!! ;)
G.Karles
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.