STSADM/Cmdlet Index
SharePoint 2013 Cmdlets (89)
- Word Automation (2)
  - Get-SPWordConversionJobStatus
  - New-SPWordConversionJob
- Web Parts (10)
- Web Applications (2)
  - Add-SPWebApplicationUserPolicy
  - Set-SPBackConnectionHostNames
- Users (1)
  - Remove-SPAllUsers
- User Profiles (2)
  - Get-SPUserProfileChanges
  - Set-SPProfilePictureUrl
- Timer Jobs (2)
  - Get-SPRunningTimerJobs
  - Start-SPAdminJob2
- Themes (1)
  - Reset-SPTheme
- Site Collections (8)
- Quotas (4)
- Wiki Pages (2)
  - Add-SPWikiPageHtml
  - Set-SPOWikiPageLayout
- Pages (7)
- Managed Metadata (2)
  - Export-SPTerms
  - Import-SPTerms
- Lists (21)
- Groups (5)
- Features (3)
- Farm (3)
- Content Types (5)
- Audiences (9)

Replace-SPWebPartContent

Replaces all occurances of the search string with the replacement string. Supports the use of regular expressions. Use -WhatIf to verify your replacements before executing.

Replace-SPWebPartContent -Page <SPFilePipeBind> -SearchString <String> -ReplaceString <String> [-WebPartName [<String>]] [-Publish [<SwitchParameter>]] [-UnsafeXml [<SwitchParameter>]] [-LogFile [<String>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Replace-SPWebPartContent -Web <SPWebPipeBind> -SearchString <String> -ReplaceString <String> [-WebPartName [<String>]] [-Publish [<SwitchParameter>]] [-UnsafeXml [<SwitchParameter>]] [-LogFile [<String>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Replace-SPWebPartContent -Site <SPSitePipeBind> -SearchString <String> -ReplaceString <String> [-WebPartName [<String>]] [-Publish [<SwitchParameter>]] [-UnsafeXml [<SwitchParameter>]] [-LogFile [<String>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Replace-SPWebPartContent -WebApplication <SPWebApplicationPipeBind> -SearchString <String> -ReplaceString <String> [-WebPartName [<String>]] [-Publish [<SwitchParameter>]] [-UnsafeXml [<SwitchParameter>]] [-LogFile [<String>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Replace-SPWebPartContent -Farm <SPFarmPipeBind> -SearchString <String> -ReplaceString <String> [-WebPartName [<String>]] [-Publish [<SwitchParameter>]] [-UnsafeXml [<SwitchParameter>]] [-LogFile [<String>]] [-AssignmentCollection [<SPAssignmentCollection>]]

Parameters

Parameter	Required	Type	Description
Page	True	SPFilePipeBind	The URL to the page containing the web parts whose content will be replaced.
SearchString	True	String	A regular expression search string.
ReplaceString	True	String	The string to replace the match with.
WebPartName	False	String	The name of the web part to update within the scope.
Publish	False	SwitchParameter	Publish or check-in the file after updating the contents.
UnsafeXml	False	SwitchParameter	Perform a replace on XML fields without iterating through the elements of the XML (do a straight search and replace on the XML string without going through the DOM)
LogFile	False	String	The log file to store all change records to.
AssignmentCollection	False	SPAssignmentCollection	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.

Parameter	Required	Type	Description
Web	True	SPWebPipeBind	Specifies the URL or GUID of the Web containing the web parts whose content will be replaced. 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.
SearchString	True	String	A regular expression search string.
ReplaceString	True	String	The string to replace the match with.
WebPartName	False	String	The name of the web part to update within the scope.
Publish	False	SwitchParameter	Publish or check-in the file after updating the contents.
UnsafeXml	False	SwitchParameter	Perform a replace on XML fields without iterating through the elements of the XML (do a straight search and replace on the XML string without going through the DOM)
LogFile	False	String	The log file to store all change records to.
AssignmentCollection	False	SPAssignmentCollection	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.

Parameter	Required	Type	Description
Site	True	SPSitePipeBind	The site containing the web parts whose content will be replaced. The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh; a valid URL, in the form http://server_name; or an instance of a valid SPSite object.
SearchString	True	String	A regular expression search string.
ReplaceString	True	String	The string to replace the match with.
WebPartName	False	String	The name of the web part to update within the scope.
Publish	False	SwitchParameter	Publish or check-in the file after updating the contents.
UnsafeXml	False	SwitchParameter	Perform a replace on XML fields without iterating through the elements of the XML (do a straight search and replace on the XML string without going through the DOM)
LogFile	False	String	The log file to store all change records to.
AssignmentCollection	False	SPAssignmentCollection	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.

Parameter	Required	Type	Description
WebApplication	True	SPWebApplicationPipeBind	The web application containing the web parts whose content will be replaced. The type must be a valid URL, in the form http://server_name; or an instance of a valid SPWebApplication object.
SearchString	True	String	A regular expression search string.
ReplaceString	True	String	The string to replace the match with.
WebPartName	False	String	The name of the web part to update within the scope.
Publish	False	SwitchParameter	Publish or check-in the file after updating the contents.
UnsafeXml	False	SwitchParameter	Perform a replace on XML fields without iterating through the elements of the XML (do a straight search and replace on the XML string without going through the DOM)
LogFile	False	String	The log file to store all change records to.
AssignmentCollection	False	SPAssignmentCollection	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.

Parameter	Required	Type	Description
Farm	True	SPFarmPipeBind	Provide the SPFarm object to replace matching content in all web parts throughout the farm.
SearchString	True	String	A regular expression search string.
ReplaceString	True	String	The string to replace the match with.
WebPartName	False	String	The name of the web part to update within the scope.
Publish	False	SwitchParameter	Publish or check-in the file after updating the contents.
UnsafeXml	False	SwitchParameter	Perform a replace on XML fields without iterating through the elements of the XML (do a straight search and replace on the XML string without going through the DOM)
LogFile	False	String	The log file to store all change records to.
AssignmentCollection	False	SPAssignmentCollection	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

Replaces all occurances of the search string with the replacement string. Supports the use of regular expressions. Use -WhatIf to verify your replacements before executing.

> 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------------------

PS C:\> Get-SPWeb http://portal | Replace-SPWebPartContent -SearchString "(?i:old product name)" -ReplaceString "New Product Name" -Publish

This example does a case-insensitive search for "old product name" and replaces with "New Product Name" and publishes the changes after completion.

SharePoint Automation Gary Lapointe – Founding Partner, Aptillon, Inc.

Replace-SPWebPartContent

Parameters

Detailed Description

Examples