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

Timestamp:

09/23/2014 06:30:18 PM (11 years ago)

Author:

coffee2code

Message:

Code Reference: rename 'Examples' to 'User Contributed Notes' in an appropriate fashion wherever present

File:

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

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

@@ -73 +73 @@
     endif;
 
-    if ( ! function_exists( 'wporg_developer_example' ) ) :
+    if ( ! function_exists( 'wporg_developer_user_note' ) ) :
         /**
-         * Template for examples.
+         * Template for user contributed notes.
          *
-         * Used as a callback by wp_list_comments() for displaying the examples.
+         * Used as a callback by wp_list_comments() for displaying the notes.
          */
-        function wporg_developer_example( $comment, $args, $depth ) {
+        function wporg_developer_user_note( $comment, $args, $depth ) {
             $GLOBALS['comment'] = $comment;
 
@@ -130 +130 @@
 
                         <?php if ( '0' == $comment->comment_approved ) : ?>
-                            <p class="comment-awaiting-moderation"><?php _e( 'Your example is awaiting moderation.', 'wporg' ); ?></p>
+                            <p class="comment-awaiting-moderation"><?php _e( 'Your note is awaiting moderation.', 'wporg' ); ?></p>
                         <?php endif; ?>
                     </footer>
@@ -149 +149 @@
             endif;
         }
-    endif; // ends check for wporg_developer_comment()
+    endif; // ends check for wporg_developer_user_note()
 
     if ( ! function_exists( 'wporg_developer_posted_on' ) ) :
@@ -226 +226 @@
 
             <?php if ( $comment->comment_approved == '0' ) : ?>
-                <em class="comment-awaiting-moderation"><?php _e( 'Your example is awaiting moderation.', 'wporg' ); ?></em>
+                <em class="comment-awaiting-moderation"><?php _e( 'Your note is awaiting moderation.', 'wporg' ); ?></em>
                 <br />
             <?php endif; ?>
 
-            <pre class="example-content"><?php echo htmlentities( get_comment_text() ); ?></pre>
+            <pre class="user-note-content"><?php echo htmlentities( get_comment_text() ); ?></pre>
 
             <footer class="comment-meta">
@@ -716 +716 @@
 
     /**
-     * Does the post type support having examples?
+     * Does the post type support having user notes?
      *
      * @param  string  Optional. The post type name. If blank, assumes current post type.
@@ -722 +722 @@
      * @return boolean
      */
-    function post_type_supports_examples( $post_type = null ) {
+    function post_type_supports_user_notes( $post_type = null ) {
         $post_type = $post_type ? $post_type : get_post_type();
 
@@ -812 +812 @@
 
     /**
-     * Indicates if the current user can post an example.
+     * Indicates if the current user can post a user contibuted note.
      *
      * This only affects post types wp-parser-* as they are the only things
-     * that can have examples.
+     * that can have user contributed notes.
      *
      * A custom check can be performed by hooking the filter
-     * 'wporg_devhub-can_user_post_example' and returning a
+     * 'wporg_devhub-can_user_post_note' and returning a
      * value other than null.
      *
-     * By default, the ability to post examples is restricted to members of the
+     * By default, the ability to post notes 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.
+     * @return bool True if the user can post a note.
+     */
+    function can_user_post_note( $open, $post_id ) {
+
+        // Only proceed if the post type is one that has user contributed notes.
         if ( 0 !== strpos( get_post_type( (int) $post_id ), 'wp-parser-' ) ) {
-            // Temporarily disable commenting that isn't for an example since various
+            // Temporarily disable commenting that isn't for a note since various
             // changes need to take place to enable regular commenting.
             return false; //$open;
@@ -838 +838 @@
 
         // 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 ) ) ) {
+        if ( null !== ( $can = apply_filters( 'wporg_devhub-can_user_post_note', null, $post_id ) ) ) {
             return $can;
         }
 
-        // Default to limiting ability to post examples to members of the blog.
+        // Default to limiting ability to post notes to members of the blog.
         return is_user_member_of_blog();
     }