WordPress Hooks & APIs

Shortcode API

This project utilizes the WordPress Shortcode API to provide a simple, declarative interface for displaying user data within post content or widget areas.

[user_role]

The primary public interface for this utility is the [user_role] shortcode. This tag is processed server-side and replaced with the role name of the currently logged-in user.

• Attributes: None.
• Returns:
  • string: The slug of the primary user role (e.g., administrator, editor, subscriber).
  • empty string: If the visitor is not logged in or has no assigned role.

Example Usage in Editor:

Hello, your current access level is: [user_role]

Example Usage in PHP Templates:

echo do_shortcode( '[user_role]' );

WordPress User API

The logic relies on the standard WordPress User API to retrieve authenticated session data.

wp_get_current_user()

The implementation calls wp_get_current_user() to fetch the WP_User object for the visitor.

• Public Data Point: The script accesses the roles property of the WP_User object.
• Logic: Because WordPress allows users to have multiple roles, the code typically extracts the first element of the $user->roles array.

| Property | Type | Description | | :--- | :--- | :--- | | $user->roles | array | An array of all roles assigned to the user. | | Output | string | The first string found in the roles array. |

Technical Implementation Details

For developers looking to hook into this or modify the behavior, the core logic is registered via the following WordPress hook:

add_shortcode

Registers the user_role tag during the WordPress initialization sequence.

// Conceptual internal registration
add_shortcode( 'user_role', 'get_current_user_role_function' );

Developer Note: This snippet does not provide sanitization for the output as it returns standard WordPress role slugs. If you are using custom roles with special characters, ensure your CSS or container logic handles those strings appropriately.