New post – All about output formatting in ProcessWire

[ryan]

In a recent GitHub issue report, I was asked about output formatting in ProcessWire, and where more information could be found about it. I know I've written about it numerous times, and went to locate the documentation page, only to find we didn't have one!  Output formatting is such an important topic, so here is everything you need to know.  I hope you'll find it simple enough, but also useful and thorough— 

https://processwire.com/blog/posts/output-formatting/

[wbmnfktr]

I don't know if "Woah... impressive!" or "WOW!" is the right answer to this.

[Inxentas]

Thank you Ryan! I have been dilligently but blindly turning Output Formatting on and off in my code for years now, it's nice to know how it all works below the hood. ?

[artfulrobot]

One question I have is: is output formatting on or off in this situation?

$pwUser = $this->wire->pages->newPage([    
  'template'       => 'someTemplate',              
  'name'           => 'someName',
  'someField'      => 'someValue',
]);

A reflection about setting a value when output formatting is ON: The blog says that when it's ON, the formatters will run to check it can be formatted and it will set it to status:corrupted if they can't run. This sounds like good validation to me, which makes me think it might be better advice to do $page->of(true) before setting values, unless you're in a situation where you can really trust your raw data to be valid. Caveat: I note that the example edits are self referential ($page->someField = $page->someField + 'altered') in which case it's clear that output formatting ON is going to cause problems.

 

 

Edited June 19, 2024 by artfulrobot