Page handler nomenclature is confusing (Trac #4412)

[elgg-gitbot]

Original ticket http://trac.elgg.org/ticket/4412 on 2012-03-14 by trac user mrclay, assigned to unknown.

Elgg version: 1.8

The PHPDoc for elgg_register_page_handler is clearest: "Registers a page handler for a particular identifier"; i.e. "discussion" is the identifier and "discussion_page_handler" is the handler (function), but confusingly the variable name $handler is used in many places to mean identifier.

I was surprised to find in page_handler(), route/$handler actually triggered route/discussion, not route/discussion_page_handler. Unfortunately, the identifier is passed to the hook handler under the key 'handler', so changing that could break BC, but renaming the local vars would help. What is also confusing is how the route hook is triggered passing $params in, but in your handler this is actually $returnvalue, not $params.

The "route" hook trigger should also probably be mentioned on the Engine/Controllers/PageHandler wiki page.

[elgg-gitbot]

ewinslow wrote on 2012-05-12

Care to submit a PR?

[elgg-gitbot]

Milestone changed to Elgg 1.8.x by ewinslow on 2012-05-12