Working With Page Layouts On SharePoint Using PnP PowerShell

Add the page to the site as page layout

Add-SPOPublishingPageLayout command is used to create page layouts. The page layout should be associated with the content type. In this example, the article page content type is used for association. So we will first retrieve the content type id of article page and associate the content type to our new page layout.

The below code snippet helps in creating a page layout using PnP PowerShell.

The below image shows the created page layout which is listed on the new page creation page.

Retrieve Page Layouts

The page layouts can be retrieved using PnP commands.

• The get list operation (Get-SPOListItem) is used to retrieve the page layouts.
• The necessary parameters for retrieving page layouts are list and query. List attribute will contain the list name and query parameter to filter out only page layouts from the master page gallery.

The following code snippet retrieves all page layouts from the site. The query used to filter only page layout is content type id. The page content type ids of all page layouts will begin with 0x01010007FF3E057FA8AB4AA42FCB67B453FFC1.

The following code snippet retrieves the page layouts associated with article page content type.

The following code snippet retrieves the page layout by name.

The following command retrieves all the properties of page layout.

Delete Page Layout

The delete operation is carried out with delete list item command. To delete a page layout, first retrieve (Get-SPOListItem) the page layout item and then execute Remove-SPOListItem with the item identity.

The following code snippet helps in deleting a page layout.

The page layout can not be deleted when it is already referenced to a page.

The following image shows the error when deleted. The error is because of page layout reference. To get over this issue, you have to delete the referenced pages before executing the above operation.