Jump to main content Jump to doc navigation

modX.setPlaceholders

Other versions: 3.x — Found a problem? Please edit this page or report an issue.

modX::setPlaceholders

Sets a collection of placeholders stored in an array or as object vars. An optional namespace parameter can be prepended to each placeholder key in the collection, to isolate the collection of placeholders.

Note that unlike modX.toPlaceholders and modX.getChunk, this function does not add separators between the namespace and the placeholder key. Use toPlaceholders() when working with multi-dimensional arrays or objects with variables other than scalars so each level gets delimited by a separator.

Syntax

API Doc: http://api.modx.com/revolution/2.2/db_core_model_modx_modx.class.html#%5CmodX::setPlaceholders()

void setPlaceholders (array|object  $placeholders, [string $namespace = ''])

Unlike [getChunk], the $placeholders array can not be deeply nested. It must be a simple associative array.

Example

Add an array of placeholders, and prefix 'my.' to their key.

$modx->setPlaceholders(array(
   'name' => 'John',
   'email' => 'jdoe@gmail.com',
),'my.');

See Also