Enum Class WPCacheKey
- All Implemented Interfaces:
Serializable,Comparable<WPCacheKey>,Constable,CacheKeyEnum,FriendlyEnum
Enumeration of possible cache keys for the WordPress REST API cache. It is the default
implementation of the
CacheKeyEnum interface.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionAlternative text.Author ID.Media caption.CSS class list.Comment status.Rendered content.Local date.GMT date.Description text.Excerpt text.Featured media ID.Post format.Global unique identifier.Post ID.Permalink URL.URL slug.Post status.Sticky flag.Post title.Post type. -
Method Summary
Modifier and TypeMethodDescriptionvalue()Returns the value of the enum constant, which is the actual string to be used in the API.static WPCacheKeyReturns the enum constant of this class with the specified name.static WPCacheKey[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
ALT_TEXT
Alternative text. -
AUTHOR
Author ID. -
CAPTION
Media caption. -
CLASS_LIST
CSS class list. -
CONTENT
Rendered content. -
COMMENT_STATUS
Comment status. -
DATE
Local date. -
DATE_GMT
GMT date. -
DESCRIPTION
Description text. -
EXCERPT
Excerpt text. -
FEATURED_MEDIA
Featured media ID. -
FORMAT
Post format. -
GUID
Global unique identifier. -
ID
Post ID. -
LINK
Permalink URL. -
SLUG
URL slug. -
STATUS
Post status. -
STICKY
Sticky flag. -
TITLE
Post title. -
TYPE
Post type.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
value
Description copied from interface:FriendlyEnumReturns the value of the enum constant, which is the actual string to be used in the API.Example: If an enum constant is named
STATUS_PENDING, the value returned by this method would be"pending", which is the value provided in its constructor.- Specified by:
valuein interfaceFriendlyEnum- Returns:
- the value of the enum constant
-