Changeset 1057

Timestamp:

12/19/2014 09:57:26 PM (10 years ago)

Author:

coffee2code

Message:

developer.wordpress.org: Reintroduce Explanations, with editorial flow.

• Add explanations as an associated post type
• Add metabox to create, unpublish, and link to edit explanation for a parsed post type
• Add template tags: get_explanation() and get_explanation_field()
• Re-enable display of Explanations on the frontend

props DrewAPicture.
fixes #786.

Location:

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

Files:

• content-reference.php (modified) (2 diffs)
• content-wp-parser-hook.php (modified) (2 diffs)
• functions.php (modified) (2 diffs)
• inc/explanations.php (added)
• inc/parsed-content.php (modified) (3 diffs)
• inc/template-tags.php (modified) (1 diff)
• js/explanations.js (added)
• scss/admin.scss (modified) (1 diff)
• stylesheets/admin.css (modified) (1 diff)

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

@@ -46 +46 @@
 
     <?php
-    $explanation = '';
+    $explanation = get_explanation_field( 'post_content', get_the_ID() );
     if ( $explanation ) :
         ?>
@@ -52 +52 @@
         <section class="explanation">
             <h2><?php _e( 'Explanation', 'wporg' ); ?></h2>
-            <?php the_content(); ?>
+            <?php echo apply_filters( 'the_content', apply_filters( 'get_the_content', $explanation ) ); ?>
         </section>
     <?php endif; ?>

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

@@ -44 +44 @@
 
         <?php
-        $explanation = '';
+        $explanation = get_explanation_field( 'post_content', get_the_ID() );
         if ( $explanation ) :
             ?>
@@ -50 +50 @@
             <section class="explanation">
                 <h2><?php _e( 'Explanation', 'wporg' ); ?></h2>
-                <?php the_content(); ?>
+                <?php echo apply_filters( 'the_content', apply_filters( 'get_the_content', $explanation ) ); ?>
             </section>
         <?php endif; ?>

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

@@ -45 +45 @@
  */
 require __DIR__ . '/inc/user-content-voting.php';
+
+/**
+ * Explanations for functions. hooks, classes, and methods.
+ */
+require( __DIR__ . '/inc/explanations.php' );
 
 /**
@@ -80 +85 @@
     add_action( 'pre_get_posts', __NAMESPACE__ . '\\pre_get_posts' );
     add_action( 'wp_enqueue_scripts', __NAMESPACE__ . '\\theme_scripts_styles' );
+
     add_filter( 'post_type_link', __NAMESPACE__ . '\\method_permalink', 10, 2 );
     add_filter( 'term_link', __NAMESPACE__ . '\\taxonomy_permalink', 10, 3 );
     add_filter( 'the_posts', __NAMESPACE__ . '\\rerun_empty_exact_search', 10, 2 );
+
     add_theme_support( 'automatic-feed-links' );
     add_theme_support( 'post-thumbnails' );

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

@@ -70 +70 @@
         $ticket_label = get_post_meta( $post->ID, 'wporg_ticket_title', true );
         $ticket_info  = get_post_meta( $post->ID, 'wporg_parsed_ticket_info', true );
-        $content      = get_post_meta( $post->ID, 'wporg_parsed_content', true );
+        $content      = $post->post_content;
 
         if ( $ticket ) {
@@ -99 +99 @@
                     <div class="wporg_parsed_readonly <?php echo $ticket ? 'hidden' : ''; ?>"><?php echo apply_filters( 'the_content', $content ); ?></div>
                     <div class="wporg_parsed_content <?php echo $ticket ? '' : 'hidden'; ?>">
-                        <?php wp_editor( $content, 'wporg_parsed_content_editor', array(
+                        <?php wp_editor( $content, 'content', array(
                             'media_buttons' => false,
                             'tinymce'       => false,
                             'quicktags'     => true,
                             'textarea_rows' => 10,
-                            'textarea_name' => 'wporg_parsed_content',
+                            'textarea_name' => 'content',
                         ) ); ?>
                     </div>
@@ -164 +164 @@
         // Only enqueue 'wporg-parsed-content' script and styles on Code Reference post type screens.
         if ( in_array( get_current_screen()->id, $this->post_types ) ) {
-            wp_enqueue_style( 'wporg-parsed-content', get_template_directory_uri() . '/stylesheets/admin.css', array(), '20140826' );
+            wp_enqueue_style( 'wporg-admin', get_template_directory_uri() . '/stylesheets/admin.css', array(), '20140826' );
             wp_enqueue_script( 'wporg-parsed-content', get_template_directory_uri() . '/js/parsed-content.js', array( 'jquery', 'utils' ), '20140826', true );
 

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

@@ -1104 +1104 @@
     }
 
+    /**
+     * Retrieve an explanation for the given post.
+     *
+     * @param int|WP_Post $post      Post ID or WP_Post object.
+     * @param bool        $published Optional. Whether to only retrieve the explanation if it's published.
+     *                               Default false.
+     * @return WP_Post|null WP_Post object for the Explanation, null otherwise.
+     */
+    function get_explanation( $post, $published = false ) {
+        if ( ! $post = get_post( $post ) ) {
+            return null;
+        }
+
+        $args = array(
+            'post_type'      => 'wporg_explanations',
+            'post_parent'    => $post->ID,
+            'no_found_rows'  => true,
+            'posts_per_page' => 1,
+        );
+
+        if ( true === $published ) {
+            $args['post_status'] = 'publish';
+        }
+
+        $explanation = get_children( $args, OBJECT );
+
+        if ( empty( $explanation ) ) {
+            return null;
+        }
+
+        $explanation = reset( $explanation );
+
+        if ( ! $explanation ) {
+            return null;
+        }
+        return $explanation;
+    }
+
+    /**
+     * Retrieve data from an explanation post field.
+     *
+     * Works only for published explanations.
+     *
+     * @see get_post_field()
+     *
+     * @param string      $field   Post field name.
+     * @param int|WP_Post $post    Post ID or object for the function, hook, class, or method post
+     *                             to retrieve an explanation field for.
+     * @param string      $context Optional. How to filter the field. Accepts 'raw', 'edit', 'db',
+     *                             or 'display'. Default 'display'.
+     * @return string The value of the post field on success, empty string on failure.
+     */
+    function get_explanation_field( $field, $post, $context = 'display' ) {
+        if ( ! $explanation = get_explanation( $post, $published = true ) ) {
+            return '';
+        }
+        return get_post_field( $field, $explanation, $context );
+    }
 }

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

@@ -21 +21 @@
     display: block;
 }
+
+
+/* Explanations */
+
+.post-type-wporg_explanations .add-new-h2 {
+    display: none;
+}
+
+.expl-row-actions {
+    display: block;
+
+    a {
+        display: inline-block;
+
+        &:first-child {
+            padding-right: 6px;
+            padding-left: 0;
+        }
+        &:nth-child(n+2) {
+            padding-left: 8px;
+            border-left: 1px solid #ccc;
+        }
+    }
+}
+
+.status {
+    font-weight: bold;
+
+    &.pending {
+        color: red;
+    }
+
+    &.publish {
+        color: green;
+    }
+}
+.post-type-wp-parser-function,
+.post-type-wp-parser-class,
+.post-type-wp-parser-method,
+.post-type-wp-parser-hook {
+    .form-table {
+        th {
+            padding-top: 10px;
+            padding-bottom: 10px;
+        }
+        td {
+            padding: 10px;
+
+            p {
+                margin-top: 0;
+            }
+        }
+    }
+}

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

@@ -20 +20 @@
   display: block;
 }
+
+/* Explanations */
+.post-type-wporg_explanations .add-new-h2 {
+  display: none;
+}
+
+.expl-row-actions {
+  display: block;
+}
+.expl-row-actions a {
+  display: inline-block;
+}
+.expl-row-actions a:first-child {
+  padding-right: 6px;
+  padding-left: 0;
+}
+.expl-row-actions a:nth-child(n+2) {
+  padding-left: 8px;
+  border-left: 1px solid #ccc;
+}
+
+.status {
+  font-weight: bold;
+}
+.status.pending {
+  color: red;
+}
+.status.publish {
+  color: green;
+}
+
+.post-type-wp-parser-function .form-table th,
+.post-type-wp-parser-class .form-table th,
+.post-type-wp-parser-method .form-table th,
+.post-type-wp-parser-hook .form-table th {
+  padding-top: 10px;
+  padding-bottom: 10px;
+}
+.post-type-wp-parser-function .form-table td,
+.post-type-wp-parser-class .form-table td,
+.post-type-wp-parser-method .form-table td,
+.post-type-wp-parser-hook .form-table td {
+  padding: 10px;
+}
+.post-type-wp-parser-function .form-table td p,
+.post-type-wp-parser-class .form-table td p,
+.post-type-wp-parser-method .form-table td p,
+.post-type-wp-parser-hook .form-table td p {
+  margin-top: 0;
+}