How to Make a New Hook - Revision history

PeterRobert at 10:33, 1 October 2024

2024-10-01T10:33:36Z

PeterRobert at 13:04, 10 January 2024

2024-01-10T13:04:36Z

PeterRobert at 13:03, 10 January 2024

2024-01-10T13:03:53Z

PeterRobert at 16:26, 7 June 2022

2022-06-07T16:26:30Z

PeterRobert at 16:06, 7 June 2022

2022-06-07T16:06:46Z

PeterRobert at 15:33, 7 June 2022

2022-06-07T15:33:18Z

PeterRobert at 15:28, 7 June 2022

2022-06-07T15:28:45Z

PeterRobert at 15:21, 7 June 2022

2022-06-07T15:21:21Z

PeterRobert at 15:20, 7 June 2022

2022-06-07T15:20:43Z

PeterRobert at 15:20, 7 June 2022

2022-06-07T15:20:25Z

@@ Line 1: / Line 1: @@
 <div class="btn btn-grey btn-back">{{#fas:arrow-left}} Back</div> <div class="btn btn-grey btn-faq">{{#fas:question-circle}} FAQ Tips & Tricks</div>
 <hr>
+__TOC__
+__FORCETOC__
 The pre-placed '''hook calls''' or '''injection points''' throughout the core files enable code to be inserted or injected at those points with a hook file.

@@ Line 135: / Line 135: @@
   class hook_shop_checkout_confirmation_Cmessage {
      function listen_injectFormDisplay() {
-         $output = MESSAGE_CHECKOUT_CONFIRMATION ;
+         $output = MESSAGE_CHECKOUT_CONFIRMATION;
          return $output;
+     }

@@ Line 78: / Line 78: @@
 class hook_shop_siteWide_pageTopMessage {
      function listen_injectBodyStart() {
          $output = PAGE_TOP_MESSAGE;
          return $output;
+     }
+}
 </pre>
@@ Line 139: / Line 135: @@
   class hook_shop_checkout_confirmation_Cmessage {
      function listen_injectFormDisplay() {
-         $output = null;
+         $output = MESSAGE_CHECKOUT_CONFIRMATION ;
          return $output;
+     }
+  }
 </pre>

@@ Line 176: / Line 176: @@
 In this case add:
-<pre> echo $hooks->cat('checkout_confirmation', 'message');
+<pre> echo $hooks->cat('message');
 </pre>
 after Line 30:

@@ Line 176: / Line 176: @@
 In this case add:
-<pre>echo $OSCOM_Hooks->call('checkout_confirmation', 'message');
+<pre> echo $hooks->cat('checkout_confirmation', 'message');
 </pre>
 after Line 30:

@@ Line 120: / Line 120: @@
 A hook call can be seen already in place:
-<pre>echo $OSCOM_Hooks->call('siteWide', 'injectFormDisplay');</pre>
+<pre>echo $hooks->cat('injectFormDisplay');</pre>
-This shows '''siteWide''', the Group and '''injectFormDisplay''', the Action.
+This shows '''injectFormDisplay''' as the Action.
 It can be seen that the hook call is placed just before the '''Finalise Order''' button so that is where the hook file output will be inserted.
-There is already a hook file that listens for that call - '''MATC.php''' that shows the Legal agreements.
+Note that when more than one hook file is injected at one hook call position they will be loaded sorted by their name.
 The sort rules are numbers, then uppercase letters (in alphabetical order), then _, then lowercase letters.
-This message is intended to show before '''MATC.php''' so must have a name that sorts before uppercase M.
+In this case it is named '''Cmessage.php'''
 The new file is created in '''/templates/override/includes/hooks/shop/checkout_confirmation/'''

@@ Line 22: / Line 22: @@
 The hook calls will look like, for an example:
-<pre>$OSCOM_Hooks->call('siteWide', 'injectRedirects');</pre>
+<pre>$hooks->cat('injectRedirects')</pre>
-This hook call is in '''template_top.php''' and shows '''siteWide''', the Group and '''injectRedirects''', the Action.
+This hook call is in '''template_top.php''' and shows '''injectRedirects''' as the Action.
-So it is calling for hooks in the '''/hooks/shop/siteWide/''' directory that are listening for '''injectRedirects'''.
+So it is calling for hooks that are listening for '''injectRedirects'''.
 It can be seen that it is the first hook call in the file and so would allow code to be injected to redirect the page to another.
@@ Line 31: / Line 31: @@
 The next hook call in '''template_top.php''' can be seen between the <head></head> tags:
-<pre>echo $OSCOM_Hooks->call('siteWide', 'injectSiteStart');</pre>
+<pre>$hooks->cat('injectSiteStart')</pre>
 So this would allow code to be injected between those tags.
@@ Line 37: / Line 37: @@
 The next hook call in '''template_top.php''' can be seen just after the <body> tag but before the navigation modules are called:
-<pre>echo $OSCOM_Hooks->call('siteWide', 'injectBodyStart');</pre>
+<pre>$hooks->cat('injectBodyStart')</pre>
 So this would allow code to be injected before the navigation modules.
@@ Line 44: / Line 44: @@
-In the above examples, hooks in the '''/hooks/shop/siteWide''' directory will inject the code into all pages.
+In the above examples, hooks will inject the code into all pages.
@@ Line 61: / Line 61: @@
 As mentioned above, there is an existing hook call that allows code to be injected before the navigation bar:
-<pre>echo $OSCOM_Hooks->call('siteWide', 'injectBodyStart');</pre>
+<pre>$hooks->cat('injectBodyStart')</pre>
 So, we make a hook file to listen for that call.

@@ Line 13: / Line 13: @@
 These hook calls can be seen in
-https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_top.ph
+https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_top.php
 and

@@ Line 15: / Line 15: @@
 https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_top.ph
-an
+and
 https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_bottom.php

@@ Line 11: / Line 11: @@
 There are existing hook calls throughout the core code but a page could be copied and edited to add a hook call and saved to your selected template.
-These hook calls can be seen in https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_top.php and https://github.com/CE-PhoenixCart/PhoenixCart/blob/master/templates/default/includes/components/template_bottom.php as well as in many other specific files in both the admin and shop side.
+These hook calls can be seen in
 The hook calls will look like, for an example: