Jump to content
creativejay

New to Hooks, trying to wrap my head around the syntax

Recommended Posts

I really wanted to create this post with some sample code to show that I at least tried to figure it out on my own first, but I'm really struggling with how hooks are even written. I know it's a very simple context for anyone who's already using them (and hopefully it will be for me, soon), but this is my first time.

What I'm trying to achieve in this attempt is to verify/change the name and title fields of a page, of one specific template with one specific field, whenever the page is saved.

Initially, I am using the Family / Name Format for Children to skip the name/title/confirm save page when an author creates a new page in my site using kongondo's ProcessBlog module.

In English, I want to: Detect when a page of template blog_page is saved with the blog_categories field value of Swatch, and replace the title and name string with a concatenated version of the following fields (from the same page): blog_date, createdUser, blog_brand and blog_name.

From what I've read so far, I should build this hook into site/templates/admin.php, and I should use the saveReady() and maybe saveField() hooks. Other than knowing I need to define a custom hook, I really haven't got any idea of where to go from here. 

Here's my mangled first attempt at coding my hook. Hopefully you'll be able to tell how I might be misunderstanding this from the following:

$pages->addHookAfter('saveReady', $this, 'myPageRename);

public function myPageRename($event) {
 }

I'm afraid that's really as far as I've gotten because I have no idea what I'm doing. I try to follow examples but they feel really far removed from context for me.

Thanks for any light that can be shed on this!

Share this post


Link to post
Share on other sites

There's a really great and simple example given by ryan here that can help you understand.

In your case, you should be able to do the following (not tested):

$pages->addHook('saveReady', function($event) {
  $sanitizer = wire('sanitizer');
  $pages = $event->object;
  $page = $event->arguments(0); 
  if($page->template == 'blog_page' && $page->blog_categories == 'Swatch') {
    // You can build the string as you wish, here is an example
    $concatenatedName = $page->blog_date;
    $concatenatedName .= '-' . $page->createdUser;
    $concatenatedName .= '-' . $page->blog_brand;
    $concatenatedName .= '-' . $page->blog_name;

    $page->title = $concatenatedName;
    $page->name = $sanitizer->pageName($concatenatedName);
  }
});
  • Like 2

Share this post


Link to post
Share on other sites

I find it easier to manage these things in a module like this. Also you need to use a before hook, as saving the page with the new title after saving would trigger an infinite loop. See next posts

<?php

/**
 * ProcessWire 'Hello world' demonstration module
 * 
 * ProcessWire 2.x 
 * Copyright (C) 2014 by Ryan Cramer 
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 * 
 * http://processwire.com
 *
 */

class PutYourNameHere extends WireData implements Module {

	/**
	 * getModuleInfo is a module required by all modules to tell ProcessWire about them
	 *
	 * @return array
	 *
	 */
	public static function getModuleInfo() {

		return array(
			'title' => '', 
			'version' => 1, 
			'summary' => '',
			'singular' => true, 
			'autoload' => true,
			);
	}

	public function init() {
		$this->addHookAfter('Pages::saveReady', $this, 'doStuffOnPage'); 
	}

	public function doStuffOnPage($event) {
		$page = $event->arguments[0]; 

		if($page->template->name === "blog_page" && $page->blog_categories == "Swatch"){
			// Do your thing
		}
	}
	
}

  • Like 3

Share this post


Link to post
Share on other sites

I find it easier to manage these things in a module like this. Also you need to use a before hook, as saving the page with the new title after saving would trigger an infinite loop.

Thank you! So using the string code from @ESRCH in the "//Do your thing" line of your example, I would then install this module in my site and then it will automatically run, or do I need to call it from somewhere else as well?

Share this post


Link to post
Share on other sites

Exactly. You just would do good in renaming the module and placeing it in a file like ModuleClassName.module and mostly it's a good idea to pack it in a folder with this name, too. 

Edit:

Just for your education: The "autoload" config tells processwire to load the module everytime. 

Also you could use this to alert the user in the admin about the modules activity. This will generate a message, e. g. like the one telling you the page has been saved.

$this->message("Changed title according to settings in …");

Share this post


Link to post
Share on other sites

Putting this in a separate module is indeed cleaner.

You probably already read these pages, but I'm putting the links here just in case, since they really helped me develop my own modules/hooks:

https://processwire.com/api/hooks/

http://wiki.processwire.com/index.php/Module_Creation

Also, the Helloworld Module in /site/modules is a great example module to get going.

Share this post


Link to post
Share on other sites

Very good advice from soma (as always).

This is what I usually do:

$this->addHookAfter('Pages::saveReady', $this, 'renameBeforeSave');

public function renameBeforeSave(HookEvent $event) {
        $p = $event->arguments[0];
        $p->name = $new_name;
        $event->return = $p; // maybe this isn't actually needed - haven't tested and can't remember 
        //as soma mentioned - this last line definitely isn't needed!
}

Of course you'll need to add in your logic to limit by template/category and to build up the new name/title.

Share this post


Link to post
Share on other sites

Actually saveReady is an after hook and it's especially useful as you know that the page is saved right after that. So no endless recursion and you don't need to save the page. With a before save hook you don't know if an error will occur.

Also no need to set the page back to the argument after you done with manipulating the page. So lots of mis-infos here..

Means the best answer isn't the best really :P

Edit: removed the 'Solved' flag for now.

  • Like 1

Share this post


Link to post
Share on other sites

No need for the event->return = $p or anything like that, Adrian ;)

Share this post


Link to post
Share on other sites

No need for the event->return = $p or anything like that, Adrian ;)

Yeah, looks like my comment about that crossed with your correction :)

Share this post


Link to post
Share on other sites

@Soma

I updated my post to reflect this as there could easily be people just copying the whole thing.

Share this post


Link to post
Share on other sites

@adrian here's the module I made from your code. I'm getting a unexpected T_VARIABLE, expecting T_FUNCTION (line 55) - that would be on "public function renameBeforeSave(HookEvent $event) {"

<?php

/**
 * ProcessWire 'Rename Page' module by forum user creativejay
 *
 * Checks to see if a page uses the template "blog-post" and has a $page->blog_categories value of "Swatch" then redefines the value of $page->title and $page->name
 * 
 * 
 * ProcessWire 2.x 
 * Copyright (C) 2014 by Ryan Cramer 
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 * 
 * http://processwire.com
 *
 */

class RenamePage extends WireData implements Module {

	/**
	 * getModuleInfo is a module required by all modules to tell ProcessWire about them
	 *
	 * @return array
	 *
	 */
	public static function getModuleInfo() {

		return array(

			// The module's title, typically a little more descriptive than the class name
			'title' => 'Rename Page', 

			// version number 
			'version' => 3, 

			// summary is brief description of what this module is
			'summary' => 'Checks to see if a page uses the template blog-post and has a blog_categories value of Swatch then redefines the value of title and name',
			
			// Optional URL to more information about the module
			'href' => 'https://processwire.com/talk/topic/8863-new-to-hooks-trying-to-wrap-my-head-around-the-syntax/',

			// singular=true: indicates that only one instance of the module is allowed.
			// This is usually what you want for modules that attach hooks. 
			'singular' => true, 

			// autoload=true: indicates the module should be started with ProcessWire.
			// This is necessary for any modules that attach runtime hooks, otherwise those
			// hooks won't get attached unless some other code calls the module on it's own.
			// Note that autoload modules are almost always also 'singular' (seen above).
			'autoload' => true, 
		
			// Optional font-awesome icon name, minus the 'fa-' part
			'icon' => 'eraser', 
			);
	}
$this->addHookAfter('Pages::saveReady', $this, 'renameBeforeSave');

public function renameBeforeSave(HookEvent $event) {
        if($page->template->name === "blog_post" && $page->blog_categories == "Swatches"){
        	$concatenatedName = $page->blog_date;
		    $concatenatedName .= '-' . $page->createdUser;
		    $concatenatedName .= '-' . $page->blog_brand;
		    $concatenatedName .= '-' . $page->blog_name;
		    
			$concatenatedTitle = $page->blog_brand;
		    $concatenatedTitle .= ' ' . $page->blog_name;
		
		    $page->title = $concatenatedTitle;
		    $page->name = $sanitizer->pageName($concatenatedName);
		    }
        $event->arguments[0] = $page;
}

Can you spot what I've done wrong?

Share this post


Link to post
Share on other sites

You need to add the hook in the init function as you can see it done in my first post here. The thing you're writing there is a class, these can only hold properties and functions and not raw code, like you did. It's only there to provide functionality, which can be called later. The init function of a module is always called on loading the module.

  • Like 1

Share this post


Link to post
Share on other sites

Try this:

<?php

/**
 * ProcessWire 'Rename Page' module by forum user creativejay
 *
 * Checks to see if a page uses the template "blog-post" and has a $p->blog_categories value of "Swatch" then redefines the value of $p->title and $p->name
 * 
 * 
 * ProcessWire 2.x 
 * Copyright (C) 2014 by Ryan Cramer 
 * Licensed under GNU/GPL v2, see LICENSE.TXT
 * 
 * http://processwire.com
 *
 */

class RenamePage extends WireData implements Module {

    /**
     * getModuleInfo is a module required by all modules to tell ProcessWire about them
     *
     * @return array
     *
     */
    public static function getModuleInfo() {

        return array(

            // The module's title, typically a little more descriptive than the class name
            'title' => 'Rename Page', 

            // version number 
            'version' => 3, 

            // summary is brief description of what this module is
            'summary' => 'Checks to see if a page uses the template blog-post and has a blog_categories value of Swatch then redefines the value of title and name',
            
            // Optional URL to more information about the module
            'href' => 'https://processwire.com/talk/topic/8863-new-to-hooks-trying-to-wrap-my-head-around-the-syntax/',

            // singular=true: indicates that only one instance of the module is allowed.
            // This is usually what you want for modules that attach hooks. 
            'singular' => true, 

            // autoload=true:indicates the module should be started with ProcessWire.
            // This is necessary for any modules that attach runtime hooks, otherwise those
            // hooks won't get attached unless some other code calls the module on it's own.
            // Note that autoload modules are almost always also 'singular' (seen above).
            'autoload' => true, 
        
            // Optional font-awesome icon name, minus the 'fa-' part
            'icon' => 'eraser', 
            );
    }
    
    public function init() {
        $this->addHookAfter('Pages::saveReady', $this, 'renameBeforeSave');
    }

    public function renameBeforeSave(HookEvent $event) {

        $p = $event->arguments[0];

        if($p->template->name === "blog_post" && $p->blog_categories == "Swatches"){
            $concatenatedName = $p->blog_date;
            $concatenatedName .= '-' . $p->createdUser;
            $concatenatedName .= '-' . $p->blog_brand;
            $concatenatedName .= '-' . $p->blog_name;
            
            $concatenatedTitle = $p->blog_brand;
            $concatenatedTitle .= ' ' . $p->blog_name;
        
            $p->title = $concatenatedTitle;
            $p->name = $sanitizer->pageName($concatenatedName, true);
        }
    }
}

Share this post


Link to post
Share on other sites

Okay, I fixed the mismatched names inside the code (I changed the name to RenameSwatches a few times but the code was still referring to RenamePages). That fixed the 500 error, but nothing happens when I save an existing page.

I suppose I could add a dialog to see if it thinks it's running.

Another thought occurs to me.. the field blog_categories is a Page fieldtype. Would that require an adjustment?

Share this post


Link to post
Share on other sites

Another thought occurs to me.. the field blog_categories is a Page fieldtype. Would that require an adjustment?

// Page field single
if($page->blog_categories->title === "Swatch"){
}

// Page field multiple
if($page->blog_categories->get("title=Swatch")){
}

Share this post


Link to post
Share on other sites

There's a lot not right in your renameBeforeSave method. Naming is also a little bit weird:

You hook after, but you call the method with before in the name.

$p->blog_categories == "Swatches" // If blog_categories is type of page it will not be a string.

$p->createdUser // is a Page // you can't concatenate it like this.

You can't call $sanitizer like this in module scope. (use $this->sanitizer)

Share this post


Link to post
Share on other sites

$p->blog_categories->title ?

$p->createdUser->title ?

And I should turn $p->blog_date into a string, I imagine?

Share this post


Link to post
Share on other sites

$p->blog_categores->title == 'Swatch';

For the $p->createdUser, you can actually still use $p->createdUser, since the toString method of the page will convert it to its page id.

Share this post


Link to post
Share on other sites

blog_categories is a Multiple Page field. This will not work $p->blog_categories == 'swatch'; This has been pointed out above with example code by LostKobrakai.

Edit - see next post...

Edited by kongondo

Share this post


Link to post
Share on other sites

@kongondo your default blog_categories is, but I changed it to a Single Page field because of the way my (already familiarly strange to you) blog is structured. ;)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By MateThemes
      Hello everyone!
      I am working with Processwire since some time. But some topics are quite hard for me.
      I have a Portfolio (Gallery) Page.
      I am build a template with Portfolio Index and pages with portfolio entries.
      Structure:
      Portfolio Index
      -- Portfolio Entry
      -- Portfolio Entry
      and so on.
      Portfolio Entry has an Image field with max 12 images and are accessible Templates. 
      Now I want to display the single Portfolio Entry on the Portfolio Index and Paginate them. In the index page all images of a single Entry page should be displayed (I should not be organized as albums, where a random image of the portfolio entry should be displayed). 
      I have no clue to achieve this. May someone could give me an advice.
      Thank you in advance!
    • By ngrmm
      I have a page with a table. Each table row has a page-reference field and a checkbox.
      The Page sends emails to all users (page-refrence->email-field) and change the value of the checkbox in a row to 1.
      It works with this:
      <?php // event ID fron url query $eventID = $input->get('eventID','int'); // get event-page $event = $pages->get($eventID); // config $fromEmail = $event->event_mail_from; $fromName = $event->event_mail_from_name; $emailSubject = $event->event_subject; // email html body ob_start(); include('./_inc/emailbody.inc'); $emailBody = ob_get_clean(); // make event-page editable $event->of(false); // loop through table and send out emails foreach($event->event_clients_list as $event_table_row) { // get client page $clientPage = $event_table_row->client_name; // get client email $clientEmail = $clientPage->email; // if client isn't invited yet (checkbox not checked) if($event_table_row->client_invited == '') { // send email $m = new WireMail(); $m->to($clientEmail); $m->from($fromEmail, $fromName); $m->subject($emailSubject); $m->bodyHTML($emailBody); $m->send(); // mark client as invited $event_table_row->client_invited = 1; $event->save('event_clients_list'); } } ?> But i have to use a variable in my emailbody.inc which i'm able to get in the table-loop.
      So i do the including of the body inside my loop. But this doesn't work anymore. Page sends out the emails but is unable to change the value of the checkbox.
      I get no errors!
      I'm using ProTable
      <?php // event ID fron url query $eventID = $input->get('eventID','int'); // get event-page $event = $pages->get($eventID); // config $fromEmail = $event->event_mail_from; $fromName = $event->event_mail_from_name; $emailSubject = $event->event_subject; // loop through table and send out emails foreach($event->event_clients_list as $event_table_row) { // get client page $clientPage = $event_table_row->client_name; // get client email $clientEmail = $clientPage->email; // email html body ob_start(); include('./_inc/emailbody.inc'); $emailBody = ob_get_clean(); // make event-page editable $event->of(false); // if client isn't invited yet (checkbox not checked) if($event_table_row->client_invited == '') { // send email $m = new WireMail(); $m->to($clientEmail); $m->from($fromEmail, $fromName); $m->subject($emailSubject); $m->bodyHTML($emailBody); $m->send(); // mark client as invited $event_table_row->client_invited = 1; $event->save('event_clients_list'); } } ?>  
    • By Vigilante
      In general, is there an easy way to know which method should be used to access the API?
      For example, when _ini.php is used in the theme, it would seem you have to use wire()->addHookBefore(...). But on other sites where they used ready.php, I've seen it go straight to just doing $this->addHookAfter() even though there is no class or namespace set up in the ready.php file.
      So how do I know when I can do $this, or $wire, or wire() to access things? And any other variables I'm not aware of.
      Thanks!
    • By VeiJari
      Hello forum,
      This is really a weird one, because front end editing works in a earlier website we did to a customer. 
      When I check the source code for current website it does initiate front end edit: 
      <span id=pw-edit-1 class='pw-edit pw-edit-InputfieldPageTitle' data-name=title data-page=1021 data-lang='1017' style='position:relative'><span class=pw-edit-orig>Tekijät</span><span class=pw-edit-copy id=pw-editor-title-1021 style='display:none;-webkit-user-select:text;user- select:text;' contenteditable>Tekijät</span></span>  But when I double click nothing happens (yes I'm 100% sure I'm superuser and logged in)
      I also tried to apply the front end with other methods than:
      $page->edit('title'); But didn't work either.
      We are using jquery 2.2.4, so it should not be a problem.
      Is this a bug related to current master or something else?
      Someone else having this problem as well?
    • By Hardoman
      Hello community,
      we have a website running version 3.0.118. The owner would like to have a watermark merged to the images, that are being uploaded in the CKEditor as a requirement.
      Image upload besides the CKEditor within galleries and single images works as a charm already. We also use croppable image 3 there. (PIM2)
      To realize this requirement, I thought of using a hook in the admin area. So, I read a lot in our forums and tested this by adding a hook into the ready.php file.
      $this->addHookAfter('InputfieldFile::fileAdded',function(HookEvent$event){ wire('log')->save('test','Image upload works'); ... The log entry is being created correctly. But when I try to use the pim/watermark-function like in a template, he cannot find the watermark-image anymore. Furthermore, when I try to get the page-id, it does not seem to be accessible, because the application does not seem to know how to reference it, or I dont know the right way to do so…
      So my questions are:
       
      Is this the right attempt at all or will there be another, better workaround? It seems, I cannot access the page object (of the content page) within this scope or file but I would need it to save the processed image inside the right files/id folder Would it be better to place the hook into the admin-template? (or admin.php)
        Thanks for any hints in advance. 🙂
×
×
  • Create New...