Add-PlaceholderSetting
Adds a placeholder setting to a chosen device for the presentation of an item.

Syntax

1
Add-PlaceholderSetting [-Item] <Item> -Instance <PlaceholderDefinition> [-MetaDataItemId <string>] [-Key <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>]
2
3
Add-PlaceholderSetting [-Path] <string> -Instance <PlaceholderDefinition> [-MetaDataItemId <string>] [-Key <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>]
4
5
Add-PlaceholderSetting -Instance <PlaceholderDefinition> -Id <string> [-MetaDataItemId <string>] [-Key <string>] [-Device <DeviceItem>] [-FinalLayout] [-Language <string[]>] [-Database <string>]
Copied!

Detailed Description

Adds a placeholder setting to a chosen device for the presentation of an item.
© 2010-2019 Adam Najmanowicz, Michael West. All rights reserved. Sitecore PowerShell Extensions

Parameters

-Database <string>

Database containing the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Device <DeviceItem>

Device the placeholder setting is assigned to. If not specified - default device will be used.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-FinalLayout <switch>

Targets the Final Layout. If not provided, the Shared Layout will be targeted. Applies to Sitecore 8.0 and higher only.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Id <string>

Id of the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
None
Required?
true
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?

-Instance <PlaceholderDefinition>

Placeholder setting definition to be added to the item
Aliases
PlaceholderSetting
Required?
true
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Item <Item>

The item to be processed.
Aliases
None
Required?
true
Position?
0
Default Value
Accept Pipeline Input?
true (ByValue, ByPropertyName)
Accept Wildcard Characters?
false

-Key <string>

The key for this placeholder setting - if not specified the value provided in the placeholder setting definition specified in the Instance parameter will be used.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Language <string[]>

Language that will be used as source language. If not specified the current user language will be used. Globbing/wildcard supported.
Aliases
Languages
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-MetaDataItemId <string>

The metadata item Id for this placeholder setting - if not specified the value provided in the placeholder setting definition specified in the Instance parameter will be used.
Aliases
None
Required?
false
Position?
Named
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

-Path <string>

Path to the item to be processed - can work with Language parameter to narrow the publication scope.
Aliases
FullName, FileName
Required?
true
Position?
0
Default Value
Accept Pipeline Input?
false
Accept Wildcard Characters?
false

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.
  • Sitecore.Data.Items.Item

Outputs

The output type is the type of the objects that the cmdlet emits.
  • System.Void

Notes

Help Author: Adam Najmanowicz, Michael West, Alex Washtell

Examples

EXAMPLE 1

Create item defining placeholder setting and add to an item
1
$placeholderSetting = gi "master:\layout\Placeholder Settings\content" | New-PlaceholderSetting -Key "content"
2
$item = gi master:\content\Home
3
# Add the placeholder setting to the item
4
Add-PlaceholderSetting -Item $item -Instance $placeholderSetting
Copied!

EXAMPLE 2

Create item defining placeholder setting and add to an item, overriding the key
1
$placeholderSetting = gi "master:\layout\Placeholder Settings\content" | New-PlaceholderSetting -Key "content"
2
# find item you want the placeholder setting added to
3
$item = gi master:\content\Home
4
# Add the placeholder setting to the item
5
Add-PlaceholderSetting -Item $item -Instance $placeholderSetting -Key "content-override"
Copied!

Related Topics