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

Timestamp:

12/19/2014 09:57:26 PM (11 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.

File:

• sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php (modified) (1 diff)

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 );
+    }
 }