Remove-PnPWebPart

Removes a webpart from a page

Syntax

Remove-PnPWebPart
      -Identity <GuidPipeBind>
                       -ServerRelativePageUrl <String>
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]
Remove-PnPWebPart
      -Title <String>
                       -ServerRelativePageUrl <String>
                       [-Web <WebPipeBind>]
                       [-Connection <SPOnlineConnection>]

Examples

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

Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Identity a2875399-d6ff-43a0-96da-be6ae5875f82

This will remove the webpart specified by ID to the specified page in the first row and the first column of the HTML table present on the page

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

Remove-PnPWebPart -ServerRelativePageUrl "/sites/demo/sitepages/home.aspx" -Title MyWebpart

This will remove the webpart specified by title to the specified page in the first row and the first column of the HTML table present on the page

Required Parameters

-Identity

The Guid of the webpart

Type:GuidPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-ServerRelativePageUrl

Server relative url of the webpart page, e.g. /sites/demo/sitepages/home.aspx

Type:String
Aliases:PageUrl
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Title

The name of the webpart

Type:String
Aliases:Name
Position:Named
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:SPOnlineConnection
Position:Named
Accept pipeline input:False
Accept wildcard characters:False
-Web

This parameter allows you to optionally apply the cmdlet action to a subweb within the current web. In most situations this parameter is not required and you can connect to the subweb using Connect-PnPOnline instead. Specify the GUID, server relative url (i.e. /sites/team1) or web instance of the web to apply the command to. Omit this parameter to use the current web.

Type:WebPipeBind
Position:Named
Accept pipeline input:False
Accept wildcard characters:False