Astra_Get_Header_Builder_Design::configure()

Configure the ability.


Description


Return

(void)


Source

File: inc/abilities/customizer/header/class-astra-get-header-builder-design.php

	public function configure() {
		$this->id          = 'astra/get-header-builder-design';
		$this->label       = __( 'Get Astra Header Builder Design Options', 'astra' );
		$this->description = __( 'Retrieves design options for Astra header builder sections (above, primary, below) including background, border color, border size, padding and margin.', 'astra' );
		$this->category    = 'astra';

		$this->meta = array(
			'tool_type'   => 'read',
			'constraints' => array(
				'usage_hints' => array(
					'section'               => 'Optional. Specify "above", "primary", or "below" to get design for specific section. If omitted, returns all sections. When user says "header design" without specifying section, omit this parameter to show all sections. When user says "primary header design" or clearly wants one section, use that specific section.',
					'background'            => 'Responsive background object with desktop/tablet/mobile keys. Each device contains: background-color (CSS color), background-image (URL), background-repeat (repeat/no-repeat/repeat-x/repeat-y), background-position (CSS position), background-size (auto/cover/contain), background-attachment (scroll/fixed), background-media (media ID), background-type (color/image/gradient), overlay-type (color/gradient), overlay-color (CSS color), overlay-gradient (CSS gradient). Primary header typically has solid background color, above/below may use gradients or images.',
					'border_color'          => 'Bottom border color in CSS color format (hex, rgba, color name, or empty string if not set). Adds visual separation line below header section. Common for primary header to separate from page content.',
					'border_size'           => 'Bottom border thickness in pixels (0-10). Value of 0 means no border. Commonly used values: 1px (subtle), 2px (standard). Smaller range than footer (0-10 vs 0-600) as headers need subtler borders.',
					'padding'               => 'Responsive spacing object with desktop/tablet/mobile keys, each containing top/right/bottom/left values (numeric with unit), plus desktop-unit/tablet-unit/mobile-unit (px/em/rem/%). Controls internal spacing of header section. Primary header padding affects logo/menu spacing. Common values: 10-30px vertical padding for compact headers, 20-60px for spacious headers.',
					'margin'                => 'Responsive spacing object with desktop/tablet/mobile keys, each containing top/right/bottom/left values (numeric with unit), plus desktop-unit/tablet-unit/mobile-unit (px/em/rem/%). Controls external spacing around header section. Less commonly used than padding for headers. Usually 0 for sticky headers.',
					'response_presentation' => 'When presenting results to user, provide a clear summary of the design settings for the requested section(s). Include: 1) Background settings (color/image/gradient if set), 2) Border configuration (color and size if present), 3) Padding values (especially for primary header which affects header height), 4) Notable responsive differences (tablet/mobile if different from desktop). Example: "Primary header: White background, 1px light gray bottom border, 15px top/bottom padding (compact header style). Mobile padding reduced to 10px."',
				),
			),
		);
	}

User Contributed Notes

You must log in before being able to contribute a note or feedback.