Initialize-Item
Initializes items with the PowerShell automatic properties for each field.
Syntax
Initialize-Item -Item <Item>
Initialize-Item -SearchResultItem <SearchResultItem>
Detailed Description
The Initialize-Item command wraps Sitecore item with PowerShell property equivalents of fields for easy assignment of values to fields and automatic saving. This command can also be used to translate the the "Sitecore.ContentSearch.SearchTypes.SearchResultItem" items obtained from the Find-Item command into full Sitecore Items. The alias for the command is Wrap-Item.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions
Aliases
The following abbreviations are aliases for this cmdlet:
- Wrap-Item
Parameters
-Item <Item>
The item to be wrapped/initialized.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false
-SearchResultItem <SearchResultItem>
The item obtained from Find-Item command to be translated into a sitecore item.
Aliases
Text
Required?
true
Position?
named
Default Value
​
Accept Pipeline Input?
true (ByValue)
Accept Wildcard Characters?
false
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- Sitecore.Data.Items.ItemSitecore.ContentSearch.SearchTypes.SearchResultItem
Outputs
The output type is the type of the objects that the cmdlet emits.
- Sitecore.Data.Items.Item
Notes
Help Author: Adam Najmanowicz, Michael West
Examples
EXAMPLE
Initialize the item obtained directly through the Sitecore API with additional PowerShell properties
1
$item = [Sitecore.Configuration.Factory]::GetDatabase("master").GetItem("/sitecore/content/home");
2
#So far the item does not have PowerShell instrumentation wrapped around it yet - the following like wraps $item in those additional properties
3
$item = Initialize-Item -Item $item
4
# The following line will assign text to the field named MyCustomeTextField and persist the item into the database automatically using the added PowerShell property.
5
$item.Title = "New Title"
Copied!
Related Topics
- Get-Item
- Get-ChildItem
Last modified 10d ago