patilswapnilv / shortcodely

shortcodely-admin-form-html.php

Doc Comments +3 added lines

@@ -71,6 +71,9 @@
              return $links;
         }
 
+        /**
+         * @param string $title
+         */
         public function admin_heading( $title ) 
         {
              echo '<div class="wrap" >

Indentation +147 added lines, -147 removed lines

@@ -44,20 +44,20 @@ 
         public $accesslvl        = 'manage_options';
         public function __construct() 
         {
-             add_action('admin_menu', array( &$this, 'register_settings_page' ));
-             add_filter('plugin_action_links', array( &$this, 'add_action_link' ), 10, 2);
+                add_action('admin_menu', array( &$this, 'register_settings_page' ));
+                add_filter('plugin_action_links', array( &$this, 'add_action_link' ), 10, 2);
         }
         public function register_settings_page() 
         {
-             add_options_page($this->longname, $this->shortname, $this->accesslvl, $this->hook, array( &$this, 'config_page' ));
+                add_options_page($this->longname, $this->shortname, $this->accesslvl, $this->hook, array( &$this, 'config_page' ));
         }
         public function plugin_options_url() 
         {
-             return admin_url('options-general.php?page=' . $this->hook);
+                return admin_url('options-general.php?page=' . $this->hook);
         }
         /**
-                 * Add a link to the settings page to the plugins list
-                 */
+         * Add a link to the settings page to the plugins list
+         */
         public function add_action_link( $links, $file ) 
         {
             static $this_plugin;
@@ -68,12 +68,12 @@ 
                 $settings_link = '<a href="' . $this->plugin_options_url() . '">' . __('Settings', 'shortcodely-shortcode-any-widget') . '</a>';
                 array_unshift($links, $settings_link);
             }
-             return $links;
+                return $links;
         }
 
         public function admin_heading( $title ) 
         {
-             echo '<div class="wrap" >
+                echo '<div class="wrap" >
 			<div id="icon-options-general" class="icon32"><br />
 			</div>
 			<h2>' . $title . ' </h2>';
@@ -81,153 +81,153 @@ 
 
         public function admin_subheading( $title ) 
         {
-             echo '<h2>' . $title . '</h2>';
+                echo '<h2>' . $title . '</h2>';
         }
         public function config_page() 
         {
-             $this->admin_heading($this->longname);
-             echo '<h3>More detailed instructions at the wordpress plugin <a target="_new" href="http://wordpress.org/plugins/shortcodely/installation">installation and faq pages.</a></h3>';
-             echo '<ol>';
-             echo '<li>';
-             _e('Test your widget in a normal sidebar first.', 'shortcodely-shortcode-any-widget');
-             echo ' <a title="Go to widget area" href="' . get_admin_url('', 'widgets.php') . '">';
-             _e('Go to widgets', 'shortcodely-shortcode-any-widget');
-             echo '</a>';
-             echo '<li>';
-             _e('Drag the widgets you want to use to the shortcodes sidebar.', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '<li>';
-             _e('Add a do_widget or do_widget_area shortcode to a page.', 'shortcodely-shortcode-any-widget');
-             echo ' <a title="Create a page" href="'
-             . get_admin_url('', 'post-new.php?post_type=page&content=&#91;do_widget Archives &#93;')
-             . '">';
-             _e('Create a page with example do_widget shortcode', 'shortcodely-shortcode-any-widget');
-             echo '</a>';
-             echo '</li>';
-             echo '</ol>';
-
-             echo '<h2>';
-             _e('To add a single widget to a page', 'shortcodely-shortcode-any-widget');
-             echo '</h2>';
-             echo '<ul>';
-             echo '<li>';
-             _e('Add the shortcode [do_widget widgetname] to a page:', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '<li>';
-             echo '<li>';
-             echo '[do_widget categories] or [do_widget name=categories] ';
-             echo '</li>';
-             echo '<li>';
-             _e('[do_widget "tag cloud"] or [do_widget id=widgetid]', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '<li>';
-             echo 'To see a list of your widgets in their sidebars, add <b>?do_widget_debug</b> to the url of page with the do_widget shortcode.';
-             echo '</li>';
-             echo '</ul>';
-
-             echo '<br />';
-             echo '<h2>';
-             _e('More advanced options:', 'shortcodely-shortcode-any-widget');
-             echo '</h2>';
-             echo '<ul><li>';
-             echo 'Use title=false to hide a widget title. ';
-             echo '</li>';
-             echo '<li>';
-             echo '[do_widget pages title=false]	will hide the widget title';
-             echo '</li></ul>';
-             echo '<h3>';
-             _e('To change the style, change the html:', 'shortcodely-shortcode-any-widget');
-             echo '</h3>';
-             echo '<ul>';
-
-             echo '<li>';
-             echo 'Use title=somehtmltag and wrap=somehtmltag	to change the html used.	This may change how your theme\'s css affects the widget when it is in	page.	It all depends what what html selectors your theme uses.';
-             echo '</li>';
-             echo '<li>';
-             echo ' Use class=yourclassname to add a class - maybe to override your themes widget styling?	Obviously you must have css that applies to that class.';
-             echo '</li>';
-
-             echo '<li>';
-             echo '[do_widget pages title=h3]	give the title a heading 3 html tag.';
-             echo '</li>';
-             echo '<li>';
-             echo '[do_widget "tag cloud" wrap=aside]	 will wrap the widget in an "aside" html tag.';
-             echo '</li>';
-
-             echo '</ul>';
-
-             echo '<h4>';
-             echo 'Valid title html tags are : </h4><ul>';
-             echo '<li>h1</li>';
-             echo '<li>h2</li>';
-             echo '<li>h3</li>';
-             echo '<li>h4</li>';
-             echo '<li>h5</li>';
-             echo '<li>header</li>';
-             echo '<li>strong</li>';
-             echo '<li>em</li>';
-             echo '</ul>';
-
-             echo '<h4>Valid html wrap tags are :</h4><ul>';
-             echo '<li>div</li>';
-             echo '<li>p</li>';
-             echo '<li>aside</li>';
-             echo '<li>section</li>';
-             echo '</ul>';
-
-             echo '<h2>';
-             _e('To add multiple instances of the same widget:', 'shortcodely-shortcode-any-widget');
-
-             echo '</h2>';
-             echo '<ul>';
-             echo '<li>';
-             echo '[do_widget id=widgetid1] [do_widget id=widgetid2]';
-             echo '</li>';
-             echo '</ul>';
-
-             echo '<h2>';
-             _e('To add a widget area - all widgets in the widget area:', 'shortcodely-shortcode-any-widget');
-
-             echo '</h2>';
-             echo '<ul>';
-             echo '<li>';
-             echo '<a title="Create a page" href="'
-             . get_admin_url('', 'post-new.php?post_type=page&content=&#91;do_widget_area&#93;')
-             . '"> ';
-             _e('Create a page with do_widget_area shortcode', 'shortcodely-shortcode-any-widget');
-             echo '</a> Hoping to use theme styling.';
-             echo '</li>';
-             echo '<li>';
-             echo '<a title="Create a page" href="'
-             . get_admin_url(
-                 '',
-                 'post-new.php?post_type=page&content=&#91;do_widget_area widget_area_class=none&#93;'
-             )
-             . '"> ';
-             _e('Create a page with do_widget_area shortcode	without the widget_area class', 'shortcodely-shortcode-any-widget');
-             echo '</a> Hoping to avoid theme sidebar styling.';
-             echo '</li>';
-             echo '<li>';
-             _e('Examples:', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '<li>';
-             _e('[do_widget_area] or [do_widget_area widget_area=sidebar-1]', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '<li>';
-             _e('NB: Using something like the twenty-fourteen theme? you might end up with white text on a white background.	Tweak the widget classes or the html of the wrap or title. If that fails, adjust your css.', 'shortcodely-shortcode-any-widget');
-             echo '</li>';
-             echo '</ul>';
-             echo '<br />';
+                $this->admin_heading($this->longname);
+                echo '<h3>More detailed instructions at the wordpress plugin <a target="_new" href="http://wordpress.org/plugins/shortcodely/installation">installation and faq pages.</a></h3>';
+                echo '<ol>';
+                echo '<li>';
+                _e('Test your widget in a normal sidebar first.', 'shortcodely-shortcode-any-widget');
+                echo ' <a title="Go to widget area" href="' . get_admin_url('', 'widgets.php') . '">';
+                _e('Go to widgets', 'shortcodely-shortcode-any-widget');
+                echo '</a>';
+                echo '<li>';
+                _e('Drag the widgets you want to use to the shortcodes sidebar.', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '<li>';
+                _e('Add a do_widget or do_widget_area shortcode to a page.', 'shortcodely-shortcode-any-widget');
+                echo ' <a title="Create a page" href="'
+                . get_admin_url('', 'post-new.php?post_type=page&content=&#91;do_widget Archives &#93;')
+                . '">';
+                _e('Create a page with example do_widget shortcode', 'shortcodely-shortcode-any-widget');
+                echo '</a>';
+                echo '</li>';
+                echo '</ol>';
+
+                echo '<h2>';
+                _e('To add a single widget to a page', 'shortcodely-shortcode-any-widget');
+                echo '</h2>';
+                echo '<ul>';
+                echo '<li>';
+                _e('Add the shortcode [do_widget widgetname] to a page:', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '<li>';
+                echo '<li>';
+                echo '[do_widget categories] or [do_widget name=categories] ';
+                echo '</li>';
+                echo '<li>';
+                _e('[do_widget "tag cloud"] or [do_widget id=widgetid]', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '<li>';
+                echo 'To see a list of your widgets in their sidebars, add <b>?do_widget_debug</b> to the url of page with the do_widget shortcode.';
+                echo '</li>';
+                echo '</ul>';
+
+                echo '<br />';
+                echo '<h2>';
+                _e('More advanced options:', 'shortcodely-shortcode-any-widget');
+                echo '</h2>';
+                echo '<ul><li>';
+                echo 'Use title=false to hide a widget title. ';
+                echo '</li>';
+                echo '<li>';
+                echo '[do_widget pages title=false]	will hide the widget title';
+                echo '</li></ul>';
+                echo '<h3>';
+                _e('To change the style, change the html:', 'shortcodely-shortcode-any-widget');
+                echo '</h3>';
+                echo '<ul>';
+
+                echo '<li>';
+                echo 'Use title=somehtmltag and wrap=somehtmltag	to change the html used.	This may change how your theme\'s css affects the widget when it is in	page.	It all depends what what html selectors your theme uses.';
+                echo '</li>';
+                echo '<li>';
+                echo ' Use class=yourclassname to add a class - maybe to override your themes widget styling?	Obviously you must have css that applies to that class.';
+                echo '</li>';
+
+                echo '<li>';
+                echo '[do_widget pages title=h3]	give the title a heading 3 html tag.';
+                echo '</li>';
+                echo '<li>';
+                echo '[do_widget "tag cloud" wrap=aside]	 will wrap the widget in an "aside" html tag.';
+                echo '</li>';
+
+                echo '</ul>';
+
+                echo '<h4>';
+                echo 'Valid title html tags are : </h4><ul>';
+                echo '<li>h1</li>';
+                echo '<li>h2</li>';
+                echo '<li>h3</li>';
+                echo '<li>h4</li>';
+                echo '<li>h5</li>';
+                echo '<li>header</li>';
+                echo '<li>strong</li>';
+                echo '<li>em</li>';
+                echo '</ul>';
+
+                echo '<h4>Valid html wrap tags are :</h4><ul>';
+                echo '<li>div</li>';
+                echo '<li>p</li>';
+                echo '<li>aside</li>';
+                echo '<li>section</li>';
+                echo '</ul>';
+
+                echo '<h2>';
+                _e('To add multiple instances of the same widget:', 'shortcodely-shortcode-any-widget');
+
+                echo '</h2>';
+                echo '<ul>';
+                echo '<li>';
+                echo '[do_widget id=widgetid1] [do_widget id=widgetid2]';
+                echo '</li>';
+                echo '</ul>';
+
+                echo '<h2>';
+                _e('To add a widget area - all widgets in the widget area:', 'shortcodely-shortcode-any-widget');
+
+                echo '</h2>';
+                echo '<ul>';
+                echo '<li>';
+                echo '<a title="Create a page" href="'
+                . get_admin_url('', 'post-new.php?post_type=page&content=&#91;do_widget_area&#93;')
+                . '"> ';
+                _e('Create a page with do_widget_area shortcode', 'shortcodely-shortcode-any-widget');
+                echo '</a> Hoping to use theme styling.';
+                echo '</li>';
+                echo '<li>';
+                echo '<a title="Create a page" href="'
+                . get_admin_url(
+                    '',
+                    'post-new.php?post_type=page&content=&#91;do_widget_area widget_area_class=none&#93;'
+                )
+                . '"> ';
+                _e('Create a page with do_widget_area shortcode	without the widget_area class', 'shortcodely-shortcode-any-widget');
+                echo '</a> Hoping to avoid theme sidebar styling.';
+                echo '</li>';
+                echo '<li>';
+                _e('Examples:', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '<li>';
+                _e('[do_widget_area] or [do_widget_area widget_area=sidebar-1]', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '<li>';
+                _e('NB: Using something like the twenty-fourteen theme? you might end up with white text on a white background.	Tweak the widget classes or the html of the wrap or title. If that fails, adjust your css.', 'shortcodely-shortcode-any-widget');
+                echo '</li>';
+                echo '</ul>';
+                echo '<br />';
         }
 
 
         /**
-                 * Info box with link to the support forums.
-                 */
+         * Info box with link to the support forums.
+         */
         public function plugin_support() 
         {
-             $content = '<p>' . __('If you have any problems with this plugin or good ideas for improvements or new features, please talk about them in the', 'shortcodely-shortcode-any-widget') . ' <a href="http://wordpress.org/tags/' . $this->hook . '">' . __('Support forums', 'shortcodely-shortcode-any-widget') . '</a>.</p>';
-             $this->postbox($this->hook . 'support', 'Need support?', $content);
+                $content = '<p>' . __('If you have any problems with this plugin or good ideas for improvements or new features, please talk about them in the', 'shortcodely-shortcode-any-widget') . ' <a href="http://wordpress.org/tags/' . $this->hook . '">' . __('Support forums', 'shortcodely-shortcode-any-widget') . '</a>.</p>';
+                $this->postbox($this->hook . 'support', 'Need support?', $content);
         }
 
         public function text_limit( $text, $limit, $finish = ' [&hellip;]' ) 
@@ -237,7 +237,7 @@ 
                 $text = substr($text, 0, - (strlen(strrchr($text, ' '))));
                 $text .= $finish;
             }
-             return $text;
+                return $text;
         }
     }
 }

Spacing +15 added lines, -15 removed lines

@@ -7,7 +7,7 @@ 
  */
 
 // ------------------------------------------------------------------------------------------------------------------
-if (! class_exists('Shortcodely_Saw_Plugin_Admin') ) {
+if ( ! class_exists('Shortcodely_Saw_Plugin_Admin')) {
     /*
     * Shortcodely_Saw_Plugin_Admin Class Doc Comment
     *
@@ -21,10 +21,10 @@ 
     class Shortcodely_Saw_Plugin_Admin
     {
 
-        public $hook                = 'shortcodely_saw';
+        public $hook = 'shortcodely_saw';
         public $filename        = 'shortcodely_shortcode_any_widget/shortcodely_shortcode_any_widget.php';
         public $longname        = 'Shortcode any widget - insert widgets or widget areas into a page.';
-        public $shortname        = 'Shortcode any widget';
+        public $shortname = 'Shortcode any widget';
         public $optionname = '';
         /**
          * Homepage variable Doc Comment
@@ -39,17 +39,17 @@ 
          * This is a "Docblock Comment," also known as a "docblock."    The class'
          * docblock, below, contains a complete description of how to write these.
          */
-        public $homepage        = '';
+        public $homepage = '';
         public $parent_slug = 'plugin_listings_menu';
-        public $accesslvl        = 'manage_options';
+        public $accesslvl = 'manage_options';
         public function __construct() 
         {
-             add_action('admin_menu', array( &$this, 'register_settings_page' ));
-             add_filter('plugin_action_links', array( &$this, 'add_action_link' ), 10, 2);
+             add_action('admin_menu', array(&$this, 'register_settings_page'));
+             add_filter('plugin_action_links', array(&$this, 'add_action_link'), 10, 2);
         }
         public function register_settings_page() 
         {
-             add_options_page($this->longname, $this->shortname, $this->accesslvl, $this->hook, array( &$this, 'config_page' ));
+             add_options_page($this->longname, $this->shortname, $this->accesslvl, $this->hook, array(&$this, 'config_page'));
         }
         public function plugin_options_url() 
         {
@@ -58,20 +58,20 @@ 
         /**
                  * Add a link to the settings page to the plugins list
                  */
-        public function add_action_link( $links, $file ) 
+        public function add_action_link($links, $file) 
         {
             static $this_plugin;
-            if (empty($this_plugin) ) {
+            if (empty($this_plugin)) {
                 $this_plugin = $this->filename;
             }
-            if ($file == $this_plugin ) {
+            if ($file == $this_plugin) {
                 $settings_link = '<a href="' . $this->plugin_options_url() . '">' . __('Settings', 'shortcodely-shortcode-any-widget') . '</a>';
                 array_unshift($links, $settings_link);
             }
              return $links;
         }
 
-        public function admin_heading( $title ) 
+        public function admin_heading($title) 
         {
              echo '<div class="wrap" >
 			<div id="icon-options-general" class="icon32"><br />
@@ -79,7 +79,7 @@ 
 			<h2>' . $title . ' </h2>';
         }
 
-        public function admin_subheading( $title ) 
+        public function admin_subheading($title) 
         {
              echo '<h2>' . $title . '</h2>';
         }
@@ -230,9 +230,9 @@ 
              $this->postbox($this->hook . 'support', 'Need support?', $content);
         }
 
-        public function text_limit( $text, $limit, $finish = ' [&hellip;]' ) 
+        public function text_limit($text, $limit, $finish = ' [&hellip;]') 
         {
-            if (strlen($text) > $limit ) {
+            if (strlen($text) > $limit) {
                 $text = substr($text, 0, $limit);
                 $text = substr($text, 0, - (strlen(strrchr($text, ' '))));
                 $text .= $finish;

shortcodely-utilities.php

Doc Comments +3 added lines

@@ -116,6 +116,9 @@
     }
 }
 /*-----------------------------------*/
+/**
+ * @param string $type
+ */
 function shortcodely_show_widget_debug( $type, $name, $id, $sidebar ) 
 {
     global $wp_registered_sidebars, $wp_registered_widgets, $_wp_sidebars_widgets, $debugcount;

Indentation +1 added lines, -1 removed lines

@@ -130,7 +130,7 @@
         }
     } elseif (($type == 'which one') and ($debug) ) {
         $text = '<p>Debug help is on: Is your widget in the widgets_for_shortcodes sidebar?</p>'
-         . $text;
+            . $text;
     }
 
     return $text;

Spacing +27 added lines, -27 removed lines

@@ -11,12 +11,12 @@ 
     global $_wp_sidebars_widgets;
 
     $sidebars_widgets = $_wp_sidebars_widgets;
-    ksort($sidebars_widgets);  // push inactive down the bottom of the list
+    ksort($sidebars_widgets); // push inactive down the bottom of the list
     $text = '<ul>';
-    foreach ( $sidebars_widgets as $sidebarid => $sidebar ) {
-        if (is_array($sidebar) ) {
+    foreach ($sidebars_widgets as $sidebarid => $sidebar) {
+        if (is_array($sidebar)) {
             $text .= '<li><em>[do_widget_area ' . $sidebarid . ']</em><ul>';
-            foreach ( $sidebar as $i => $w ) {
+            foreach ($sidebar as $i => $w) {
                 $text .= '<li>';
                 $text .= '[do_widget id="' . $w . '"]';
                 $text .= '</li>';
@@ -30,16 +30,16 @@ 
 }
 
 /*-----------------------------------*/
-function shortcodely_get_widgets_sidebar( $wid ) 
+function shortcodely_get_widgets_sidebar($wid) 
 {
     /* walk through the registered sidebars with a name and find the id - will be something like sidebar-integer.
     take the first one that matches */
     global $_wp_sidebars_widgets;
 
-    foreach ( $_wp_sidebars_widgets as $sidebarid => $sidebar ) {
-        if (is_array($sidebar) ) { // ignore the 'array version' sidebarid that isnt actually a sidebar
-            foreach ( $sidebar as $i => $w ) {
-                if ($w == $wid ) {
+    foreach ($_wp_sidebars_widgets as $sidebarid => $sidebar) {
+        if (is_array($sidebar)) { // ignore the 'array version' sidebarid that isnt actually a sidebar
+            foreach ($sidebar as $i => $w) {
+                if ($w == $wid) {
                     return    $sidebarid;
                 }
             }
@@ -49,14 +49,14 @@ 
     return false; // widget id not in any sidebar
 }
 /*-----------------------------------*/
-function shortcodely_get_sidebar_id( $name ) 
+function shortcodely_get_sidebar_id($name) 
 {
     /* walk through the registered sidebars with a name and find the id - will be something like sidebar-integer.
     take the first one that matches */
     global $wp_registered_sidebars;
 
-    foreach ( $wp_registered_sidebars as $i => $a ) {
-        if ((isset($a['name'])) and ($a['name'] === $name) ) {
+    foreach ($wp_registered_sidebars as $i => $a) {
+        if ((isset($a['name'])) and ($a['name'] === $name)) {
             return $i;
         }
     }
@@ -64,14 +64,14 @@ 
     return false;
 }
 /*-----------------------------------*/
-function shortcodely_get_sidebar_name( $id ) 
+function shortcodely_get_sidebar_name($id) 
 {
     /* dont need anymore ? or at least temporarily */
     /* walk through the registered sidebars with a name and find the id - will be something like sidebar-integer.  take the first one */
     global $wp_registered_sidebars;
-    foreach ( $wp_registered_sidebars as $i => $a ) {
-        if ((isset($a['id'])) and ($a['id'] === $id) ) {
-            if (isset($a['name']) ) {
+    foreach ($wp_registered_sidebars as $i => $a) {
+        if ((isset($a['id'])) and ($a['id'] === $id)) {
+            if (isset($a['name'])) {
                 return $a['name'];
             } else {
                 return $id;
@@ -87,16 +87,16 @@ 
     global $said;
     // only do these debug if we are logged in and are the administrator
 
-    if (is_admin() ) {
+    if (is_admin()) {
         return false;
     }   // if running in backend, then do not do debug.  20151217
 
-    if (( ! is_user_logged_in()) or ( ! current_user_can('administrator')) ) {
+    if (( ! is_user_logged_in()) or ( ! current_user_can('administrator'))) {
         return false;
     }
 
-    if (isset($_REQUEST['do_widget_debug']) ) {
-        if (empty($said) ) {
+    if (isset($_REQUEST['do_widget_debug'])) {
+        if (empty($said)) {
             $said = true;
         } else {
             return true;
@@ -116,7 +116,7 @@ 
     }
 }
 /*-----------------------------------*/
-function shortcodely_show_widget_debug( $type, $name, $id, $sidebar ) 
+function shortcodely_show_widget_debug($type, $name, $id, $sidebar) 
 {
     global $wp_registered_sidebars, $wp_registered_widgets, $_wp_sidebars_widgets, $debugcount;
     // only do these debug if we are logged in and are the administrator
@@ -124,11 +124,11 @@ 
     $debug = shortcodely_check_if_widget_debug();
     $text = Shortcodely_show_shortcode_widget_possibilities();
 
-    if ($type == 'empty' ) {
-        if (current_user_can('administrator') ) {
+    if ($type == 'empty') {
+        if (current_user_can('administrator')) {
             $text = '<p>Problem with do_widget shortcode?  Try one of the following:</p>' . $text;
         }
-    } elseif (($type == 'which one') and ($debug) ) {
+    } elseif (($type == 'which one') and ($debug)) {
         $text = '<p>Debug help is on: Is your widget in the widgets_for_shortcodes sidebar?</p>'
          . $text;
     }
@@ -140,7 +140,7 @@ 
 {
     // when switching a theme, save the widgets we use for the shortcodes as they are getting overwritten
     $sidebars_widgets = wp_get_sidebars_widgets();
-    if (! empty($sidebars_widgets['widgets_for_shortcodes']) ) {
+    if ( ! empty($sidebars_widgets['widgets_for_shortcodes'])) {
         update_option('sidebars_widgets_for_shortcodes_saved', $sidebars_widgets['widgets_for_shortcodes']);
     } else {  // our shortcodes sidebar is empty  but when to fix ?
     }
@@ -152,7 +152,7 @@ 
     global $_wp_sidebars_widgets;
 
     $sidebars_widgets = wp_get_sidebars_widgets();
-    if (empty($sidebars_widgets['widgets_for_shortcodes']) ) {
+    if (empty($sidebars_widgets['widgets_for_shortcodes'])) {
         $sidebars_widgets['widgets_for_shortcodes'] = get_option('sidebars_widgets_for_shortcodes_saved');
         update_option('sidebars_widgets', $sidebars_widgets);
     }
@@ -162,7 +162,7 @@ 
 {
     // added in 2014 February for compatibility.. keep for how long. till no sites running older versions.?
     $sidebars_widgets = wp_get_sidebars_widgets();
-    if (! empty($sidebars_widgets['Shortcodes']) and empty($sidebars_widgets['widgets_for_shortcodes']) ) {  // we need to upgrade
+    if ( ! empty($sidebars_widgets['Shortcodes']) and empty($sidebars_widgets['widgets_for_shortcodes'])) {  // we need to upgrade
         $sidebars_widgets['widgets_for_shortcodes'] = $sidebars_widgets['Shortcodes'];
         unset($sidebars_widgets['Shortcodes']);
         update_option('sidebars_widgets', $sidebars_widgets);

shortcodely.php

Doc Comments +3 added lines

@@ -48,6 +48,9 @@
     }
 }
 
+/**
+ * @return callable
+ */
 function shortcodely_remove_widget_class( $params ) 
 {
     /* 

Indentation +9 added lines, -9 removed lines

@@ -55,12 +55,12 @@ 
     */
     if (! empty($params[0]['before_widget']) ) {
         $params[0]['before_widget'] =
-          str_replace('"widget ', '"', $params[0]['before_widget']);
+            str_replace('"widget ', '"', $params[0]['before_widget']);
     }
 
     if (! empty($params[0]['before_title']) ) {
         $params[0]['before_title']
-          = $params[0]['before_title'] = str_replace('widget-title', '', $params[0]['before_title']);
+            = $params[0]['before_title'] = str_replace('widget-title', '', $params[0]['before_title']);
     }
 
     return $params;
@@ -188,8 +188,8 @@ 
 
             return $output;
         }
-          // if we have id, get the sidebar for it
-          $sidebarid = shortcodely_get_widgets_sidebar($id);
+            // if we have id, get the sidebar for it
+            $sidebarid = shortcodely_get_widgets_sidebar($id);
         if (! $sidebarid ) {
             $output = '<br />Widget not in any sidebars<br />';
 
@@ -393,11 +393,11 @@ 
         );
 
         if (! empty($wp_registered_sidebars) ) {    // we got some sidebars already.
-               $main_sidebar = reset($wp_registered_sidebars);    // Grab the first sidebar and use that as defaults for the widgets
-               $args['before_widget'] = $main_sidebar['before_widget'];
-               $args['after_widget'] = $main_sidebar['after_widget'];
-               $args['before_title'] = $main_sidebar['before_title'];
-               $args['after_title'] = $main_sidebar['after_title'];
+                $main_sidebar = reset($wp_registered_sidebars);    // Grab the first sidebar and use that as defaults for the widgets
+                $args['before_widget'] = $main_sidebar['before_widget'];
+                $args['after_widget'] = $main_sidebar['after_widget'];
+                $args['before_title'] = $main_sidebar['before_title'];
+                $args['after_title'] = $main_sidebar['after_title'];
         }
 
         register_sidebar($args);

Spacing +78 added lines, -78 removed lines

@@ -34,31 +34,31 @@ 
 */
 
 add_action('in_widget_form', 'Shortcodely_spice_get_widget_id');
-function Shortcodely_spice_get_widget_id( $widget_instance ) 
+function Shortcodely_spice_get_widget_id($widget_instance) 
 {
     /*
          * Main function to get widget id
          * 
          */
     echo '<p><strong>To use as shortcode with id:</strong> ';
-    if ($widget_instance->number == '__i__' ) {
+    if ($widget_instance->number == '__i__') {
         echo 'Save the widget first!</p>';
     } else {
         echo '[do_widget id=' . $widget_instance->id . ']</p>';
     }
 }
 
-function shortcodely_remove_widget_class( $params ) 
+function shortcodely_remove_widget_class($params) 
 {
     /* 
     * Remove the widget classes
     */
-    if (! empty($params[0]['before_widget']) ) {
+    if ( ! empty($params[0]['before_widget'])) {
         $params[0]['before_widget'] =
           str_replace('"widget ', '"', $params[0]['before_widget']);
     }
 
-    if (! empty($params[0]['before_title']) ) {
+    if ( ! empty($params[0]['before_title'])) {
         $params[0]['before_title']
           = $params[0]['before_title'] = str_replace('widget-title', '', $params[0]['before_title']);
     }
@@ -66,7 +66,7 @@ 
     return $params;
 }
 /*-----------------------------------*/
-function shortcodely_do_widget_area( $atts ) 
+function shortcodely_do_widget_area($atts) 
 {
     global $wp_registered_widgets, $_wp_sidebars_widgets, $wp_registered_sidebars;
 
@@ -75,42 +75,42 @@ 
             array(
                         'widget_area' => 'widgets_for_shortcodes',
                         'class' => 'shortcodely-widget-area', /* the widget class is picked up automatically.	If we want to add an additional class at the wrap level to try to match a theme, use this */
-                        'widget_area_class' => '',    /* option to disassociate from themes widget styling use =none*/
-                        'widget_classes' => '',    /* option to disassociate from themes widget styling */
+                        'widget_area_class' => '', /* option to disassociate from themes widget styling use =none*/
+                        'widget_classes' => '', /* option to disassociate from themes widget styling */
 
                         ), $atts
         )
     );
 
-    if (! empty($atts) ) {
-        if (($widget_area == 'widgets_for_shortcodes') and ! empty($atts[0]) ) {
+    if ( ! empty($atts)) {
+        if (($widget_area == 'widgets_for_shortcodes') and ! empty($atts[0])) {
             $widget_area = $atts[0];
         }
     }
 
-    if (empty($wp_registered_sidebars[ $widget_area ]) ) {
+    if (empty($wp_registered_sidebars[$widget_area])) {
         echo '<br/>Widget area "' . $widget_area . '" not found. Registered widget areas (sidebars) are: <br/>';
-        foreach ( $wp_registered_sidebars as $area => $sidebar ) {
+        foreach ($wp_registered_sidebars as $area => $sidebar) {
             echo $area . '<br />';
         }
     }
     //if (isset($_REQUEST['do_widget_debug']) and current_user_can('administrator')) var_dump( $wp_registered_sidebars); /**/
 
-    if ($widget_area_class == 'none' ) {
+    if ($widget_area_class == 'none') {
         $class = '';
     } else {
-        if (! empty($widget_area_class) ) {    //2014 08
+        if ( ! empty($widget_area_class)) {    //2014 08
             $class .= 'class="' . $class . ' ' . $widget_area_class . '"';
         } else {
             $class = 'class="' . $class . '"';
         }
     }
 
-    if (! empty($widget_classes) and ($widget_classes == 'none') ) {
+    if ( ! empty($widget_classes) and ($widget_classes == 'none')) {
         add_filter('dynamic_sidebar_params', 'shortcodely_remove_widget_class');
     }
 
-    ob_start();    /* catch the echo output, so we can control where it appears in the text	*/
+    ob_start(); /* catch the echo output, so we can control where it appears in the text	*/
     dynamic_sidebar($widget_area);
     $output = ob_get_clean();
     remove_filter('dynamic_sidebar_params', 'shortcodely_remove_widget_class');
@@ -122,14 +122,14 @@ 
     return $output;
 }
 /*-----------------------------------*/
-function shortcodely_do_widget( $atts ) 
+function shortcodely_do_widget($atts) 
 {
     global $wp_registered_widgets, $_wp_sidebars_widgets, $wp_registered_sidebars;
 
     /* check if the widget is in	the shortcode x sidebar	if not , just use generic,
     if it is in, then get the instance	data and use that */
 
-    if (is_admin() ) {
+    if (is_admin()) {
         return '';
     }    // eg in case someone decides to apply content filters when apost is saved, and not all widget stuff is there.
 
@@ -139,16 +139,16 @@ 
                         'sidebar' => 'Widgets for Shortcodes', //default
                         'id' => '',
                         'name' => '',
-                        'title' => '',     /* do the default title unless they ask us not to - use string here not boolean */
+                        'title' => '', /* do the default title unless they ask us not to - use string here not boolean */
                         'class' => 'shortcodely_widget', /* the widget class is picked up automatically.	If we want to add an additional class at the wrap level to try to match a theme, use this */
                         'wrap' => '', /* wrap the whole thing - title plus widget in a div - maybe the themes use a div, maybe not, maybe we want that styling, maybe not */
-                        'widget_classes' => '',    /* option to disassociate from themes widget styling */
+                        'widget_classes' => '', /* option to disassociate from themes widget styling */
                         ), $atts
         )
     );
 
-    if (isset($_wp_sidebars_widgets) ) {
-        shortcodely_show_widget_debug('which one', $name, $id, $sidebar);    //check for debug prompt and show widgets in shortcode sidebar if requested and logged in etc
+    if (isset($_wp_sidebars_widgets)) {
+        shortcodely_show_widget_debug('which one', $name, $id, $sidebar); //check for debug prompt and show widgets in shortcode sidebar if requested and logged in etc
     } else {
         $output = '<br />No widgets defined at all in any sidebar!';
 
@@ -156,29 +156,29 @@ 
     }
 
     /* compatibility check - if the name is not entered, then the first parameter is the name */
-    if (empty($name) and ! empty($atts[0]) ) {
+    if (empty($name) and ! empty($atts[0])) {
         $name = $atts[0];
     }
 
     /* the widget need not be specified, [do_widget widgetname] is adequate */
-    if (! empty($name) ) {    // we have a name
+    if ( ! empty($name)) {    // we have a name
         $widget = $name;
 
-        foreach ( $wp_registered_widgets as $i => $w ) { /* get the official internal name or id that the widget was registered with	*/
-            if (strtolower($w['name']) === strtolower($widget) ) {
+        foreach ($wp_registered_widgets as $i => $w) { /* get the official internal name or id that the widget was registered with	*/
+            if (strtolower($w['name']) === strtolower($widget)) {
                 $widget_ids[] = $i;
             }
             //if ($debug) {echo '<br /> Check: '.$w['name'];}
         }
 
-        if (! ($sidebarid = shortcodely_get_sidebar_id($sidebar)) ) {
-            $sidebarid = $sidebar;     /* get the official sidebar id for this widget area - will take the first one */
+        if ( ! ($sidebarid = shortcodely_get_sidebar_id($sidebar))) {
+            $sidebarid = $sidebar; /* get the official sidebar id for this widget area - will take the first one */
         }
     } else { /* check for id if we do not have a name */
 
-        if (! empty($id) ) {        /* if a specific id has been specified */
-            foreach ( $wp_registered_widgets as $i => $w ) { /* get the official internal name or id that the widget was registered with	*/
-                if ($w['id'] === $id ) {
+        if ( ! empty($id)) {        /* if a specific id has been specified */
+            foreach ($wp_registered_widgets as $i => $w) { /* get the official internal name or id that the widget was registered with	*/
+                if ($w['id'] === $id) {
                     $widget_ids[] = $id;
                 }
             }
@@ -190,46 +190,46 @@ 
         }
           // if we have id, get the sidebar for it
           $sidebarid = shortcodely_get_widgets_sidebar($id);
-        if (! $sidebarid ) {
+        if ( ! $sidebarid) {
             $output = '<br />Widget not in any sidebars<br />';
 
             return $output;
         }
     }
 
-    if (empty($widget) ) {
+    if (empty($widget)) {
         $widget = '';
     }
-    if (empty($id) ) {
+    if (empty($id)) {
         $id = '';
     }
 
-    if (empty($widget_ids) ) {
+    if (empty($widget_ids)) {
         $output = '<br />Error: Your Requested widget "' . $widget . ' ' . $id . '" is not in the widget list.<br />';
         $output .= shortcodely_show_widget_debug('empty', $name, $id, $sidebar);
 
         return $output;
     }
 
-    if (empty($widget) ) {
+    if (empty($widget)) {
         $widget = '';
     }
 
     //$content = '';
     /* if the widget is in our chosen sidebar, then use the options stored for that */
 
-    if (( ! isset($_wp_sidebars_widgets[ $sidebarid ])) or (empty($_wp_sidebars_widgets[ $sidebarid ])) ) { // try upgrade
+    if (( ! isset($_wp_sidebars_widgets[$sidebarid])) or (empty($_wp_sidebars_widgets[$sidebarid]))) { // try upgrade
         shortcodely_upgrade_sidebar();
     }
 
     //if we have a specific sidebar selected, use that
-    if ((isset($_wp_sidebars_widgets[ $sidebarid ])) and ( ! empty($_wp_sidebars_widgets[ $sidebarid ])) ) {
+    if ((isset($_wp_sidebars_widgets[$sidebarid])) and ( ! empty($_wp_sidebars_widgets[$sidebarid]))) {
         /* get the intersect of the 2 widget setups so we just get the widget we want	*/
 
-        $wid = array_intersect($_wp_sidebars_widgets[ $sidebarid ], $widget_ids);
+        $wid = array_intersect($_wp_sidebars_widgets[$sidebarid], $widget_ids);
     } else { /* the sidebar is not defined or selected - should not happen */
-        if (isset($debug) ) {    // only do this in debug mode
-            if (! isset($_wp_sidebars_widgets[ $sidebarid ]) ) {
+        if (isset($debug)) {    // only do this in debug mode
+            if ( ! isset($_wp_sidebars_widgets[$sidebarid])) {
                 $output = '<p>Error: Sidebar "' . $sidebar . '" with sidebarid "' . $sidebarid . '" is not defined.</p>';
             } // shouldnt happen - maybe someone running content filters on save
             else {
@@ -239,7 +239,7 @@ 
     }
 
     $output = '';
-    if (empty($wid) or ( ! is_array($wid)) or (count($wid) < 1) ) {
+    if (empty($wid) or ( ! is_array($wid)) or (count($wid) < 1)) {
         $output = '<p>Error: Your requested Widget "' . $widget . '" is not in the "' . $sidebar . '" sidebar</p>';
         $output .= shortcodely_show_widget_debug('empty', $name, $id, $sidebar);
 
@@ -248,8 +248,8 @@ 
     } else {
         /*	There may only be one but if we have two in our chosen widget then it will do both */
         $output = '';
-        foreach ( $wid as $i => $widget_instance ) {
-            ob_start();    /* catch the echo output, so we can control where it appears in the text	*/
+        foreach ($wid as $i => $widget_instance) {
+            ob_start(); /* catch the echo output, so we can control where it appears in the text	*/
             shortcodely_shortcode_sidebar($widget_instance, $sidebar, $title, $class, $wrap, $widget_classes);
             $output .= ob_get_clean();
         }
@@ -258,7 +258,7 @@ 
     return $output;
 }
 /* -------------------------------------------------------------------------*/
-function shortcodely_shortcode_sidebar( $widget_id,
+function shortcodely_shortcode_sidebar($widget_id,
     $name = 'widgets_for_shortcode',
     $title = true,
     $class = '',
@@ -274,13 +274,13 @@ 
 
     $sidebars_widgets = wp_get_sidebars_widgets();
 
-    $sidebar = $wp_registered_sidebars[ $sidebarid ];    // has the params etc
+    $sidebar = $wp_registered_sidebars[$sidebarid]; // has the params etc
 
     $did_one = false;
 
     /* lifted from wordpress code, keep as similar as possible for now */
 
-    if (! isset($wp_registered_widgets[ $widget_id ]) ) {
+    if ( ! isset($wp_registered_widgets[$widget_id])) {
         return;
     } // wp had c o n t i n u e
 
@@ -290,25 +290,25 @@ 
                                     $sidebar,
                                     array(
                                     'widget_id' => $widget_id,
-                                        'widget_name' => $wp_registered_widgets[ $widget_id ]['name'],
+                                        'widget_name' => $wp_registered_widgets[$widget_id]['name'],
                                     )
                                 ),
                     ),
-                    (array) $wp_registered_widgets[ $widget_id ]['params']
+                    (array) $wp_registered_widgets[$widget_id]['params']
                 );
 
-    $validtitletags = array( 'h1', 'h2', 'h3', 'h4', 'h5', 'header', 'strong', 'em' );
-    $validwraptags = array( 'div', 'p', 'main', 'aside', 'section' );
+    $validtitletags = array('h1', 'h2', 'h3', 'h4', 'h5', 'header', 'strong', 'em');
+    $validwraptags = array('div', 'p', 'main', 'aside', 'section');
 
-    if (! empty($wrap) ) { /* then folks want to 'wrap' with their own html tag, or wrap = yes	*/
-        if (( ! in_array($wrap, $validwraptags)) ) {
+    if ( ! empty($wrap)) { /* then folks want to 'wrap' with their own html tag, or wrap = yes	*/
+        if (( ! in_array($wrap, $validwraptags))) {
             $wrap = '';
         }
         /* To match a variety of themes, allow for a variety of html tags. */
         /* May not need if our sidebar match attempt has worked */
     }
 
-    if (! empty($wrap) ) {
+    if ( ! empty($wrap)) {
         $params[0]['before_widget'] = '<' . $wrap . ' id="%1$s" class="%2$s">';
         $params[0]['after_widget'] = '</' . $wrap . '>';
     }
@@ -316,10 +316,10 @@ 
                 // wp code to get classname
                 $classname_ = '';
                 //foreach ( (array) $wp_registered_widgets[$widget_id]['classname'] as $cn ) {
-                        $cn = $wp_registered_widgets[ $widget_id ]['classname'];
-    if (is_string($cn) ) {
+                        $cn = $wp_registered_widgets[$widget_id]['classname'];
+    if (is_string($cn)) {
         $classname_ .= '_' . $cn;
-    } elseif (is_object($cn) ) {
+    } elseif (is_object($cn)) {
         $classname_ .= '_' . get_class($cn);
     }
                 //}
@@ -335,25 +335,25 @@ 
                 // we are picking up the defaults from the	thems sidebar ad they have registered heir sidebar to issue widget classes?
 
                 // Substitute HTML id and class attributes into before_widget
-    if (! empty($params[0]['before_widget']) ) {
+    if ( ! empty($params[0]['before_widget'])) {
         $params[0]['before_widget'] = sprintf($params[0]['before_widget'], $widget_id, $classname_);
     } else {
         $params[0]['before_widget'] = '';
     }
 
-    if (empty($params[0]['before_widget']) ) {
+    if (empty($params[0]['before_widget'])) {
         $params[0]['after_widget'] = '';
     }
 
     $params = apply_filters('dynamic_sidebar_params', $params);
                 // allow, any pne usingmust ensure they apply to the correct sidebars
 
-    if (! empty($title) ) {
-        if ($title == 'false' ) { /* shortcodely switch off the title html, still need to get rid of title separately */
+    if ( ! empty($title)) {
+        if ($title == 'false') { /* shortcodely switch off the title html, still need to get rid of title separately */
             $params[0]['before_title'] = '<span style="display: none">';
             $params[0]['after_title'] = '</span>';
         } else {
-            if (in_array($title, $validtitletags) ) {
+            if (in_array($title, $validtitletags)) {
                 $class = ' class="widget-title" ';
 
                 $params[0]['before_title'] = '<' . $title . ' ' . $class . ' >';
@@ -362,12 +362,12 @@ 
         }
     }
 
-    if (! empty($widget_classes) and ($widget_classes == 'none') ) {
-        $params = shortcodely_remove_widget_class($params);    // also called in widget area shortcode
+    if ( ! empty($widget_classes) and ($widget_classes == 'none')) {
+        $params = shortcodely_remove_widget_class($params); // also called in widget area shortcode
     }
 
-    $callback = $wp_registered_widgets[ $widget_id ]['callback'];
-    if (is_callable($callback) ) {
+    $callback = $wp_registered_widgets[$widget_id]['callback'];
+    if (is_callable($callback)) {
         call_user_func_array($callback, $params);
         $did_one = true;
     }
@@ -381,19 +381,19 @@ 
 
     global $wp_registered_widgets, $_wp_sidebars_widgets, $wp_registered_sidebars;
 
-    if (function_exists('register_sidebar') ) {    // maybe later, get the first main sidebar and copy it's before/after etc
+    if (function_exists('register_sidebar')) {    // maybe later, get the first main sidebar and copy it's before/after etc
         $args = array(
         'name' => 'Widgets for Shortcodes',
-        'id' => 'widgets_for_shortcodes',    // hope to avoid losing widgets
+        'id' => 'widgets_for_shortcodes', // hope to avoid losing widgets
         'description' => __('Sidebar to hold widgets and their settings. These widgets will be used in a shortcode.	This sidebars widgets should be saved with your theme settings now.', 'shortcodely-shortcode-any-widget'),
-        'before_widget' => '<aside' . ' id="%1$s" class="%2$s ">',    // 201402 to match twentyfourteen theme
+        'before_widget' => '<aside' . ' id="%1$s" class="%2$s ">', // 201402 to match twentyfourteen theme
         'after_widget' => '</aside>',
         'before_title' => '<h1 class="widget-title" >', // 201402 maybe dont use widget class - we are in content here not in a widget area but others want the widget styling. ?
         'after_title' => '</h1>',
         );
 
-        if (! empty($wp_registered_sidebars) ) {    // we got some sidebars already.
-               $main_sidebar = reset($wp_registered_sidebars);    // Grab the first sidebar and use that as defaults for the widgets
+        if ( ! empty($wp_registered_sidebars)) {    // we got some sidebars already.
+               $main_sidebar = reset($wp_registered_sidebars); // Grab the first sidebar and use that as defaults for the widgets
                $args['before_widget'] = $main_sidebar['before_widget'];
                $args['after_widget'] = $main_sidebar['after_widget'];
                $args['before_title'] = $main_sidebar['before_title'];
@@ -409,17 +409,17 @@ 
 require 'shortcodely-admin-form-html.php';
 require 'shortcodely-utilities.php';
 
-if (is_admin() ) {
+if (is_admin()) {
     $shortcodely_saw_plugin_admin = new shortcodely_saw_plugin_admin();
 }
 
-add_action('widgets_init',                'shortcodely_reg_sidebar', 98);     // register late so it appears last
+add_action('widgets_init', 'shortcodely_reg_sidebar', 98); // register late so it appears last
 
-add_action('switch_theme',                        'shortcodely_save_shortcodes_sidebar');
-add_action('after_switch_theme',        'shortcodely_restore_shortcodes_sidebar');
+add_action('switch_theme', 'shortcodely_save_shortcodes_sidebar');
+add_action('after_switch_theme', 'shortcodely_restore_shortcodes_sidebar');
 
-add_shortcode('do_widget',                'shortcodely_do_widget');
-add_shortcode('do_widget_area', 'shortcodely_do_widget_area');    // just dump the whole widget area - to get same styling
+add_shortcode('do_widget', 'shortcodely_do_widget');
+add_shortcode('do_widget_area', 'shortcodely_do_widget_area'); // just dump the whole widget area - to get same styling
 
 //require_once(ABSPATH . 'wp-includes/widgets.php');	 // *** do we really need this here?
 function shortcodely_saw_load_text() 
@@ -435,7 +435,7 @@ 
 
 add_filter('plugin_action_links_' . plugin_basename(__FILE__), 'shortcodely_add_action_links');
 
-function shortcodely_add_action_links( $links ) 
+function shortcodely_add_action_links($links) 
 {
     $mylinks[] =
     '<a title="Haven\'t read the instructions? Need your hand held?" href="' . admin_url('options-general.php?page=shortcodely_saw') . '">Settings</a>';