SharePoint Online: Remove a Field from List Content Type using PowerShell
Requirement: Remove a field from SharePoint list content type in SharePoint Online.
How to Remove a Field from List content type in SharePoint Online?
Here are the steps on how to remove a field from a content type in SharePoint Online list:
Navigate to the List >> Click on Settings >> List Settings >> Pick the relevant content type from the available content types >> Select the column you wish to delete. Click on “Remove” button from the “Change Content Type Column” page.
PowerShell to Remove a Column from List Content Type in SharePoint Online:
In this blog post, we are going to explore how to delete a column from the content type of a SharePoint Online list. Maybe the field was added by mistake or is no longer needed. We will also show you how to use PowerShell to delete a column from a SharePoint Online list content type.
#Load SharePoint CSOM Assemblies
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.dll"
Add-Type -Path "C:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\16\ISAPI\Microsoft.SharePoint.Client.Runtime.dll"
Function Remove-ColumnFromListContentType()
{
param
(
[Parameter(Mandatory=$true)] [string] $SiteURL,
[Parameter(Mandatory=$true)] [string] $ListName,
[Parameter(Mandatory=$true)] [string] $ContentTypeName,
[Parameter(Mandatory=$true)] [string] $ColumnName
)
Try {
$Cred= Get-Credential
$Credentials = New-Object Microsoft.SharePoint.Client.SharePointOnlineCredentials($Cred.Username, $Cred.Password)
#Setup the context
$Ctx = New-Object Microsoft.SharePoint.Client.ClientContext($SiteURL)
$Ctx.Credentials = $Credentials
#Get the List
$List = $Ctx.Web.Lists.GetByTitle($ListName)
$Ctx.Load($List)
#Get the content type from list
$ContentTypeColl = $List.ContentTypes
$Ctx.Load($ContentTypeColl)
$Ctx.ExecuteQuery()
#Check if the content type exists in the list
$ContentType = $ContentTypeColl | Where {$_.Name -eq $ContentTypeName}
If($ContentType -eq $Null)
{
Write-host "Content Type '$ContentTypeName' doesn't exists in '$ListName'" -f Yellow
Return
}
#Get the column to delete from content type
$ContentTypeFieldColl = $ContentType.Fields
$Ctx.Load($ContentTypeFieldColl)
$Ctx.ExecuteQuery()
$Field = $ContentTypeFieldColl | Where {$_.Title -eq $ColumnName }
if($Field -eq $null)
{
Write-host "Column '$ColumnName' Doesn't exists in Content Type '$ContentTypeName'" -f Yellow
}
else
{
#Get the field link from content type
$FieldLinkColl = $ContentType.FieldLinks
$Ctx.Load($FieldLinkColl)
#Remove field from content type
$FieldLink = $FieldLinkColl.GetById($Field.Id)
$FieldLink.DeleteObject()
$ContentType.Update($false)
$Ctx.ExecuteQuery()
Write-host "Column '$ColumnName' Deleted from '$ContentTypeName' Successfully!" -ForegroundColor Green
}
}
Catch {
write-host -f Red "Error Deleting Column from Content Type!" $_.Exception.Message
}
}
#Set parameter values
$SiteURL="https://crescent.sharepoint.com"
$ListName="Projects"
$ContentTypeName="Project Template"
$ColumnName="Project Department" #Display Name of the Field
#Call the function
Remove-ColumnFromListContentType -SiteURL $SiteURL -ListName $ListName -ContentTypeName $ContentTypeName -ColumnName $ColumnName
When you remove a column from the content type, that field becomes a local column in any list or library which are using that content type!
PnP PowerShell to Delete a Field from List Content Type
#Parameters
$SiteURL = "https://Crescentintranet.sharepoint.com/sites/PMO"
$ListName = "Projects"
$ContentTypeName = ""Crescent Project V2"
$FieldName = "Department0" #@"Project_x0020_Manager" #Internal Name
Try {
#Connect to PnP Online
Connect-PnPOnline -Url $SiteURL -Interactive
#Get the Client Context
$Ctx = Get-PnPContext
#Get the Content Type from the List
$ContentType = Get-PnPContentType -Identity $ContentTypeName -List $ListName
#Get the Field from Content type
$Field = $ContentType.Fields.GetByInternalNameOrTitle($FieldName)
$Ctx.Load($Field)
$Ctx.ExecuteQuery()
#Remove the Field from content type
$ContentType.FieldLinks.GetById($Field.Id).DeleteObject()
$ContentType.Update($False) #Update children
$Ctx.ExecuteQuery()
Write-host -f Green "Field '$FieldName' has been removed from Content Type!"
}
Catch {
write-host "Error: $($_.Exception.Message)" -foregroundcolor Red
}
You can also use cmdlet Remove-PnPFieldFromContentType to remove a field from content type:
Remove-PnPFieldFromContentType -Field $Field -ContentType $ContentType