MasterPress 1.2.6 is now available
We have released a compatibility update that addresses issues that appear when using MariaDB.
Example: Ways to obtain a WOOF_User
List of Methods
Property Methods
-
description()String
Retrieves the text in the Biographical Info field in the user profile.
-
email()String
Retrieves the email address of the user.
-
first_name()String
Retrieves the first name of the user.
-
full_name()String
Retrieves the full name of the user, by joining the first and last names together.
-
fullname()String
Retrieves the full name of the user, by joining the first and last names together.
-
has_role( String $id )Boolean
Checks if this user has the given role.
-
id()String
Retrieves the database ID for this user.
-
info( String $name = null )Object OR String
Retrieves additional info about the user – either a single property for a given name, or the WP_User object if no name is provided.
-
is( Mixed $id )Boolean
Checks if the user is the same as a given user id.
-
is_a( String $id )Boolean
An alias for the WOOF_User::has_role method, to check if this user has the given role.
-
is_an( String $id )Boolean
An alias for the WOOF_User::has_role method, to check if this user has the given role.
-
is_current()Boolean
Checks if the user is the current logged in user.
-
last_name()String
Retrieves the last name of the user.
-
login()String
Retrieves the login name for the user.
-
name()String
An alias of the WOOF_User::login method to retrieve the login name for the user.
-
nick_name()String
An alias for the method, to retrieves the nick name field for the user, as entered in their profle.
-
nickname()String
Retrieves the nick name field for the user, as entered in their profle.
-
permalink()String
Returns the full URL (including domain and protocol) to the author archive page for this user.
-
registered( String $format = null )String OR Integer
Retrieves the date this user was created in WordPress.
-
title()String
An alias of the WOOF_User::fullname method to retrieve the full name of the user, by joining the first and last names together.
-
url( Boolean $root_relative = false )String
Returns a the URL pointing to the author archive page for this user.
-
user_name()String
An alias of the WOOF_User::login method to retrieve the login user name for this user.
Theming
-
link( Arguments $args = array() )String
Retrieves HTML for a link (anchor) tag pointing to the archive page for this user, using the full name of the user as the link text by default.
-
mailto( Arguments $args = array() )String
Retrieves HTML for a mailto link (anchor) tag for this user, using their email address as the link text.
Posts
-
posts( Arguments $args = array() )WOOF_Collection of MEOW_Post
Retrieve the list of posts that this user is the author of.This method uses get_posts to retrieve the posts, so you can further clarify this query with the args parameter.
-
query_posts( Arguments $args = array() )WOOF_Collection of MEOW_Post
A preset on the WOOF::query_posts method, to retrieve the posts authored by this user, while also affecting the main query loop.
Internal Use
-
fetch_info()
An internal method used to fetch additional info attached to the user – any methods that rely on this will call this first.
-
fetch_wp_user()
An internal method used to fetch additional info attached to the user – any methods that rely on this will call this first.
-
can( String $capability )Boolean
Checks to see if this user can perform the capability provided, via the WordPress function user_can.
-
description()String
Retrieves the text in the Biographical Info field in the user profile.
-
email()String
Retrieves the email address of the user.
-
fetch_info()
An internal method used to fetch additional info attached to the user – any methods that rely on this will call this first.
-
fetch_wp_user()
An internal method used to fetch additional info attached to the user – any methods that rely on this will call this first.
-
first_name()String
Retrieves the first name of the user.
-
full_name()String
Retrieves the full name of the user, by joining the first and last names together.
-
fullname()String
Retrieves the full name of the user, by joining the first and last names together.
-
has_role( String $id )Boolean
Checks if this user has the given role.
-
id()String
Retrieves the database ID for this user.
-
info( String $name = null )Object OR String
Retrieves additional info about the user – either a single property for a given name, or the WP_User object if no name is provided.
-
is( Mixed $id )Boolean
Checks if the user is the same as a given user id.
-
is_a( String $id )Boolean
An alias for the WOOF_User::has_role method, to check if this user has the given role.
-
is_an( String $id )Boolean
An alias for the WOOF_User::has_role method, to check if this user has the given role.
-
is_current()Boolean
Checks if the user is the current logged in user.
-
last_name()String
Retrieves the last name of the user.
-
link( Arguments $args = array() )String
Retrieves HTML for a link (anchor) tag pointing to the archive page for this user, using the full name of the user as the link text by default.
-
login()String
Retrieves the login name for the user.
-
mailto( Arguments $args = array() )String
Retrieves HTML for a mailto link (anchor) tag for this user, using their email address as the link text.
-
name()String
An alias of the WOOF_User::login method to retrieve the login name for the user.
-
nick_name()String
An alias for the method, to retrieves the nick name field for the user, as entered in their profle.
-
nickname()String
Retrieves the nick name field for the user, as entered in their profle.
-
permalink()String
Returns the full URL (including domain and protocol) to the author archive page for this user.
-
posts( Arguments $args = array() )WOOF_Collection of MEOW_Post
Retrieve the list of posts that this user is the author of.This method uses get_posts to retrieve the posts, so you can further clarify this query with the args parameter.
-
query_posts( Arguments $args = array() )WOOF_Collection of MEOW_Post
A preset on the WOOF::query_posts method, to retrieve the posts authored by this user, while also affecting the main query loop.
-
registered( String $format = null )String OR Integer
Retrieves the date this user was created in WordPress.
-
role()WOOF_Role
Retrieves a WOOF_Role object representing the first role that this user is recorded in.
-
roles()WOOF_Collection of WOOF_Role
Retrieves a collection of WOOF_Role objects representing all of the roles that the user is part of.
-
title()String
An alias of the WOOF_User::fullname method to retrieve the full name of the user, by joining the first and last names together.
-
url( Boolean $root_relative = false )String
Returns a the URL pointing to the author archive page for this user.
-
user_name()String
An alias of the WOOF_User::login method to retrieve the login user name for this user.
Base Class Methods
View method list from the base class WOOF_Wrap.