Changeset 4672 for trunk/includes/users/template-tags.php

Timestamp:

12/31/2012 01:21:33 PM (13 years ago)

Author:

johnjamesjacoby

Message:

Nicename Usage:

• Introduce template tags for getting and displaying a user nicenames. Helpful for themes that want easier access to @mentions data.
• Improve mention filters to use 'slug' instead of 'login.' Fixes possible mismatches when login and nicename are different.

File:

• trunk/includes/users/template-tags.php (modified) (2 diffs)

trunk/includes/users/template-tags.php

@@ -241 +241 @@
 
         return apply_filters( 'bbp_get_user_profile_link', $user_link, $user_id );
+    }
+
+/**
+ * Output a users nicename to the screen
+ *
+ * @since bbPress (r4671)
+ *
+ * @param int $user_id User ID whose nicename to get
+ * @param array $args before|after|user_id|force
+ */
+function bbp_user_nicename( $user_id = 0, $args = array() ) {
+    echo bbp_get_user_nicename( $user_id, $args );
+}
+    /**
+     * Return a users nicename to the screen
+     *
+     * @since bbPress (r4671)
+     *
+     * @param int $user_id User ID whose nicename to get
+     * @param array $args before|after|user_id|force
+     * @return string User nicename, maybe wrapped in before/after strings
+     */
+    function bbp_get_user_nicename( $user_id = 0, $args = array() ) {
+
+        // Bail if no user ID passed
+        $user_id = bbp_get_user_id( $user_id, false, false );
+        if ( empty( $user_id ) )
+            return false;
+
+        // Parse default arguments
+        $r = bbp_parse_args( $args, array(
+            'user_id' => $user_id,
+            'before'  => '',
+            'after'   => '',
+            'force'   => ''
+        ), 'get_user_nicename' );
+
+        // Get the user data and nicename
+        if ( empty( $r['force'] ) ) {
+            $user     = get_userdata( $user_id );
+            $nicename = $user->user_nicename;
+
+        // Force the nicename to something else
+        } else {
+            $nicename = (string) $r['force'];
+        }
+
+        // Maybe wrap the nicename
+        $retval = !empty( $nicename ) ? ( $r['before'] . $nicename . $r['after'] ) : '';
+
+        // Filter and return
+        return (string) apply_filters( 'bbp_get_user_nicename', $retval, $user_id, $args );
     }
 
@@ -290 +342 @@
             // Get username if not passed
             if ( empty( $user_nicename ) ) {
-                $user = get_userdata( $user_id );
-                if ( !empty( $user->user_nicename ) ) {
-                    $user_nicename = $user->user_nicename;
-                }
+                $user_nicename = bbp_get_user_nicename( $user_id );
             }