{"id":31416,"date":"2018-04-21T15:47:46","date_gmt":"2018-04-21T15:47:46","guid":{"rendered":"https:\/\/ampscript.guide\/contentblockbyname\/"},"modified":"2021-08-30T12:17:15","modified_gmt":"2021-08-30T12:17:15","slug":"contentblockbyname","status":"publish","type":"post","link":"https:\/\/ampscript.guide\/contentblockbyname\/","title":{"rendered":"ContentBlockByName"},"content":{"rendered":"

ContentBlockByName<\/h2>\n

This function returns the content stored in the specified Content Block and optionally wraps the content in an Impression Region<\/a>.<\/p>\n

Arguments<\/h3>\n

ContentBlockByName(1,2,3,4,5)<\/code><\/p>\n\n\n\n\n\n\n\n\n\n
Ordinal<\/th>\nType<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
1<\/td>\nString<\/td>\nTrue<\/td>\nThe full path of the content block to return<\/td>\n<\/tr>\n
2<\/td>\nString<\/td>\nFalse<\/td>\nName of the Impression Region<\/a> to associate with this Content Area<\/td>\n<\/tr>\n
3<\/td>\nBoolean<\/td>\nFalse<\/td>\nReturn an error if the Content Area cannot be found<\/td>\n<\/tr>\n
4<\/td>\nString<\/td>\nFalse<\/td>\nDefault content if an error occurs retrieving the content block specified in Ordinal 1<\/td>\n<\/tr>\n
5<\/td>\nNumber<\/td>\nFalse<\/td>\nNumeric status code resulting from the retrieve. A value of 0<\/code> indicates the retrieve was successful, while -1<\/code> indicates that the content was not found or empty.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
\n

NOTE: This function is only for use with Content Builder assets. It does not<\/em> retrieve content stored in Classic Content. To retrieve content from Classic Content by name, use the ContentAreaByName<\/a> function.<\/p>\n<\/blockquote>\n

Example 1<\/h3>\n

A Content Block named LoyaltyGreeting<\/code> in the Content Builder<\/code> folder contains the following code:<\/p>\n

%%[\n\nvar @firstName\nset @firstName = properCase(AttributeValue(\"FirstName\"))\n\n]%%\nHello, %%=v(@firstName)=%%!<\/code><\/pre>\n
The Content Block can be referenced as:<\/p>\n
%%[\n\nvar @contentBlockName\nset @contentBlockName = \"Content Builder\\LoyaltyGreeting\"\n\n]%%\n%%=ContentBlockByName(@contentBlockName)=%%<\/code><\/pre>\n
Output<\/h4>\n
Hello, Curt!<\/code><\/pre>\n
Example 2<\/h3>\n
A Content Block named LoyaltyGreeting<\/code> in the Content Builder<\/code> folder contains the following code:<\/p>\n
%%[\n\nvar @firstName\nset @firstName = properCase(AttributeValue(\"FirstName\"))\n\n]%%\nHello, %%=v(@firstName)=%%!<\/code><\/pre>\n
In the scenario where the Content Block does not exist, fallback content is handled with the value of the fourth argument or by conditionally showing content based on the value of the @retrieveStatus<\/code> variable:<\/p>\n
%%[\n\nvar @contentBlockName, @content, @retrieveStatus\nset @contentBlockName = \"Content Builder\\LoyaltyGreeting_Oops\" \/* does not exist *\/\nset @content = ContentBlockByName(@contentBlockName, \"Greeting\", 0, \"Hello!\", @retrieveStatus)\n\noutput(concat(@content))\n\nif @retrieveStatus < 0 then\n  output(concat('<br><br><a href=\"https:\/\/limedash.com\/join\">Join Now<\/a> &raquo;'))\nendif\n\n]%%\n<\/code><\/pre>\n
Output<\/h4>\n
Hello!\n\n<a href=\"https:\/\/limedash.com\/join\">Join Now<\/a> &raquo;<\/code><\/pre>\n","protected":false},"excerpt":{"rendered":"
ContentBlockByName This function returns the content stored in the specified Content Block and optionally wraps the content in an Impression Region. Arguments ContentBlockByName(1,2,3,4,5) Ordinal Type Required Description 1 String True The full path of the content block to return 2 String False Name of the Impression Region to associate with this Content Area 3 Boolean […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"yoast_head":"\nThe AMPscript Guide - ContentBlockByName<\/title>\n<meta name=\"robots\" content=\"index, follow\" \/>\n<meta name=\"googlebot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<meta name=\"bingbot\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/ampscript.guide\/contentblockbyname\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The AMPscript Guide - ContentBlockByName\" \/>\n<meta property=\"og:description\" content=\"ContentBlockByName This function returns the content stored in the specified Content Block and optionally wraps the content in an Impression Region. Arguments ContentBlockByName(1,2,3,4,5) Ordinal Type Required Description 1 String True The full path of the content block to return 2 String False Name of the Impression Region to associate with this Content Area 3 Boolean […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/ampscript.guide\/contentblockbyname\/\" \/>\n<meta property=\"og:site_name\" content=\"The AMPscript Guide\" \/>\n<meta property=\"article:published_time\" content=\"2018-04-21T15:47:46+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-08-30T12:17:15+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebSite\",\"@id\":\"https:\/\/ampscript.guide\/#website\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"The AMPscript Guide\",\"description\":\"The Definitive Scripting Manual for Salesforce Marketing Cloud\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/ampscript.guide\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/contentblockbyname\/#webpage\",\"url\":\"https:\/\/ampscript.guide\/contentblockbyname\/\",\"name\":\"The AMPscript Guide - ContentBlockByName\",\"isPartOf\":{\"@id\":\"https:\/\/ampscript.guide\/#website\"},\"datePublished\":\"2018-04-21T15:47:46+00:00\",\"dateModified\":\"2021-08-30T12:17:15+00:00\",\"author\":{\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\"},\"breadcrumb\":{\"@id\":\"https:\/\/ampscript.guide\/contentblockbyname\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/ampscript.guide\/contentblockbyname\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/ampscript.guide\/contentblockbyname\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/\",\"url\":\"https:\/\/ampscript.guide\/\",\"name\":\"Home\"}},{\"@type\":\"ListItem\",\"position\":2,\"item\":{\"@type\":\"WebPage\",\"@id\":\"https:\/\/ampscript.guide\/contentblockbyname\/\",\"url\":\"https:\/\/ampscript.guide\/contentblockbyname\/\",\"name\":\"ContentBlockByName\"}}]},{\"@type\":[\"Person\"],\"@id\":\"https:\/\/ampscript.guide\/#\/schema\/person\/5335042f77731e84f9808aecef25daec\",\"name\":\"dev\"}]}<\/script>\n<!-- \/ Yoast SEO Premium plugin. -->","_links":{"self":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31416"}],"collection":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/comments?post=31416"}],"version-history":[{"count":0,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/posts\/31416\/revisions"}],"wp:attachment":[{"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/media?parent=31416"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/categories?post=31416"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/ampscript.guide\/wp-json\/wp\/v2\/tags?post=31416"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}