2017 © Pedro Peláez
 

library wp-admin-settings-page

A class for creating WordPress administration pages.

image

wp-orbit/wp-admin-settings-page

A class for creating WordPress administration pages.

  • Sunday, September 3, 2017
  • by zawntech
  • Repository
  • 1 Watchers
  • 0 Stars
  • 0 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

wp-admin-settings-page

An extensible class for quickly creating WordPress administration screens., (*1)

Installation

composer require wp-orbit/wp-admin-settings-page

Usage

Create an AbstractSettingsPage class extension., (*2)

 null,

            /* If set, this page is added as a submenu page.
               If not set, this page is added as a top level menu item.
               Example: 'tools.php' for Tools or 'options-general.php' for Settings. */
            'parent_slug' => '',

            /* Sets the menu and page titles. */
            'page_name'   => 'Example Settings Page',

            /* A URL friendly unique slug for this menu page. */
            'page_slug'   => 'example-settings-page',

            /* A URL to image file or WP Dashicon string.
               If not set the default icon will display.
               https://developer.wordpress.org/resource/dashicons/ */
            'icon'        => '',

            /* An array of [tab_key => tab_label] key value pairs.
               These generate our tabs, define our rendering functions, and POST save callbacks.
               Each key needs a corresponding render function (with the same name) in this class.
               Note - make sure not to override any parent class functions (or just prefix your keys).
               Each value represents the tab label. */
            'tabs'        => [
                'options' => 'Options',
            ]
        ];

        // Initialize parent functionality.
        parent::__construct( $args );
    }

    /* Each render function is automatically wrapped in a
tag. Nonce token validation is performed automatically in the save callback, so render functions only need to print our form elements relevant per tab. */ public function options() { // Get options. $my_option = get_option( 'my_option', 'Default value' ); ?> <!-- Print form elements HTML for this. --> <p> <label>Input Option</label> <input name="my_option" value="<?php echo $my_option; ?>"> </p> <!-- No form submit button is printed by default, so we need to include one. --> <p> <button class="button button-primary"> Save </button> </p> <?php } /* When a form is submitted save() is called. Nonce token validation occurs automatically before save() fires. */ public function save() { // At minimum we need to check for our form fields in $_POST. if ( isset( $_POST['my_option'] ) ) { // Sanitize user input when necessary. $clean = sanitize_text_field( $_POST['my_option'] ); // Update the option. update_option( 'my_option', $clean ); } // Or we can isolate tab updates with a switch case. switch ( $this->get_active_tab() ) { // Case key is the tab key. case 'options': // Perform $_POST updates. break; } } }

Include the class in your theme or plugin, then instantiate the class to register the settings page into WordPress., (*3)

<?php
new ExampleSettingsPage;

Hooks

The settings page is pluggable., (*4)

Filters: - wp_admin_settings_page_args_{$class_name} ($args), (*5)

Actions: - wp_admin_settings_page_after_tab_html ($class, $tab) - wp_admin_settings_page_before_tab_html ($class, $tab) - wp_admin_settings_page_save_settings ($class_name, $instance), (*6)

<?php
$class_name = ExampleSettingsPage::class;

// Filter the constructor arguments.
add_filter( "wp_admin_settings_page_args_{$class_name}", function( $args ) {
    return $args;
});

// Do something before inner tab content. 
add_action( 'wp_admin_settings_page_before_tab_html', function( $class, $tab ) {
    if ( 'options' === $tab && ExampleSettingsPage::class === $class ) {    
    }
}, 10, 2 );

// Do something after inner tab content.
add_action( 'wp_admin_settings_page_after_tab_html', function( $class, $tab ) {
    if ( 'options' === $tab && ExampleSettingsPage::class === $class ) {
    }
}, 10, 2 ); 

// Hook into the save callback.
add_action( 'wp_admin_settings_page_save_settings', function( $class, $instance ) {
    if ( ExampleSettingsPage::class === $class ) {
        /** @var $instance ExampleSettingsPage */
        $tab = $instance->get_active_tab();
        // Do something.
    }
}, 10, 2);

The Versions

03/09 2017

dev-master

9999999-dev

A class for creating WordPress administration pages.

  Sources   Download

by Marty Eason