How to Add Content Editor WebParts to SharePoint 2013 Publishing Pages using PowerShell

Sathish Nadarajan
Solution Architect
September 20, 2015
Rate this article
[Total: 0    Average: 0/5]

Sometime back, we saw how to Add Script Editor WebPart using PowerShell. Now in the same manner, let us see how to add the Content Editor WebPart as well on the pages. This will be very useful, when we are deploying so many pages and adding the webparts manually.

Let us see how to do that. Here I am using a CSV File to Add the Content Editor WebParts in to the Page.

First let us see the CSV File Inputs.

http://MySiteCollection/WebURLTestPage4.aspx<ul><li><a href=’http://’></a></li></ul>

And the Script would be

 ## Description	: Add the Content Editor WebParts to the publishing Pages based onthe Input from the CSV
 ## Author		: Sathish Nadarajan
 ## Date			: 17-Sep-2015
 # ============================================ Setup Input Paths ===========================================================
 $Host.UI.RawUI.WindowTitle = "-- Add Content Editor WebParts --"
 $StartDate = Get-Date
 Write-Host -ForegroundColor White "------------------------------------"
 Write-Host -ForegroundColor White "| Add Content Editor WebParts |"
 Write-Host -ForegroundColor White "| Started on: $StartDate |"
 Write-Host -ForegroundColor White "------------------------------------"
 $LogTime = Get-Date -Format yyyy-MM-dd_hh-mm
 $LogFile = ".\AddWebParts-$LogTime.rtf"
 #start-transcript $logfile
 $scriptBase = split-path $SCRIPT:MyInvocation.MyCommand.Path -parent
 Set-Location $scriptBase
 $ErrorActionPreference = "Stop"
 function AddPowerShellSnapin()
         Write-Host "Adding PowerShell Snap-in" -ForegroundColor Green
         # Try to get the PowerShell Snappin.  If not, then adding the PowerShell snappin on the Catch Block
         Get-PSSnapin "Microsoft.SharePoint.PowerShell" 
         if($Error[0].Exception.Message.Contains("No Windows PowerShell snap-ins matching the pattern 'Microsoft.SharePoint.PowerShell' were found"))
             Add-PSSnapin "Microsoft.SharePoint.PowerShell"
     Write-Host "Finished Adding PowerShell Snap-in" -ForegroundColor Green
 function AddContentEditorWebPart($WebURL, $PageUrl, $Content)
     $webPartProperty_Visible = $true  
     $web = get-spweb $WebURL  
     $defaultPage = $web.GetFile("Pages/" + $PageUrl)  
     if($defaultPage.ListItem.File.CheckedOutByUser -eq $null)
         # Get the LimitedWebPartManager  
         #Create fancy GUID  
         $lvwpGuid1 = [System.Guid]::NewGuid().ToString()  
         $lvwpKey = "g_" + $lvwpGuid1.Replace("-","_")  
         # Instantiate wp  
         $lvwp =New-Object Microsoft.SharePoint.WebPartPages.ContentEditorWebPart
         $lvwp.ID = $lvwpKey  
         $code = "$"  
         $XmlDoc = New-Object System.Xml.XmlDocument
            $contentXml.InnerText= $Content
         $lvwp.Content =  $contentXml
         $lvwp.Title = "Content Editor WebPart"   
         $lvwp.Visible = $webPartProperty_Visible   
         $lvwp.ChromeType = "None"  
         $lvwp.HorizontalAlign = "Center"   
         # Add the web part  
         $webpartmanager.AddWebPart($lvwp, "Main", 0);  
     # Check in the Page with Comments
                 $defaultPage.CheckIn("Checkin by PowerShell")
                 # Publish the Page With Comments
                 $defaultPage.Publish("Published by PowerShell")
     # Update the web  
     write-host "success"  
     write-host "Done"  
     $ContentEditorWebPartDetailsCSV = $scriptBase + "\" + "ContentEditorWebPartDetails.csv"
     import-csv $ContentEditorWebPartDetailsCSV | where {
         AddContentEditorWebPart $_.WebURL $_.PageURL $_.Content
     Write-Host "Script Execution Completed Successfully" -ForegroundColor Green 
     Write-Host "Custom Exception Happened on Main : " + $Error[0].Exception.Message -ForegroundColor Red  

Make sure that the pages were not Checked Out by any other persons. If it is checked out, then the script will not consider that page. The webparts will not be added.

Apart from that, the script is very straight forward and nothing much to explain on it.

Download the CSV And the SCRIPT HERE


Happy Coding,

Sathish Nadarajan.

Author Info

Sathish Nadarajan
Solution Architect
Rate this article
[Total: 0    Average: 0/5]
Sathish is a Microsoft MVP for SharePoint (Office Servers and Services) having 13+ years of experience in Microsoft Technologies. He holds a Masters Degree in Computer Aided Design and Business more

Leave a comment