Craft CMS Stack Exchange is a question and answer site for administrators, end users, developers and designers for Craft CMS. It only takes a minute to sign up.
Sign up to join this community
I am having a hard time trying to figure out how to pull matrix blocks within an entry into the single entry's endpoint with the Element API plugin.
Is this possible? Or do I need to output the blockId's and then create another API endpoint to query by the matrix block id?
Totally possible. Just loop through the blocks and add whatever data you want from them to the response array:
'transformer' => function(EntryModel $entry) {
// Create an array of all the "Body" Matrix field's blocks
$bodyBlocks = [];
foreach ($entry->body as $block) {
switch ($block->type->handle) {
case 'text':
$bodyBlocks[] = [
'text' => $block->myRichTextField->getParsedContent(),
];
break;
case 'image':
$image = $block->myAssetsField->first();
$bodyBlocks[] = [
'image' => $image ? $image->getUrl(['width' => 500]),
'caption' => $block->myPlainTextField,
];
break;
}
}
return [
'title' => $entry->title,
'url' => $entry->url,
'description' => (string) $entry->description,
'body' => $bodyBlocks
];
},
Each of the elements in that sub-array will be MatrixBlockModel objects.
'text' => $block->text, to my endpoint def returns Property 'Craft\MatrixBlockModel.text' is not defined.. My handle is text for a rich text field.
text field.
Jan 6, 2016 at 23:22
textBlock type has a text field inside it (which is "rich text" but that shouldn't matter). I also have a few more with various fieldtypes inside of them. E.G. imageBlock has an assets field inside of it but I haven't tried grabbing it yet. Trying to sort our the basics. Thanks a ton for your help with this!
getParsedConent() method, which was added in Craft 2.5.2753.
Jan 7, 2016 at 11:41
It is possible with a foreach, something like this:
'transformer' => function(Entry $entry) {
$values = [];
foreach($entry->fieldHandle as $block){
$values[] = $block['fieldMatrixHandle'];
}
return [
'data' => $values,
];
},