"Error: Página de opciones no encontrada" en el envío de la página de configuración para un complemento de OOP

Navega tus respuestas
12

Estoy desarrollando un complemento que utiliza el repositorio Boilerplate de Tom McFarlin como plantilla, que utiliza prácticas de OOP. He estado tratando de averiguar exactamente por qué no puedo enviar correctamente mi configuración. He intentado establecer el atributo de acción en una cadena vacía como se sugiere en otra pregunta por aquí, pero eso no ha ayudado ...

A continuación se muestra la configuración general del código que estoy usando ...

El formulario (/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>

Para el siguiente código, suponga que existen todas las devoluciones de llamada para add_settings_field () y add_settings_section (), excepto para 'option_list_selection'.

La clase de administración de complementos (/ {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
        );
    }
}

Algunas actualizaciones solicitadas:

Cambiando el atributo de acción a: 

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

... simplemente da como resultado un error 404. El siguiente es el extracto de los registros de Apache. Tenga en cuenta que los scripts de WordPress y las colas de CSS predeterminados se eliminan: 

# 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

Tanto el archivo php-errors.log como el archivo debug.log cuando WP_DEBUG es verdadero están vacíos.

La clase de complemento (/{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;

    }

}

Referencias:

pregunta gate_engineer 30.03.2014 - 07:36

3 respuestas

15

Error "Error en la página de opciones"

Este es un problema conocido en la API de configuración de WP. Hubo un un ticket abierto hace años, y se marcó como resuelto, pero el error persiste en las últimas versiones de WordPress. Esto es lo que la página de Codex (ahora eliminado) dijo sobre esto :

  

La "Error: página de opciones no encontrada". problema (incluyendo una solución y   explicación):

     

El problema entonces es que el filtro 'whitelist_options'   no tiene el índice correcto para sus datos. Se aplica en   options.php # 98 (WP 3.4).

     

register_settings() agrega sus datos a la   global $new_whitelist_options . Esto luego se fusiona con el global    $whitelist_options dentro de option_update_filter() (resp.    add_option_whitelist() ) devoluciones de llamada. Esas devoluciones de llamada agregan sus datos al $new_whitelist_options global con el $option_group como índice.   Cuando encuentras "Error: página de opciones no encontrada". significa tu   El índice no ha sido reconocido. Lo engañoso es que lo primero.   el argumento se usa como índice y se denomina $options_group , cuando el control real en options.php # 112 ocurre contra $options_page , que es el $hook_suffix , que se obtiene como @return valor de add_submenu_page() .

     

En resumen, una solución fácil es hacer que $option_group coincida con $option_name . Otra causa de este error es tener un valor no válido para el parámetro $page al llamar a add_settings_section( $id, $title, $callback, $page ) o add_settings_field( $id, $title, $callback, $page, $section, $args ) .

     

Sugerencia: $page debe coincidir con $menu_slug de la Referencia de funciones / agregar página de tema.

Corrección simple

Usar el nombre de página personalizado (en su caso: $this->plugin_slug ) como su ID de sección solucionaría el problema. Sin embargo, todas sus opciones deberían estar incluidas en una sola sección.

Solución

Para una solución más robusta, realice estos cambios en su clase Plugin_Name_Admin :

Agregar al constructor: 

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

Añade estos métodos: 

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

Y cambia las llamadas add_settings_section() a: $this->add_settings_section() .

Otras notas en tu código

  • Su código de formulario es correcto. Su formulario debe enviarse a options.php, como me indicó @Chris_O, y como se indica en la API de configuración de WP documentación .
  • El espacio de nombres tiene sus ventajas, pero puede hacer que su depuración sea más compleja y reduce la compatibilidad de su código (requiere PHP > = 5.3, otros complementos / temas que usan cargadores automáticos, etc.). Por lo tanto, si no hay una buena razón para poner espacio en el nombre de su archivo, no lo haga. Ya estás evitando los conflictos de nombres envolviendo tu código en una clase. Haga que sus nombres de clase sean más específicos y traiga sus devoluciones de llamadas validate() a la clase como métodos públicos.
  • Comparando su citado boilerplate del complemento con su código, parece que su código realmente se basa en una bifurcación o Una versión antigua del repetitivo. Incluso los nombres de archivo y caminos son diferentes. Podría migrar su complemento a la última versión, pero tenga en cuenta que este complemento puede no ser adecuado para sus necesidades. Hace uso de singletons, que generalmente están desaconsejado . Hay casos en los que el patrón de singleton es sensible , pero esto debe ser una decisión consciente, no la solución de goto .
respondido por el Stephen M. Harris 02.04.2014 - 21:45
1

Acabo de encontrar esta publicación mientras buscaba el mismo problema. La solución es mucho más simple de lo que parece porque la documentación es engañosa: en register_setting () el primer argumento llamado $option_group es su barra de página, no la sección en la que desea mostrar la configuración.

En el código anterior debes usar 

    // 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
    );
    
respondido por el 86Dev 27.10.2017 - 01:37
0

Al registrar la página de opciones con: 

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

Y registrando configuraciones con 

register_setting( string $option_group, string $option_name );

$option_group debería ser igual que $menu_slug

    
respondido por el Cafer Elgin 06.10.2018 - 20:49

Lea otras preguntas en las etiquetas

¿Es ACF una trampa de miel? [cerrado] Marcar las publicaciones con fecha futura como publicadas