Search in docs | Osclass Documentation

Introduction to Osclass

What is Osclass? Osclass is a PHP-based web application that allows users to create and manage classifieds websites. Built with a modular architecture, it’s highly extensible and customizable for different business needs. Osclass aims to be user-friendly for both administrators and end-users, while ... 1043 words

General Settings

Below is a simplified reference for the configuration parameters in Osclass under General Settings. All mention of “Description” and “Technical Notes” subheadings has been removed for brevity. Basic Info Page TitleA short, identifying title for your site. Appears in the browser title bar and bookmar... 638 words

Configuration Information

This section displays a concise summary of the most essential aspects of your Osclass setup. When troubleshooting or requesting support, these details help pinpoint possible environmental or configuration issues. By default, it shows high-level information to reduce server load, and you can generate... 676 words

hCategories.php

The hCategories.php helper provides a set of functions for handling categories in Osclass. It allows you to retrieve the current category, obtain the list of categories as a hierarchical tree, count total categories and subcategories, and display category selection fields within forms. Functions Des... 277 words

Backoffice Login

Backoffice Login The Osclass backoffice (admin panel) allows site administrators to manage their website, configure settings, and moderate listings. Backoffice login To access the backoffice, navigate to: For root installations: https://yourdomain.com/oc-admin/ For subdirectory installations: https:... 322 words

Minimum Requirements

Database MySQL: Version 5.6 or later. MariaDB: Version 10.2 or later. PHP Version: PHP 7.4 or later. Extensions: Ensure the following PHP extensions are enabled: mysqli (for MySQL/MariaDB connectivity) gd (for image processing) imagemagick (improved image processing, faster then gd) curl (for extern... 58 words

Dashboard

Dashboard Overview The Dashboard is the first page you see when you log into the Osclass administration panel. It provides an overview of key statistics, recent activity, and important updates about your classifieds website. Accessing the Dashboard To access the Dashboard, log in to your Osclass adm... 388 words

hCurrency.php

The hCurrency.php helper in Osclass provides essential functions for managing currency data. It allows you to retrieve a complete list of available currencies (which is stored in the session) and to fetch detailed currency records by code. These capabilities ensure that your website can correctly di... 85 words

Programming Standards

Osclass PHP Coding Standards & Best Practices Following proper coding standards ensures better maintainability, security, and performance in Osclass development. Below is an improved guide based on best practices observed in the latest Osclass coding style. General Coding Conventions Function Na... 345 words

Data Cleanup

The Cleanup Data section in Osclass allows administrators to efficiently remove outdated, unwanted, or redundant data from their classifieds website. Data cleanup This feature helps optimize database performance, reduce spam, and keep the platform organized. Below is a breakdown of available cleanup... 517 words

Action Logs

Osclass provides a comprehensive action log system that allows administrators to track and manage key activities performed by users and administrators. Action logs These logs help in monitoring suspicious activities, troubleshooting issues, and ensuring better security and accountability within the ... 330 words

Osclass Installation

This section covers the basic installation of Osclass for users who are using shared hosting or a simple server setup. Follow these steps to get your classifieds website up and running quickly. Step 1: Download, Unzip, and Upload Osclass Files To begin, download the latest version of Osclass from th... 436 words

Listings

Managing Listings The Listings (or Items) section in Osclass allows administrators to manage published ads, reported listings, and configure item-related settings. Managing Active Listings The main listings page provides a table with all posted ads. Administrators can: Filter by status (active, pend... 522 words

Email Templates

Email templates in Osclass define the contents of automated messages sent to users. These templates may be created by core or by plugins. They cannot be removed but can be edited to customize wording or localize content. Email templates management Template Listing Title: A descriptive label that oft... 404 words

hDatabaseInfo.php

The hDatabaseInfo.php helper in Osclass provides a set of functions that allow you to retrieve important database connection information. These functions are useful when you need to display, log, or verify your database credentials in a secure manner. Functions Description osc_db_name() – Gets the d... 69 words

Theme Customization

Today, we will take a look how simple are basic modifications of your Osclass theme, plugin or simply layout. We strongly recommend to check some CSS basics before you start with modifications. You may find CSS Cheat Sheet at bottom of this guide. What we are going to do today: Hide unwanted box Cha... 819 words

Debug/Error Log

The Debug/Error Log section in Osclass helps administrators identify and resolve issues related to PHP execution, database queries, and system errors. Error/Debug log By enabling debugging and logging features, you can monitor system performance and diagnose issues efficiently. Debug/Error Log Setti... 317 words

After-Installation Setup

After successfully installing Osclass, there are several important settings and configurations you should review to ensure your classifieds website is fully functional and optimized. This guide will walk you through the key areas to check and configure. We recommend first to setup OsclassPoint API K... 777 words

Comments

Comments and Comment Settings Osclass allows administrators to manage user comments on listings, providing features for moderation, rating, replies, and notifications. Managing Comments Administrators can manage comments by navigating to Listings > Comments. Comments Available actions include: Ap... 233 words

Mail Server

This section lets you adjust how Osclass sends emails (for user registration, password resets, listing inquiries, etc.) and guide you through email server setup and configuration. You can choose a Custom Server or GMail Server, define authentication details, and test the setup. Mail server Server Ty... 439 words

hDefines.php

The hDefines.php helper centralizes all path and URL definitions for an Osclass installation. These functions allow you to quickly retrieve paths for core components (such as libraries, themes, plugins, and uploads) and generate complete URLs for both the public website and the admin panel. Addition... 1339 words

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... 672 words

Query Items (custom listings select)

Displaying Specific Listings Using osc_query_item() Osclass provides a powerful function osc_query_item($params) that allows developers to filter and display listings dynamically based on various criteria. This function supports **multiple filtering options** and can be used to fine-tune the selecti... 646 words

Import SQL Data

Upload Custom SQL File - The SQL file upload tool in Osclass allows administrators to import and execute SQL scripts directly from the backoffice. Import SQL Data This feature is useful for making database modifications such as inserting new data, updating existing records, altering table structures... 426 words

Hooks

A hook is a small piece of code that allows you to insert more code (plugin) in the middle of certain Osclass’ actions. Usage of hooks To use a hook add the following code to your plugin file : osc_add_hook('hook_name', 'function_name', 'priority'); Substitute ‘hook_name’ by the name of the hook you... 11939 words

Custom Fields

Custom Fields in Osclass allow administrators to define additional data fields for listings, making them more specific to certain categories such as real estate, vehicles, or services. Custom fields What are Custom Fields? Custom fields enable you to collect additional information from users when th... 373 words

Media

Configure how your site handles images - media settings. Adjust which uploader library to use, define maximum image dimensions, enable or disable watermarks, and regenerate thumbnails for existing images. Media settings General Settings Image Uploader Library: Choose the technology for handling uplo... 555 words

hErrors.php

The hErrors.php helper provides essential error handling functions for Osclass. These functions are used to immediately stop script execution in case of critical errors and to generate absolute URLs that can be used for redirection or detailed error reporting. Functions Description osc_die($title, $... 100 words

Update Osclass

Keeping your Osclass installation up to date is essential for security, performance, and access to the latest features. There are two ways to upgrade Osclass: automatic and manual. Follow these steps carefully to ensure a smooth upgrade process. Before You Begin Before performing any upgrade, make s... 516 words

Backup Data

Backing up your Osclass data is a crucial task that ensures your classifieds platform remains secure and recoverable in case of data loss, server crashes, or accidental modifications. Backup data This guide explains how to create backups, where they are stored, and best practices for data security. ... 342 words

Filters

A filter is functionality that allows to modify content of particular functions (price format, item title etc.). Function added to filter have 1 input parameter – content that can be modified. Function returns output as modified content. osc_add_filter('filter_name', 'function_name'); Example for fi... 6530 words

Users

User Management and Settings Osclass provides a comprehensive user management system, allowing administrators to control user registrations, account settings, and profile features. Administrators can manage users, enforce validation policies, and configure settings related to usernames, profile visi... 464 words

Spam and Bots

Protect your site from spam and automated scripts by configuring services like Akismet and reCAPTCHA (anti-spam and anti-bot configuraion). These solutions detect suspicious behavior and prompt additional verification to ensure real users can interact with your site. Spam and bots settings Akismet O... 307 words

hItems.php

The hItems.php helper provides a wide range of functions that return objects from the static view class in Osclass. These functions enable you to retrieve the current item, its associated comments, resources, and various meta details. They are essential for building and customizing the display of li... 1346 words

Upgrade Osclass

Keeping your Osclass installation up to date ensures your website remains secure, compatible with the latest technologies, and benefits from new features and improvements. This guide explains how to check for updates and upgrade Osclass safely. Checking for Updates Osclass automatically checks for n... 425 words

Ban Rules

Ban Rules in Osclass allow administrators to block specific users from registering, posting listings, or commenting. This feature is useful for preventing spam, abusive behavior, and fraudulent activity. Managing Ban Rules Administrators can manage ban rules by navigating to Users > Ban Rules. Ba... 280 words

Breadcrumbs

Breadcrumbs help users understand their navigation path. They are typically displayed near the top of each page, showing how the user arrived at their current location (e.g., Home › Category › Listing). Breadcrumbs management Breadcrumb Elements on Listings Page Website (Page) Title: Displays your s... 242 words

hLocale.php

The hLocale.php helper provides a comprehensive set of functions for managing locale settings in Osclass. It enables you to retrieve locale objects, list available locales, count and iterate over enabled locales, and access various locale-specific formatting options (like currency format, decimal po... 296 words

Location & Category Stats

Osclass provides built-in tools to manage and recalculate statistics for locations and categories. These tools help maintain accurate listing counts and ensure smooth operation of your classifieds website. Location Statistics Location statistics show the number of listings associated with each count... 203 words

Alerts

Osclass provides an alerts system that allows users to receive notifications for new listings matching their search criteria. Alerts are also called as saved searches. Administrators can manage user alerts, modify their status, and delete unwanted alerts. Managing Alerts Administrators can manage al... 269 words

Permalinks

By default, Osclass uses URLs with query strings (“?id=123”) that are less readable and less SEO-friendly. Enabling Permalinks lets you replace those with descriptive URLs (e.g., /cars/honda-civic-i123). Doing so can significantly improve your site’s SEO, usability, and future compatibility. Importa... 1310 words

hLocation.php

The hLocation.php helper offers a comprehensive suite of functions to manage location-related data in Osclass. It allows you to retrieve the current country, region, city, and city area, iterate over lists of locations, count available locations, and obtain details such as names and URLs. Additional... 349 words

Enable SSL Certificate

SSL Certificate Configuration (HTTPS) Securing your Osclass installation with an SSL certificate ensures that your website operates over a secure HTTPS connection, encrypting user data and improving SEO rankings. Follow these steps to properly configure SSL on your Osclass website. Step 1: Activate ... 393 words

Maintenance Mode

Maintenance mode is a useful feature in Osclass that temporarily restricts user access to your website while you perform updates, modifications, or fixes. Maintenance mode When maintenance mode is enabled, visitors will see a message informing them that the site is currently undergoing maintenance. ... 456 words

Statistics

Osclass provides a comprehensive statistics module for tracking user activity, listings, comments, and reported content. The statistics dashboard allows administrators to monitor trends over time, assess engagement, and optimize site performance. Statistics Listing Statistics The listing statistics ... 279 words

Latest Searches

This section allows you to control how Osclass logs and retains visitors’ search queries. By keeping track of these terms, you can analyze which keywords users are entering into your site, and potentially optimize content or category structures based on popular searches. Regularly check your databas... 428 words

hMessages.php

The hMessages.php helper offers a suite of functions to manage ephemeral (flash) messages in Osclass. These functions enable you to add various types of messages — such as error, success (ok), informational, and warning — to the session. You can then retrieve and display these messages, ensuring tha... 178 words

Getting Started (5)

Config & Troubleshoot (16)

Administration (41)

Settings (11)

Tools (10)

Features (7)

Developer Guide (36)

Helper Functions (22)

Release Notes (13)

118 results found