WPSAC: Added get_wpsac_plugin_option() example; flush cache on submit

Author: dmhendricks

README.md

@@ -88,6 +88,8 @@ Release changes are noted on the [Releases](https://github.com/dmhendricks/wordp
 
 * Fixed non-static deprecation notice
 * Added support for before/after strings to prefix()
+* Added version check for wordpress-toolkit
+* Added get_wpsac_plugin_option() example to Plugin class
 
 ## Credits
 

app/Plugin.php

@@ -188,12 +188,14 @@ private function verify_dependencies( $deps = true, $args = array() ) {
     *   cache flushed appropriately.
     *
     * @param string $key The name of the option key
+    * @param bool $cache Whether or not to attempt to get cached value
     * @return mixed The value of specified Carbon Fields option key
     * @link https://carbonfields.net/docs/containers-usage/ Carbon Fields containers
     * @since 0.2.0
     *
     */
   public static function get_plugin_option( $key, $cache = true ) {
+
     $key = self::prefix( $key );
 
     if( $cache ) {
@@ -208,6 +210,38 @@ public static function get_plugin_option( $key, $cache = true ) {
 
   }
 
+  /**
+    * Get plugin option from WordPress Settings API Class, with object caching
+    *   (if available).
+    *
+    * @param string $key The name of the option key
+    * @param string $group_id The group_id of the settings page, as specified
+    *   in WPSAC_Page class
+    * @param bool $cache Whether or not to attempt to get cached value
+    * @return string The value of specified option key
+    * @link https://github.com/tareq1988/wordpress-settings-api-class WPSAC options
+    * @since 0.3.2
+    *
+    */
+  public static function get_wpsac_plugin_option( $key, $group_id = 'options', $cache = true ) {
+
+    $key = self::prefix( $key );
+    $options = array();
+
+    if( $cache ) {
+      // Attempt to get value from cache, else fetch value from database
+      $options = self::$cache->get_object( $key, function() use ( &$key, &$group_id ) {
+        return get_option( self::prefix( $group_id ) );
+      });
+    } else {
+      // Return uncached value
+      $options = get_option( self::prefix( $group_id ) );
+    }
+
+    return isset( $options[ $key ] ) ? $options[ $key ] : null;
+
+  }
+
   /**
     * A wrapper for the plugin's data fiala prefix as defined in $config
     *

app/Settings/WPSAC_Page.php

@@ -13,12 +13,16 @@
 class WPSAC_Page extends Plugin {
 
   private $settings_api;
+  private $section_id = 'options';
 
   function __construct() {
 
     $this->settings_api = new \WeDevs_Settings_API();
     $this->settings_fields = array();
 
+    // Process saved options on submit
+    if( isset( $_POST['option_page'] ) && $_POST['option_page'] == $this->prefix( $this->section_id ) ) $this->options_container_saved();
+
     // Create a settings page using wordpress-settings-api-class (Settings > Settings API)
     add_action( 'admin_init', array( $this, 'wpsac_admin_init' ) );
     add_action( 'admin_menu', array( $this, 'wpsac_admin_menu' ) );
@@ -31,6 +35,10 @@ function __construct() {
     * @since 0.3.0
     */
   public function wpsac_admin_init() {
+
+    // Flush cache when settings saved
+    if( isset( $_POST['option_page'] ) && $_POST['option_page'] == $this->prefix( $this->section_id ) ) self::$cache->flush();
+
     $this->settings_api->set_sections( $this->get_settings_sections() );
     $this->settings_api->set_fields( $this->get_settings_fields() );
     $this->settings_api->admin_init();
@@ -55,7 +63,7 @@ public function get_settings_sections() {
     $sections = array(
 
       array(
-          'id'    => $this->prefix( 'general' ),
+          'id'    => $this->prefix( $this->section_id ),
           'title' => self::$config->get( 'short_name' ) . ' ' . __( 'Settings', self::$textdomain ) . ' (WPSAC)'
       )
     );
@@ -72,7 +80,7 @@ public function get_settings_sections() {
   public function get_settings_fields() {
 
     $settings_fields = array(
-      $this->prefix( 'general' ) => array(
+      $this->prefix( $this->section_id ) => array(
         array(
           'name'              => $this->prefix( 'blog_name' ),
           'label'             => __( 'Blog Name', self::$textdomain ),
@@ -125,4 +133,17 @@ public function create_wpsac_settings_page() {
 
   }
 
+  /**
+    * When settings saved, run optional code to process. This is not elegant,
+    *   but WPSAC doesn't have an options saved hook.
+    *
+    * @since 0.3.2
+    */
+  private function options_container_saved() {
+
+    // Example - If we wanted to saved the "blog_name" field as an MD5 hash:
+    //$_POST[ $this->prefix( $this->section_id ) ][ $this->prefix( 'blog_name' ) ] = md5( $this->prefix( 'blog_name' ) );
+
+  }
+
 }