Item Hooks & Variants on Publish Page

Item Publish & Edit Hook Variants - Osclass v8.2.0 introduced multiple category-based hooks for item publishing and editing pages, allowing for greater customization and flexibility. Previously, only one hook was available for these actions, limiting developers to a single injection point at the end of the form. This update provides predefined hook variants that enable precise placement of custom elements on the publish and edit pages.

Predefined Hook Variants

If your theme supports predefined variants, you can use the following hooks:

• Item Publish Page:
  • item_form_top
  • item_form_category
  • item_form_description
  • item_form_price
  • item_form_location
  • item_form_seller
  • item_form_images
  • item_form_hook
  • item_form_buttons
  • item_form_bottom
  • item_form_after
• Item Edit Page:
  • item_edit_top
  • item_edit_category
  • item_edit_description
  • item_edit_price
  • item_edit_location
  • item_edit_seller
  • item_edit_images
  • item_edit_hook
  • item_edit_buttons
  • item_edit_bottom
  • item_edit_after

To use a predefined variant, simply hook your function to it:

osc_add_hook('item_form_category', 'your_function_name');
osc_add_hook('item_edit_category', 'your_function_name');

Warning: Each hook variant generates an AJAX call. It is not recommended to use all hooks simultaneously.

Using Hooks in Theme Files

The following functions are used to process hooks on the item publish and edit pages:

// Function for the item publish page
ItemForm::plugin_post_item();

// Function for the item edit page
ItemForm::plugin_edit_item();

Custom Hook Variants

Developers can create custom hook variants using parameters in the functions above:

• $hook_variant: Allows for a custom hook name using the format item_form_{variant} and item_edit_{variant}.
• $param_variant: Passes a custom parameter value to item_form and item_edit hooks using the parameter name variant.

Example: Creating a Category-Based Hook

Suppose you want to add a new section after category selection without modifying existing functions. Follow these steps:

1) Define the Custom Function

function my_custom_func($catId) {
  echo '<div style="padding:15px;background:#ccc;display:inline-block;width:100%;margin-bottom:10px;">';
  echo 'Category ID is: ' . $catId;
  echo '</div>';
}

2) Hook the Function to Custom Variants

osc_add_hook('item_form_vcategory', 'my_custom_func');
osc_add_hook('item_edit_vcategory', 'my_custom_func');

3) Modify Your Theme’s item-post.php

Locate the category box and add the following code beneath it:

<?php
  if(Params::getParam('action') == 'item_edit') {
    ItemForm::plugin_edit_item('vcategory');
  } else {
    ItemForm::plugin_post_item('vcategory');
  }
?>

Alternatively, use a new design hook (if supported by your theme):

osc_add_hook('item_publish_category', function() {
  if(Params::getParam('action') == 'item_edit') {
    ItemForm::plugin_edit_item('vcategory');
  } else {
    ItemForm::plugin_post_item('vcategory');
  }
});

4) Complete Code for functions.php

function my_custom_func($catId) {
  echo '<div style="padding:15px;background:#ccc;display:inline-block;width:100%;margin-bottom:10px;">';
  echo 'Category ID is: ' . $catId;
  echo '</div>';
}

osc_add_hook('item_form_vcategory', 'my_custom_func');
osc_add_hook('item_edit_vcategory', 'my_custom_func');

osc_add_hook('item_publish_category', function() {
  if(Params::getParam('action') == 'item_edit') {
    ItemForm::plugin_edit_item('vcategory');
  } else {
    ItemForm::plugin_post_item('vcategory');
  }
});

After implementing this, the custom category-based section will be visible on the item publish and edit pages.

Using Parameter Variants

Parameter variants allow for the customization of existing functions without defining new hooks. Instead, the variant parameter is used:

Params::getParam('variant')

By default, it returns an empty string unless a value is passed.

Example Usage:

if(Params::getParam('action') == 'item_edit') {
  ItemForm::plugin_edit_item('', 'pcategory');
} else {
  ItemForm::plugin_post_item('', 'pcategory');
}

Important: Hook variants and parameter variants cannot be used together. If both are present, the hook variant takes priority, and the parameter variant is ignored.

Conclusion

The new hook system in Osclass v8.2.0 provides much-needed flexibility in modifying the item publish and edit forms. By leveraging predefined hooks, custom hook variants, and parameter variants, developers can fine-tune the behavior of these forms without interfering with existing functions.