What's the use of the 2nd parameter of function FormatString()

Grahack

in Framework.Class.Context.php

function FormatString($String, $Object, $Format, $FormatPurpose)

I don't know what to put here, in most formatters, it's not used at all.

WallPhone

Good question.

It's answered about the middle of the documentation on string formatters:

An object that an extension author may want to use when formatting the string. Again, 99% of the time this will be the Comment object. The comment object was chosen just in case an extension writer wanted access to any information about the comment (like the author’s name and UserID).

So I guess it could be anything you need to get your formatter to work properly. Only formatter that I think uses this would be the extended text formatter.

Grahack

Thanks WallPhone.
If any formatter builder here uses this object, please let me know, I'm curious by nature...