https://github.com/prolific-digital/wp-current-user-avatar
https://github.com/prolific-digital/wp-current-user-avatar
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/prolific-digital/wp-current-user-avatar
- Owner: prolific-digital
- Created: 2025-02-28T21:59:13.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-28T22:07:36.000Z (4 months ago)
- Last Synced: 2025-03-01T00:29:47.710Z (4 months ago)
- Language: PHP
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WP Current User Avatar
A simple WordPress plugin that provides a shortcode to display the current logged-in user's avatar.
Developed by [Prolific Digital](https://prolificdigital.com).
## Description
WP Current User Avatar is a lightweight plugin that lets you display the currently logged-in user's avatar anywhere on your WordPress site using a simple shortcode. This is perfect for member areas, user dashboards, or any personalized sections of your website.
## Features
- Simple shortcode implementation
- Customizable avatar size
- Add custom CSS classes to the avatar
- Custom alt text
- No output if user is not logged in
- Lightweight with minimal overhead
## Usage
Add the shortcode `[current_user_avatar]` to any post or page to display the current user's avatar.
If the user is not logged in, the shortcode will not display anything.
### Shortcode Attributes
The shortcode accepts the following attributes:
* `size`: Avatar size in pixels (default: 96)
* `class`: Additional CSS classes to add to the avatar
* `alt`: Custom alt text for the avatar image (defaults to user's display name)
### Examples
Basic usage:
```
[current_user_avatar]
```
Custom size (128px):
```
[current_user_avatar size="128"]
```
Custom CSS class:
```
[current_user_avatar class="my-custom-class rounded-avatar"]
```
Custom alt text:
```
[current_user_avatar alt="Profile picture"]
```
Combine multiple attributes:
```
[current_user_avatar size="150" class="profile-img" alt="User profile image"]
```
## Installation
1. Upload the `wp-current-user-avatar` folder to the `/wp-content/plugins/` directory
2. Activate the plugin through the 'Plugins' menu in WordPress
3. Use the shortcode `[current_user_avatar]` in your posts, pages, or template files
## For Developers
You can also use the shortcode in your theme files with the WordPress `do_shortcode` function:
```php
```
## Frequently Asked Questions
### What if the user is not logged in?
If the user is not logged in, the shortcode will not display anything.
### Can I use this with Elementor, Beaver Builder, or other page builders?
Yes, this plugin works with any WordPress page builder that supports shortcodes.
### Does this work with custom avatar plugins?
Yes, this plugin uses WordPress's built-in `get_avatar()` function, which is compatible with most avatar plugins like WP User Avatar, Simple Local Avatars, etc.
## Changelog
### 1.0.0
* Initial release
## License
This plugin is licensed under the GPL v2 or later.
## Credits
* Developed by [Prolific Digital](https://prolificdigital.com)
* Built with love for the WordPress community