About Liferay Portlet IDs

Every Liferay portlet has a unique fully-qualified class name called the portlet ID. This ID uniquely identifies the portlet application and is used throughout Liferay's architecture for configuration, permissions, embedding, and custom development.

Why Portlet IDs Matter

• Sitemap Configuration: Reference portlets in sitemap.json to control indexing and visibility.
• Permissions Management: Grant or deny portlet access to specific roles using the portlet ID.
• Custom Embedding: Embed portlets on pages or in custom applications using their IDs.
• Theme Configuration: Control portlet appearance and placement in theme layouts.
• REST API: Query and manage portlets programmatically using portlet IDs.
• Custom Development: Reference portlets in custom modules and integrations.

Understanding Portlet ID Structure

Portlet IDs follow the Java package naming convention: com.liferay.{module}_web_portlet_{PortletClassName}

For example: com_liferay_journal_web_portlet_JournalPortlet

• com.liferay — Liferay namespace
• journal — Module name
• web — Application type (web portlet)
• JournalPortlet — Class name

How to Use Portlet IDs

1. Find the ID: Search this table for the portlet you need.
2. Copy it: Click Copy to get the full portlet ID.
3. Use in configuration: Add to sitemap.json, permission rules, or custom code.
4. Verify in your portal: Check the browser URL (p_p_id parameter) or control panel to confirm.

Example: Finding Portlet ID in the Browser

Open the Journal portlet in Liferay, then look at the URL:

The p_p_id parameter contains the portlet ID.

Portlet Categories

This reference organizes portlets by functional category to make searching easier:

• Content Management: Journal, Documents, Blogs, Wiki, etc.
• Administration: Users, Roles, Trash, Control Panel, etc.
• Community: Message Boards, Polls, Mentions, etc.
• Collaboration: Calendar, Mail, Notifications, etc.
• Navigation: Menu, Breadcrumb, etc.
• Content Display: Asset Publisher, IFrame, etc.

Frequently Asked Questions

What is a portlet ID in Liferay?

A portlet ID is the unique fully-qualified class name that identifies a specific Liferay portlet application. Used in sitemap.json, permissions, custom development, and embedding portlets on pages.

Where do I use portlet IDs?

Common uses: sitemap.json configuration, managing portlet permissions, embedding portlets via APIs, custom theme layouts, modifying portal-ext.properties, and third-party integrations.

Is this tool official?

No. This is a community reference tool. The portlet IDs are from Liferay's official documentation and open-source codebase. Always verify in your Liferay instance.

How do I check portlet IDs in my portal?

Navigate to control panel, open any portlet, and check the browser URL — the portlet ID is in the p_p_id parameter. Or check portal.properties and search for portlet references.

Why don't I see a custom portlet in the list?

This reference includes only built-in Liferay core portlets. Custom or third-party portlet IDs are specific to your instance and will be different.