klytos-admin-notices

Guide for displaying admin notices in Klytos CMS. Use when showing success, error, warning, or info messages to admin users, implementing flash messages after form submissions, creating persistent warnings that survive page loads, adding conditional notices that auto-hide when conditions change, or handling notice dismissal via AJAX. Also trigger when working with the NoticeManager, transient notices, or the notice.before_render filter.

설치로 이동

저장소: joseconti/klytos
최근 소스 활동: 2026년 4월 3일 14:00
감지된 SKILL.md 언어: 영어
스타: 12
포크: 2

설치 방법

기본적으로 소스를 먼저 확인하는 Prompt가 선택됩니다. 직접 명령으로 전환하거나 로컬 사본을 다운로드할 수도 있습니다.

소스 파일 검토

설치 여부를 결정하기 전에 SKILL.md와 SkillsMP에 표시된 보조 파일을 읽어 보세요.

검색으로 돌아가기 설치로 돌아가기

klytos_add_notice( string $message, string $type = 'info', bool $dismissible = true ): void

// Success message after saving settings.
klytos_add_notice( __( 'settings.saved' ), 'success' );

// Error that cannot be dismissed.
klytos_add_notice( __( 'settings.save_failed' ), 'error', false );

// Info notice.
klytos_add_notice( 'Plugin activated successfully.', 'info' );

// Warning.
klytos_add_notice( 'This action cannot be undone.', 'warning' );

// In your admin page handler (e.g., plugins/my-plugin/admin/settings.php):
if ( $_SERVER['REQUEST_METHOD'] === 'POST' && klytos_verify_csrf() ) {
    $result = save_my_settings( $_POST );
    if ( $result ) {
        klytos_add_notice( __( 'myplugin.settings_saved' ), 'success' );
    } else {
        klytos_add_notice( __( 'myplugin.settings_failed' ), 'error' );
    }
    // Redirect to avoid form resubmission -- notice survives the redirect.
    header( 'Location: ' . $_SERVER['REQUEST_URI'] );
    exit;
}

klytos_add_persistent_notice(
    string $id,
    string $message,
    string $type = 'info',
    bool $dismissible = true,
    array $options = []
): array

Parameter	Type	Default	Description
`$id`	string	--	Unique identifier (slug format)
`$message`	string	--	Plain text message
`$type`	string	`'info'`	`'success'`, `'error'`, `'warning'`, `'info'`
`$dismissible`	bool	`true`	Whether user can close with X button
`$options`	array	`[]`	Optional: `context`, `condition_hook`

Key	Type	Default	Description
`context`	string	`''`	Only show on this admin page (e.g., `'dashboard'`, `'settings'`). Empty = all pages.
`condition_hook`	string	`''`	Filter hook name. Notice only renders when the filter returns `true`.
`ads`	bool	`true`	Whether the notice is advertising. `true` = advertising (default), `false` = system/non-advertising.

// Plugin advertising notice (default ads=true, can be hidden by user).
klytos_add_persistent_notice( 'my-promo', 'Try our premium features!', 'info', true );

// System notice (always visible).
klytos_add_persistent_notice( 'config-warning', 'Missing API key.', 'warning', true, [
    'ads' => false,
] );

// Register a conditional persistent notice.
klytos_add_persistent_notice( 'ssl-missing', 'Your site is not using HTTPS.', 'error', false, [
    'condition_hook' => 'notice.condition.ssl_missing',
] );

// Register the condition filter.
klytos_add_filter( 'notice.condition.ssl_missing', function ( bool $show ): bool {
    return ! isset( $_SERVER['HTTPS'] ) || $_SERVER['HTTPS'] !== 'on';
} );
// Notice auto-hides when HTTPS is enabled -- no code needs to remove it.

// Simple persistent notice (all pages, dismissible).
klytos_add_persistent_notice( 'welcome', 'Welcome to Klytos! Start by creating your first page.', 'info' );

// Page-specific, non-dismissible.
klytos_add_persistent_notice( 'no-pages', 'No pages published yet.', 'warning', false, [
    'context' => 'dashboard',
] );

// Conditional: only shows when a config value is missing.
klytos_add_persistent_notice( 'missing-email', 'Please configure your email settings.', 'warning', true, [
    'context'        => 'settings',
    'condition_hook' => 'notice.condition.missing_email',
] );

klytos_add_filter( 'notice.condition.missing_email', function ( bool $show ): bool {
    $config = klytos_app()->getSiteConfig()->get();
    return empty( $config['email_from'] ?? '' );
} );

klytos_dismiss_notice( string $id ): void

klytos_get_notices( string $currentPage = '' ): array

$manager = klytos_app()->getNoticeManager();

// Create a persistent notice with full control.
$manager->create( [
    'id'             => 'my-notice',
    'message'        => 'Custom notice text.',
    'type'           => 'warning',
    'dismissible'    => true,
    'context'        => 'dashboard',
    'condition_hook' => 'notice.condition.my_custom',
    'ads'            => false, // System notice, always visible.
] );

// Delete a persistent notice from storage entirely.
$manager->delete( 'my-notice' );

// List all persistent notices.
$notices = $manager->list();

// Ensure a system notice exists (idempotent create/update).
$manager->ensureSystemNotice( 'sys-check', [
    'message'     => 'System check warning.',
    'type'        => 'error',
    'dismissible' => false,
] );

Hook	Fired When	Arguments
`notice.created`	Persistent notice created	`array $notice`
`notice.dismissed`	Notice dismissed	`string $id`
`notice.deleted`	Persistent notice deleted	`string $id`
`notice.render.before`	Before rendering notices	`array $notices`
`notice.render.after`	After rendering notices	`array $notices`

Hook	Purpose	Arguments
`notice.transient.add`	Modify transient notice before queuing	`array $notice`
`notice.before_render`	Add/remove/reorder notices before render	`array $notices, string $page`
`notice.render_html`	Customize per-notice HTML output	`string $html, array $notice`
`{condition_hook}`	Control conditional persistent notices	`bool $show`

klytos_add_filter( 'notice.before_render', function ( array $notices, string $page ): array {
    if ( $page === 'settings' ) {
        $notices[] = [
            'id'          => 'plugin-tip',
            'message'     => 'Tip: Configure your social media links below.',
            'type'        => 'info',
            'dismissible' => true,
            'persistent'  => false,
        ];
    }
    return $notices;
} );

Class	Purpose
`.alert`	Base alert styling
`.alert-success`	Green (success tokens)
`.alert-error`	Red (error tokens)
`.alert-warning`	Amber (warning tokens)
`.alert-info`	Blue (info tokens)
`.alert-dismissible`	Flex layout with space for X btn
`.alert-close`	The X dismiss button

// Read the ads toggle.
$showAds = klytos_config( 'notices.show_ads' ); // default: true

// Set programmatically.
klytos_set_config( 'notices', ['show_ads' => false] );

// Flash notice (shown once).
klytos_add_notice( 'Settings saved!', 'success' );

// Persistent notice (survives page loads, advertising by default).
klytos_add_persistent_notice( 'my-warning', 'Check your config.', 'warning' );

// Non-advertising persistent notice (always visible).
klytos_add_persistent_notice( 'sys-check', 'System check required.', 'error', true, [
    'ads' => false,
] );

// Conditional persistent (auto-hides when condition is false).
klytos_add_persistent_notice( 'check-ssl', 'HTTPS not enabled.', 'error', false, [
    'condition_hook' => 'notice.condition.no_ssl',
    'ads'            => false,
] );
klytos_add_filter( 'notice.condition.no_ssl', fn( bool $show ) => ! is_ssl() );

// Dismiss programmatically.
klytos_dismiss_notice( 'my-warning' );

// Delete from storage.
klytos_app()->getNoticeManager()->delete( 'my-warning' );