Skip to content

pbBlocks

Snippet for displaying blocks.

Parameters

ParameterDefaultDescription
modelTypemodDocumentDocument model
classKeypbBlockValueTable class
context_keycurrent resourceBy default, the current resource context is used.
resource_idcurrent resourceBy default, the ID of the current resource is used.
tplChunk for blocks. By default, it is used from the block itself.
sortbymenuindexSort field
sortdirASCSort order
limit20Number of records displayed. 0 - means without limits.
offset0Skipping values from the start
fileElements0Use file chunks
outputSeparator\nOutput format of values. Possible values: data, json
where[]Array of additional parameters for filtering results.
returnchunkOutput format of values. Possible values: chunk, data or array, json

Examples

For blocks, it's sufficient to call as follows:

php
{'!pbBlocks'|snippet}

If file chunks are used:

php
{'!pbBlocks'|snippet: [
    'fileElements' => 1
]}

Display a single block with id = 1:

php
{'!pbBlocks'|snippet: [
    'where' => [
        'id' => 1
    ]
]}

Use conditions for displaying blocks:

php
{'!pbBlocks'|snippet: [
    'where' => [
        'model_type' => 'modDocument',
        'model_id' => $_modx->resource->id,
        'context_key' => $_modx->resource->context_key,
        'published' => 1,
        'deleted' => 0,
    ]
]}

© PageBlocks 2019-present