Jump to content
Jonathan Lahijani

How to add a new method/property via a Hook to specific Page template?

Recommended Posts


The Hook API documentation is great in explaining how hooks work.

I wanted to know if it's possible to add a method or property to a Page, but pages only of a specific template type.

The reasoning behind this would be certain methods or properties would only apply to specific template types.


Thank you.

Share this post

Link to post
Share on other sites

Thanks for that resource Adrian.

However, I don't think that approach will work for what I have in mind.

For example, let's say I'm on a page that is of the template "car" that lists all the details of the car.  Naturally, this gets stored in $page.

Then let's say while still on that page I want to output the content of a separate page of a totally different template... let's call it "computer".

$mycomputer = $pages->get("/computers/macbook-pro/");

At this point, both $page (which has a template of "car") and $mycomputer (which has a template of "computer") are of the Page class, but of different templates.  Naturally, some methods would apply to "car" and some would apply to "computer".

So, for example, would it be possible to add a property called "hello" to just a Page of template "computer", even without being on the "computer" template?

Share this post

Link to post
Share on other sites

I think I see your point now - maybe if you can explain exactly what you need the hook to do it might be easier to figure out the best approach.

Share this post

Link to post
Share on other sites

The answer is relatively simple and there would be different ways but best would be to:

In a autoload module (HelloWorld.module) add the hook to ready() where the page being rendered is already set in $this->page

So this would only add property to basic-page templates:

public function ready(){
    if($this->page->template == "basic-page"){
        $this->page->addHookProperty('hello', $this, 'helloHook');

public function helloHook(HookEvent $event){
    $event->return = "Hello World";

After all I'm not sure this would make a lot of difference to just add it pages globally. But I could see this being useful for certain situations.

  • Like 4

Share this post

Link to post
Share on other sites

You can also just check the page type within the hook function. By simply issuing a 'return' if it doesn't match the template you want, that duplicates the behavior of accessing an unknown property (resulting in a null value being returned to the caller). 

wire()->addHookProperty('Page::hello', function($event)) {
  if($event->object->template != 'basic-page') return; 
  $event->return = 'hi';
  • Like 1

Share this post

Link to post
Share on other sites

Now you can do it even easier:

wire()->addHookProperty('Page(template=basic-page)::hello', function($event)) {
  $event->return = 'hi';


  • Like 3

Share this post

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By VeiJari
      Hello forum!
      I've yet again stumbled on a head-scratching situation. We have enabled the option on our articles template and events template that it skips the title adding part and goes straight to the form. This is what our customer wants. So when you add a new article or event it automatically names it temporary to "article-0000000" and same with event. Now the problem is that obviously after saving the form we want to change to page url or "name" to the title, like it's normally. 
      Now here's the code for the hook:
      wire()->addHookBefore("Pages::saved(template=tapahtuma|artikkeli)", function($hook) {
        $page = $hook->arguments(0);
        $newUrl = wire()->sanitizer->pageName($page->title); // give it a name used in the url for the page
        $page->setAndSave('name', $newUrl);
      I get the correct page and the name and path changes when I log them, but when I try to save it. It just loads and then I get: 
      Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 262144 bytes) This happens in sanitizer.php
      and then another error: Fatal error: Allowed memory size of 134217728 bytes exhausted (tried to allocate 262144 bytes) in Unknown on line 0
      What is happening? Am I not suppose to use sanitizer in this way? When we made a temporary page object in out other hook, the sanitizer worked perfectly.
      Thanks for the help!
    • By VeiJari
      Hello forum! I'm trying to learn how to time up my functions by using lazycron but I can't get it fired up. 
      Here's my code in site/init.php:
      function setEventToRepeat(HookEvent $e) { $wire->log->message("kutsutaan cron"); $events = $wire->pages->find('template=tapahtuma'); die(var_dump($events)); $wire->log->message('Kaikki tapahtumat haettu:' .$events); }   $wire->addHook('LazyCron::every30Seconds', null, 'setEventToRepeat'); I get nothing in the logs and can't echo or dump anything
      Thanks for the help!
    • By louisstephens
      So I have been diving into hooks lately, and I am enjoying them thus far. However, I guess I am a bit stumped on how to achieve what I want too. I am trying to set up a hook that would create a new child page when the parent page is saved. However, when you save the parent page a second time, I just need to update the child page without creating multiple child pages. What would be the best way to go about this?
      So after rereading my post, I believe it is a bit vague so I will try to explain more. 
      The Goal:
      Create a page with a template "one". Once the page is created/saved => create a new child page with the template of "two" If the parent is saved anytime after, do nothing to the child page (limit the parent page to one child page) The parent page is really just being used to output content, whereas the child page is being used to pull out the some fields from the parent to be used elsewhere. I might have made this too complicated in my head.
    • By quickjeff
      Hi Guys,
      I am running a page template that contains a filter form that allows users to display results based on number of  comments. 
      Here is what I am thinking about doing: 
      -add new field called total_comments 
      -somehow populate this field every time a new comment is added or removed by admin with count($page->comments)
      -use form filter to display results that the selector form has found.
      Example: $selector = “total_comments>=$q”; 
      My question to everyone: Is this a good approach? If so how do I get another field to update based on the comment module adding or removing a comment? 
    • By Mustafa-Online
      I got a field with a type of "files" named: course_file .. how can I upload it to custom directory??
  • Create New...