Danh sách Template Tags và Hàm Helper trong PolyCMS cho RISE CRM
PolyCMS cho RISE CRM tích hợp sẵn thư viện phong phú gồm các template tags và hàm helper chống xung đột trong thư mục plugins/polycms/Helpers/. Lập trình viên theme và plugin có thể sử dụng trực tiếp các hàm này để sinh đường dẫn permalink động, đọc và lưu tùy chọn CMS, kiểm tra phân quyền RBAC của RISE CRM, lọc sạch mã HTML, kết xuất menu, widget và các thẻ SEO chuẩn mà không lo đụng tên với các plugin khác.
Các hàm Helper gốc chống xung đột cho RISE CRM
Được định nghĩa trong plugins/polycms/Helpers/polycms_rise_compat_helper.php, nhóm hàm mang tiền tố polycms_* giúp mã nguồn tương thích hoàn toàn với CodeIgniter 4 của RISE CRM đồng thời tránh xung đột khi cài cùng các plugin khác.
Nhóm hàm Instance, Định tuyến và Lưu trữ
| Hàm | Cú pháp | Chức năng |
|---|---|---|
polycms_ci() |
polycms_ci() |
Trả về đối tượng tương thích dùng chung (db, load, input, uri, session, lang, staff_model) |
polycms_admin_url() |
polycms_admin_url($uri = '') |
Tạo URL trang quản trị RISE CRM (ví dụ: polycms_admin_url('polycms/posts')) |
polycms_site_url() |
polycms_site_url($uri = '') |
Tạo URL công khai thông qua get_uri() của RISE CRM |
polycms_upload_base_url() |
polycms_upload_base_url($sub = '') |
Trả về URL công khai bên trong thư mục files/polycms/ |
polycms_upload_base_path() |
polycms_upload_base_path($sub = '') |
Trả về đường dẫn tuyệt đối trên ổ đĩa tới files/polycms/ |
polycms_writable_path() |
polycms_writable_path($sub = '') |
Trả về đường dẫn ghi riêng tư trong writable/polycms/ (cache, rate_limit, backups, htmlpurifier) |
polycms_module_dir_path() |
polycms_module_dir_path('polycms', $concat = '') |
Trả về đường dẫn thư mục vật lý trong plugins/polycms/ |
polycms_module_dir_url() |
polycms_module_dir_url('polycms', $concat = '') |
Trả về URL công khai tới tài nguyên trong plugins/polycms/ |
polycms_redirect() |
polycms_redirect($uri = '', $method = 'auto', $code = 302) |
Chuyển hướng an toàn qua HTTP header hoặc dự phòng bằng JavaScript |
$admin_posts_url = polycms_admin_url('polycms/posts');
$public_home_url = polycms_site_url('home');
$media_url = polycms_upload_base_url('2026/05/hero-banner.webp');
$cache_dir = polycms_writable_path('cache');
Nhóm hàm Cấu hình, Xác thực, Phân quyền RBAC và Làm sạch HTML
| Hàm | Cú pháp | Chức năng |
|---|---|---|
polycms_get_option() |
polycms_get_option(string $name, $default = '') |
Đọc giá trị từ {prefix}blog_settings (có cache theo request) và dự phòng sang bảng settings của RISE (app_title, date_format, time_format, timezone, language) |
polycms_update_option() |
polycms_update_option(string $name, $value): bool |
Thêm mới hoặc cập nhật tùy chọn trong {prefix}blog_settings và làm mới bộ đệm |
polycms_add_option() |
polycms_add_option(string $name, $value = ''): bool |
Chỉ ghi mới tùy chọn nếu khóa chưa tồn tại |
polycms_staff_can() |
polycms_staff_can(string $capability, string $feature = 'polycms', $staff_id = null): bool |
Kiểm tra quyền RBAC của RISE (view, create, edit, delete, settings); luôn trả về true cho Admin hoặc vai trò có toàn quyền cài đặt |
polycms_is_admin() |
polycms_is_admin($staff_id = 0): bool |
Kiểm tra nhân viên hiện tại hoặc theo ID có phải quản trị viên RISE hay không |
polycms_is_staff_logged_in() |
polycms_is_staff_logged_in(): bool |
Kiểm tra có phiên đăng nhập nhân viên RISE CRM đang hoạt động hay không |
polycms_is_client_logged_in() |
polycms_is_client_logged_in(): bool |
Kiểm tra có phiên đăng nhập khách hàng RISE CRM hay không |
polycms_html_purify() |
polycms_html_purify($html): string |
Làm sạch mã HTML bằng thư viện vendor/ezyang/htmlpurifier đi kèm plugin (cache tại writable/polycms/htmlpurifier/) |
polycms_set_alert() |
polycms_set_alert(string $type, string $message): void |
Hiển thị thông báo flash Bootstrap 5 trong trang quản trị (success, danger, warning, info) |
polycms_log_activity() |
polycms_log_activity(string $description): void |
Ghi nhật ký mang tiền tố [PolyCMS] vào log của CodeIgniter 4 |
polycms_csrf_field() |
polycms_csrf_field(): string |
Xuất thẻ input ẩn chứa mã CSRF token hợp lệ của RISE CRM |
polycms_l() |
polycms_l(string $key, $args = ''): string |
Dịch chuỗi ngôn ngữ từ 16 gói ngôn ngữ trong plugins/polycms/Language/ và dự phòng về app_lang() của RISE |
// Đọc và lưu tùy chọn CMS an toàn
$per_page = (int) polycms_get_option('polycms_posts_per_page', 10);
polycms_update_option('polycms_custom_banner_enabled', '1');
// Kiểm tra quyền RBAC RISE CRM trước khi hiển thị nút thao tác
if (polycms_staff_can('edit', 'polycms')) {
echo '<a href="' . polycms_admin_url('polycms/posts/add') . '" class="btn btn-primary">Viết bài mới</a>';
}
// Làm sạch HTML người dùng gửi lên trước khi lưu
$clean_html = polycms_html_purify($raw_html);
Các hàm xử lý URL và Tài nguyên Asset
Nằm trong plugins/polycms/Helpers/polycms_core_helper.php, các hàm này tự động tuân thủ tiền tố blog và cấu trúc đường dẫn tĩnh trong PolyCMS > Permalinks.
polycms_blog_url($path = '') và polycms_get_blog_url()
Trả về đường dẫn gốc của khu vực blog kèm phần mở rộng tùy chọn, hoặc đường dẫn trang chủ blog đã chuẩn hóa dấu gạch chéo cuối.
$blog_home = polycms_get_blog_url();
// Ví dụ: https://yourdomain.com/blog/
$search_url = polycms_blog_url('search');
// Ví dụ: https://yourdomain.com/blog/search
polycms_get_post_permalink($post) và polycms_get_page_permalink($page)
Sinh đường dẫn tĩnh đầy đủ cho bài viết (tương ứng cấu trúc %postname%, %year%/%monthnum%/%postname% hoặc cấu trúc tùy biến) và cho trang tĩnh đặt ở cấp gốc tên miền.
$post_url = polycms_get_post_permalink($post);
// Ví dụ: https://yourdomain.com/blog/bat-dau-voi-rise-crm/
$page_url = polycms_get_page_permalink($page);
// Ví dụ: https://yourdomain.com/gioi-thieu/
polycms_get_category_url($category) và polycms_get_tag_url($tag)
Sinh đường dẫn lưu trữ theo category_base và tag_base đang cấu hình.
$cat_url = polycms_get_category_url($category);
// Ví dụ: https://yourdomain.com/blog/category/cap-nhat-san-pham/
$tag_url = polycms_get_tag_url($tag);
// Ví dụ: https://yourdomain.com/blog/tag/tu-dong-hoa/
polycms_asset_url($path, $module = 'polycms') và polycms_asset_path($path, $module = 'polycms')
Tự động ánh xạ đường dẫn phát triển trong assets/ sang gói nén Webpack tại dist/assets/ (.min.js / .min.css), đồng thời tự động quay về tệp gốc nếu bản nén chưa tồn tại.
$script_url = polycms_asset_url('plugins/mtbuilder/assets/js/builder.js');
// Trả về: https://yourdomain.com/plugins/polycms/plugins/mtbuilder/dist/assets/js/builder.min.js
Truy xuất và Định dạng Dữ liệu Nội dung
Truy vấn Model thông qua polycms_ci()
Trong theme, widget, shortcode hoặc plugin tùy biến, hãy gọi các model lõi qua polycms_ci():
$CI = &polycms_ci();
$CI->load->model('polycms/Blog_post_model');
$CI->load->model('polycms/Blog_category_model');
$CI->load->model('polycms/Blog_tag_model');
// Lấy chi tiết một bài viết theo ID
$post = $CI->Blog_post_model->get_by_id(42);
// Lấy danh sách bài viết đã xuất bản theo chuyên mục
$posts = $CI->Blog_post_model->get([
'status' => 'published',
'category_id' => 5,
'limit' => 10,
'sort_by' => 'published_at',
'sort_order' => 'DESC',
]);
// Lấy cây chuyên mục phân cấp và toàn bộ thẻ tag
$category_tree = $CI->Blog_category_model->get_tree();
$all_tags = $CI->Blog_tag_model->get();
polycms_get_post_excerpt($post, $length = 150)
Trả về đoạn trích văn bản thuần đã giải mã thực thể HTML, cắt gọn đúng ranh giới từ, chạy qua bộ lọc polycms_post_excerpt và tự động ẩn nội dung đối với bài viết bảo vệ bằng mật khẩu.
echo html_escape(polycms_get_post_excerpt($post, 160));
polycms_get_post_meta($post)
Trả về mảng siêu dữ liệu của bài viết (author, author_id, published_at, created_at, updated_at, views_count, category_id, category_name, tags) sau khi đi qua bộ lọc polycms_post_meta.
$meta = polycms_get_post_meta($post);
echo html_escape($meta['author']);
Hàm định dạng Ngày giờ, Slug, Breadcrumb và Phân trang
// Tự động theo cài đặt Localization của PolyCMS (dự phòng sang RISE CRM)
$formatted_date = polycms_format_date($post->published_at);
$formatted_datetime = polycms_format_datetime($post->published_at, true);
// Tạo slug thân thiện URL (hỗ trợ chuyển đổi dấu tiếng Việt đầy đủ)
$slug = polycms_generate_slug('Hướng dẫn tích hợp RISE CRM 2026');
// Tạo breadcrumb và thanh phân trang
$crumbs = polycms_get_breadcrumb([['title' => $post->title, 'url' => '']]);
$pager = polycms_generate_pagination($current_page, $total_pages, polycms_get_blog_url());
Các hàm Kết xuất Giao diện (Rendering)
polycms_render_menu($location, $args = []) và polycms_get_menu($location)
Kết xuất menu điều hướng nhiều cấp được gán cho vị trí chỉ định (như 'main', 'footer'), hoặc trả về đối tượng menu cùng danh sách items để tự định dạng HTML.
polycms_render_menu('main', [
'wrapper_class' => 'nav-menu',
'item_class' => 'nav-link',
'submenu_class' => 'submenu',
'has_submenu_class' => 'has-submenu',
'echo' => true,
]);
polycms_render_widget_area($area_id, $args = [])
Kết xuất toàn bộ widget đang kích hoạt thuộc một khu vực widget (ví dụ 'sidebar' hoặc 'footer').
polycms_render_widget_area('sidebar', [
'before_widget' => '<div class="sidebar-widget mb-4">',
'after_widget' => '</div>',
'before_title' => '<h3 class="widget-title">',
'after_title' => '</h3>',
]);
polycms_do_shortcode($content)
Phân tích và thực thi toàn bộ mã [shortcode] đã đăng ký trong chuỗi nội dung.
$rendered_html = polycms_do_shortcode($post->content);
polycms_render_admin_bar()
Hiển thị thanh công cụ nổi ở đầu trang frontend dành cho nhân sự RISE CRM đang đăng nhập (kèm lối tắt sửa bài, mở MTBuilder và xóa bộ đệm trang).
if (function_exists('polycms_render_admin_bar')) {
polycms_render_admin_bar();
}
Các hàm SEO
Được định nghĩa trong plugins/polycms/Helpers/polycms_core_helper.php, nhóm hàm SEO tự động khử mã độc toàn bộ thuộc tính và áp dụng bộ lọc tương ứng:
echo polycms_get_seo_meta_tags([
'title' => $post->meta_title ?: $post->title,
'description' => $post->meta_description ?: polycms_get_post_excerpt($post, 155),
'keywords' => $post->meta_keywords ?? '',
'canonical' => polycms_get_post_permalink($post),
'robots' => 'index, follow',
]);
echo polycms_get_open_graph_tags([
'title' => $post->title,
'description' => polycms_get_post_excerpt($post, 155),
'image' => $featured_image_url,
'url' => polycms_get_post_permalink($post),
'type' => 'article',
]);
echo polycms_get_twitter_card_tags([
'card' => 'summary_large_image',
'title' => $post->title,
'description' => polycms_get_post_excerpt($post, 155),
'image' => $featured_image_url,
]);
Các hàm Theme và Thẻ điều kiện ngữ cảnh
Định nghĩa trong plugins/polycms/Helpers/theme_api_helper.php và polycms_template_helper.php:
| Hàm | Mô tả |
|---|---|
polycms_head() |
Gọi polycms_enqueue_scripts, xuất CSS đã đăng ký và kích hoạt polycms_wp_head |
polycms_footer() |
Xuất JS chân trang đã đăng ký và kích hoạt polycms_wp_footer |
polycms_body_class($extra = '') |
Sinh danh sách lớp CSS theo ngữ cảnh trang (is-homepage, is-single, is-page, is-category, theme-{slug}) |
polycms_theme_url($slug, $path = '') |
Trả về URL bên trong thư mục plugins/polycms/themes/{slug}/ |
polycms_theme_path($slug, $path = '') |
Trả về đường dẫn vật lý bên trong thư mục theme |
polycms_get_active_theme() |
Trả về bản ghi cơ sở dữ liệu của theme đang kích hoạt |
polycms_get_active_theme_slug() |
Trả về chuỗi slug của theme đang hoạt động |
polycms_get_theme_option($key, $default = null) |
Lấy giá trị cấu hình lưu tại Appearance > Theme Options |
polycms_locate_template($name, $context = []) |
Tìm tệp template theo thứ tự theme con -> theme cha -> mặc định plugin |
polycms_get_template_part($slug, $name = null, $args = []) |
Nhúng một phần giao diện tái sử dụng kèm biến truyền vào |
polycms_is_home(), polycms_is_single(), polycms_is_page(), polycms_is_category(), polycms_is_tag(), polycms_is_author(), polycms_is_search(), polycms_is_archive() |
Nhóm hàm kiểm tra ngữ cảnh trang đang hiển thị trong template |
$logo_url = polycms_get_theme_option('site_logo', '');
$posts_per_row = (int) polycms_get_theme_option('posts_per_row', 2);
if (polycms_is_single()) {
polycms_get_template_part('partials/share-buttons', null, ['post' => $post]);
}
Các hàm Hook và Shortcode
polycms_add_action($hook, $callback, $priority = 10, $args = 1)- Đăng ký callback cho action hook.polycms_add_filter($hook, $callback, $priority = 10, $args = 1)- Đăng ký callback cho filter hook.polycms_do_action($hook, ...$args)- Kích hoạt toàn bộ callback của action.polycms_apply_filters($hook, $value, ...$args)- Đưa dữ liệu đi qua các filter đã đăng ký.polycms_register_shortcode($tag, $callback)- Đăng ký shortcode mới.polycms_unregister_shortcode($tag)- Hủy đăng ký shortcode hiện có.
Xem chi tiết tại Tài liệu tham khảo đầy đủ về Hooks và Filters.
Các hàm Bảo mật và Tiện ích
Định nghĩa trong plugins/polycms/Helpers/polycms_security_helper.php và polycms_core_helper.php:
| Hàm | Mô tả |
|---|---|
polycms_validate_file_path($path, $base_dir = null) |
Kiểm tra realpath(), chặn null byte, ký tự .. và truy cập ngoài thư mục cho phép |
polycms_safe_include($file_path, $base_dir = null, $vars = []) |
Kiểm duyệt đường dẫn tệp .php an toàn trước khi nạp kèm dữ liệu |
polycms_sanitize_filename($filename) |
Chuẩn hóa tên tệp tin an toàn để lưu trữ trên đĩa |
polycms_safe_output($value, $context = 'html') |
Khử mã độc đầu ra theo ngữ cảnh 'html', 'attr', 'url' hoặc 'js' |
polycms_purify_content($content) |
Chạy polycms_html_purify() kết hợp loại bỏ thẻ script và thuộc tính sự kiện nội dòng |
polycms_check_permission($action, $resource = 'polycms', $log = false) |
Kiểm tra quyền RBAC RISE CRM êm ái, không tạo log rác khi kết xuất sidebar |
polycms_require_permission($action, $resource = 'polycms') |
Bắt buộc kiểm tra quyền RBAC và chặn truy cập nếu thiếu quyền |
polycms_clear_cache() |
Xóa sạch bộ đệm HTML frontend tại writable/polycms/cache/ |
polycms_table_sort_link($sort_key, $label, $sort_by, $sort_order) |
Tạo liên kết sắp xếp cột tiêu đề cho các bảng quản trị PolyCMS |
Hỗ trợ kỹ thuật cho Lập trình viên
Nếu bạn cần tư vấn sử dụng các template tags hoặc hàm tương thích RISE CRM khi phát triển theme và plugin, hãy liên hệ trên trang danh mục sản phẩm PolyXGO tại CodeCanyon. Tất cả khách hàng sử dụng PolyCMS đều được hỗ trợ kỹ thuật hoàn toàn miễn phí.
Tài liệu liên quan
- Xây dựng Theme tùy biến cho PolyCMS - Áp dụng template tags vào từng tệp giao diện.
- Xây dựng Plugin tùy biến cho PolyCMS - Sử dụng các hàm helper và API tùy chọn trong plugin.
- Tạo Shortcode tùy biến trong PolyCMS - Xây dựng các thành phần nội dung động tái sử dụng cho biên tập viên.
- Tài liệu tham khảo đầy đủ về Hooks và Filters - Tra cứu toàn bộ hook PolyCMS và RISE CRM.