Changeset 706 for sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/widgets.php

Timestamp:

06/17/2014 12:00:42 AM (10 years ago)

Author:

coffee2code

Message:

Handbook plugin: misc fixes and tweaks. Fixes #250

• Fix to set object post_type variable when post_type is 'handbook'
• Fix to use get_post_type() instead of referencing no-long-existing object variable
• Don't append suffix for 'page' post_type (for ToC and widgets)
• Honor before_widget and after_widget config for widget
• More succinct and thorough array typecasting
• Internationalize strings
• Minor spacing and code formatting tweaks

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/widgets.php (modified) (7 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/handbook/inc/widgets.php

@@ -3 +3 @@
 class WPorg_Handbook_Widget extends WP_Widget {
 
-    protected $post_types = 'handbook';
+    protected $post_types = array( 'handbook' );
 
     function __construct() {
-        $this->post_types = apply_filters( 'handbook_post_types', $this->post_types );
-        if ( ! is_array( $this->post_types ) ) {
-            $this->post_types = (array) $this->post_types;
-        }
+        $this->post_types = (array) apply_filters( 'handbook_post_types', $this->post_types );
         $this->post_types = array_map( array( $this, 'append_suffix' ), $this->post_types );
-        parent::__construct( 'handbook', 'Handbook Tools', array( 'classname' => 'widget_wporg_handbook', 'description' => 'Shows watch/unwatch links for handbook pages.' ) );
+        parent::__construct( 'handbook', __( 'Handbook Tools', 'wporg' ), array( 'classname' => 'widget_wporg_handbook', 'description' => __( 'Shows watch/unwatch links for handbook pages.', 'wporg' ) ) );
     }
 
-    function widget() {
+    function widget( $args ) {
         if ( ! is_user_logged_in() )
             return;
@@ -21 +18 @@
         if ( $post->post_type == 'page' || ( in_array( $post->post_type, $this->post_types ) && ! is_post_type_archive( $this->post_types ) ) ) {
             $watchlist = get_post_meta( $post->ID, '_wporg_watchlist', true );
+            if ( isset( $args['before_widget'] ) && $args['before_widget'] ) {
+                echo $args['before_widget'];
+            }
+            echo '<p>';
             if ( $watchlist && in_array( get_current_user_id(), $watchlist ) ) {
-                printf( '<p>You are watching this page. <a href="%s">Unwatch</a></p>',
+                printf( __( 'You are watching this page. <a href="%s">Unwatch</a>', 'wporg' ),
                 wp_nonce_url( admin_url( 'admin-post.php?action=wporg_watchlist&post_id=' . $post->ID ), 'unwatch-' . $post->ID ) );
             } else {
-                printf( '<p><a href="%s">Watch this page</a></p>',
+                printf( __( '<a href="%s">Watch this page</a>', 'wporg' ),
                 wp_nonce_url( admin_url( 'admin-post.php?action=wporg_watchlist&watch=1&post_id=' . $post->ID ), 'watch-' . $post->ID ) );
+            }
+            echo '</p>';
+            if ( isset( $args['after_widget'] ) && $args['after_widget'] ) {
+                echo $args['after_widget'];
             }
         } else {
@@ -35 +40 @@
 
     function append_suffix( $t ) {
-        if ( 'handbook' == $t )
+        if ( in_array( $t, array( 'handbook', 'page' ) ) ) {
             return $t;
+        }
 
         return $t . '-handbook';
@@ -44 +50 @@
 class WPorg_Handbook_Widget_for_Pages extends WPorg_Handbook_Widget {
 
-    protected $post_type = 'page';
+    protected $post_types = array( 'page' );
 
     function __construct() {
-        WP_Widget::__construct( 'handbook_for_pages', 'Handbook Tools (for Pages)', array( 'classname' => 'widget_wporg_handbook', 'description' => 'Shows watch/unwatch links for Pages.' ) );
+        WP_Widget::__construct( 'handbook_for_pages', __( 'Handbook Tools (for Pages)', 'wporg' ), array( 'classname' => 'widget_wporg_handbook', 'description' => __( 'Shows watch/unwatch links for Pages.', 'wporg' ) ) );
     }
 }
@@ -53 +59 @@
 class WPorg_Handbook_Pages_Widget extends WP_Widget_Pages {
 
-    protected $post_types = 'handbook';
+    protected $post_types = array( 'handbook' );
 
     function __construct() {
-        $widget_ops = array('classname' => 'widget_wporg_handbook_pages', 'description' => __( 'Your site&#8217;s Handbook Pages') );
-        WP_Widget::__construct('handbook_pages', __('Handbook Pages'), $widget_ops);
+        $widget_ops = array('classname' => 'widget_wporg_handbook_pages', 'description' => __( 'Your site&#8217;s Handbook Pages', 'wporg' ) );
+        WP_Widget::__construct( 'handbook_pages', __( 'Handbook Pages', 'wporg' ), $widget_ops );
     }
 
@@ -69 +75 @@
         $post = get_post();
 
-        $this->post_types = apply_filters( 'handbook_post_types', $this->post_types );
-        if ( ! is_array( $this->post_types ) ) {
-            $this->post_types = (array) $this->post_types;
-        }
+        $this->post_types = (array) apply_filters( 'handbook_post_types', $this->post_types );
         $this->post_types = array_map( array( $this, 'append_suffix' ), $this->post_types );
 
@@ -82 +85 @@
 
     function append_suffix( $t ) {
-        if ( 'handbook' == $t )
+        if ( in_array( $t, array( 'handbook', 'page' ) ) ) {
             return $t;
+        }
 
         return $t . '-handbook';