Changeset 768

Timestamp:

07/29/2014 06:57:54 PM (11 years ago)

Author:

coffee2code

Message:

Code Reference: fix so that approved examples are publicly viewable

• Make examples publicly viewable, if present
• Hook 'comments_open' to only enable submitting examples by site members
• Add hook 'wporg_devhub-can_user_post_example' to allow overriding default post commenting status
• Temporarily disable any non-example commenting
• Rename wporg_developer_comment() to more appropriate wporg_developer_example()
• Remove unnecessary code-example template

Location:

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer

Files:

• code-example.php (deleted)
• comments.php (modified) (3 diffs)
• content-reference.php (modified) (1 diff)
• content-wp-parser-hook.php (modified) (1 diff)
• functions.php (modified) (2 diffs)
• inc/template-tags.php (modified) (2 diffs)

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/comments.php

@@ -40 +40 @@
                  * See wporg_developer_comment() in inc/template-tags.php for more.
                  */
-                wp_list_comments( array( 'callback' => 'wporg_developer_comment' ) );
+                wp_list_comments( array( 'callback' => 'wporg_developer_example' ) );
             ?>
         </ol><!-- .comment-list -->
@@ -53 +53 @@
 
     <?php endif; // have_comments() ?>
+
+    <?php if ( DevHub\can_user_post_example( false, get_the_ID() ) ) : ?>
 
     <p id="add-example" style="display:none;"><a href=""><?php _e( 'Have an example to add?', 'wporg' ); ?></a></p>
@@ -68 +70 @@
     ) ); ?>
 
+    <?php endif; ?>
+
 </div><!-- #comments -->

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php

@@ -141 +141 @@
     <?php endif; ?>
 
-    <?php if ( have_comments() || ( comments_open() && is_user_member_of_blog() ) ) : ?>
+    <?php if ( comments_open() || '0' != get_comments_number() ) : ?>
     <hr/>
     <section class="examples">
         <h2><?php _e( 'Examples', 'wporg' ); ?></h2>
-        <?php get_template_part( 'code-example' ); ?>
+        <?php comments_template(); /* TODO: add '/examples.php' */ ?>
     </section>
     <?php endif; ?>

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-wp-parser-hook.php

@@ -84 +84 @@
         */ ?>
 
-        <?php if ( have_comments() || ( comments_open() && is_user_member_of_blog() ) ) : ?>
+        <?php if ( comments_open() || '0' != get_comments_number() ) : ?>
         <hr/>
         <section class="examples">
             <h2><?php _e( 'Examples', 'wporg' ); ?></h2>
-            <?php get_template_part( 'code-example' ); ?>
+            <?php comments_template(); /* TODO: add '/examples.php' */ ?>
         </section>
         <?php endif; ?>

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php

@@ -57 +57 @@
     add_filter( 'the_excerpt', __NAMESPACE__ . '\\lowercase_P_dangit_just_once' );
     add_filter( 'the_content', __NAMESPACE__ . '\\make_doclink_clickable', 10, 5 );
+    add_filter( 'comments_open', __NAMESPACE__ . '\\can_user_post_example', 10, 2 );
 
     // Temporarily disable comments
@@ -350 +351 @@
     wp_enqueue_script( 'wporg-developer-skip-link-focus-fix', get_template_directory_uri() . '/js/skip-link-focus-fix.js', array(), '20130115', true );
 
-    if ( is_singular() && comments_open() ) {
+    if ( is_singular() && ( '0' != get_comments_number() || post_type_has_source_code() ) ) {
         wp_enqueue_script( 'wporg-developer-function-reference', get_template_directory_uri() . '/js/function-reference.js', array( 'jquery', 'syntaxhighlighter-core', 'syntaxhighlighter-brush-php' ), '20140515', true );
         wp_enqueue_style( 'syntaxhighlighter-core' );

sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php

@@ -73 +73 @@
     endif;
 
-    if ( ! function_exists( 'wporg_developer_comment' ) ) :
+    if ( ! function_exists( 'wporg_developer_example' ) ) :
         /**
-         * Template for comments and pingbacks.
+         * Template for examples.
          *
-         * Used as a callback by wp_list_comments() for displaying the comments.
+         * Used as a callback by wp_list_comments() for displaying the examples.
          */
-        function wporg_developer_comment( $comment, $args, $depth ) {
+        function wporg_developer_example( $comment, $args, $depth ) {
             $GLOBALS['comment'] = $comment;
 
@@ -753 +753 @@
     }
 
+    /**
+     * Indicates if the current user can post an example.
+     *
+     * This only affects post types wp-parser-* as they are the only things
+     * that can have examples.
+     *
+     * A custom check can be performed by hooking the filter
+     * 'wporg_devhub-can_user_post_example' and returning a
+     * value other than null.
+     *
+     * By default, the ability to post examples is restricted to members of the
+     * blog.
+     *
+     * @param  int  $post_id The post ID.
+     *
+     * @return bool True if the user can post an example.
+     */
+    function can_user_post_example( $open, $post_id ) {
+
+        // Only proceed if the post type is one that has examples.
+        if ( 0 !== strpos( get_post_type( (int) $post_id ), 'wp-parser-' ) ) {
+            // Temporarily disable commenting that isn't for an example since various
+            // changes need to take place to enable regular commenting.
+            return false; //$open;
+        }
+
+        // Permit default logic to be overridden via filter that returns value other than null.
+        if ( null !== ( $can = apply_filters( 'wporg_devhub-can_user_post_example', null, $post_id ) ) ) {
+            return $can;
+        }
+
+        // Default to limiting ability to post examples to members of the blog.
+        return is_user_member_of_blog();
+    }
+
 }