Get-SPPublishingPageLayout

Retrieves all publishing page layouts from the specified source.

Get-SPPublishingPageLayout -Web <SPWebPipeBind> -PageLayout <SPPageLayoutPipeBind[]> [-AssociatedContentType [<SPContentTypePipeBind>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Get-SPPublishingPageLayout -Web <SPWebPipeBind> [-AssociatedContentType [<SPContentTypePipeBind>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

1

ParameterRequiredTypeDescription
WebTrueSPWebPipeBind

Specifies the URL or GUID of the Web to retrieve publishing page layouts from.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

PageLayoutTrueSPPageLayoutPipeBind[]

The name or path to the page layout to return. If the value is the page name only then the Web parameter must be provided.

Example: ArticleLeft.aspx or http://<site>/_catalogs/masterpage/articleleft.aspx.

AssociatedContentTypeFalseSPContentTypePipeBind

The associated content type to filter the returned page layouts by.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

2

ParameterRequiredTypeDescription
WebTrueSPWebPipeBind

Specifies the URL or GUID of the Web to retrieve publishing page layouts from.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of Microsoft SharePoint Foundation 2010 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

AssociatedContentTypeFalseSPContentTypePipeBind

The associated content type to filter the returned page layouts by.

AssignmentCollectionFalseSPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Detailed Description

Retrieves all publishing page layouts from the specified source.

Copyright 2016 Falchion Consulting, LLC

> For more information on this cmdlet and others:

> http://blog.falchionconsulting.com/

> Use of this cmdlet is at your own risk.

> Gary Lapointe assumes no liability.

Examples

------------------EXAMPLE 1-----------------------

PS C:\> $layouts = Get-SPWeb http://server_name | Get-SPPublishingPageLayout

This example returns back all page layouts from http://server_name.

------------------EXAMPLE 2-----------------------

PS C:\> $layout = Get-SPPublishingPageLayout "http://server_name/_catalogs/masterpage/articleleft.aspx"

This example returns back the articleleft.aspx page layout from the http://server_name web.

------------------EXAMPLE 3-----------------------

PS C:\> $layout = $Get-SPWeb http://server_name | Get-SPPublishingPageLayout -PageLayout "articleleft.aspx"

This example returns back the articleleft.aspx page layout from http://server_name.