View Code - 20260722

class-astra-get-scroll-to-top.php | 20260722_120325.php Initial Domain Snapshot

<?php
/**
 * Get Scroll to Top Settings Ability
 *
 * @package Astra
 * @subpackage Abilities
 * @since 4.13.0
 */

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Class Astra_Get_Scroll_To_Top
 */
class Astra_Get_Scroll_To_Top extends Astra_Abstract_Ability {
	/**
	 * Configure the ability.
	 *
	 * @return void
	 */
	public function configure() {
		$this->id          = 'astra/get-scroll-to-top';
		$this->label       = __( 'Get Astra Scroll to Top Settings', 'astra' );
		$this->description = __( 'Retrieves the current Astra theme scroll-to-top button settings including enable state, position, device visibility, icon size, colors, and border radius.', 'astra' );
		$this->category    = 'astra';
	}

/**
	 * Get output schema.
	 *
	 * @return array
	 */
	public function get_output_schema() {
		return $this->build_output_schema(
			array(
				'enabled'          => array(
					'type'        => 'boolean',
					'description' => 'Whether the scroll-to-top button is enabled.',
				),
				'position'         => array(
					'type'        => 'string',
					'description' => 'Button position (left or right).',
				),
				'on_devices'       => array(
					'type'        => 'string',
					'description' => 'Device visibility (both, desktop, or mobile).',
				),
				'icon_size'        => array(
					'type'        => 'integer',
					'description' => 'Icon size in pixels.',
				),
				'colors'           => array(
					'type'        => 'object',
					'description' => 'Color settings (icon, background, hover variants).',
				),
				'border_radius'    => array(
					'type'        => 'object',
					'description' => 'Border radius settings.',
				),
				'available_positions' => array(
					'type'        => 'object',
					'description' => 'Available position options.',
				),
				'available_devices'   => array(
					'type'        => 'object',
					'description' => 'Available device visibility options.',
				),
			)
		);
	}

/**
	 * Get examples.
	 *
	 * @return array
	 */
	public function get_examples() {
		return array(
			'get scroll to top settings',
			'show scroll to top button configuration',
			'is scroll to top enabled',
			'get scroll to top colors',
			'show scroll to top position',
			'view back to top button settings',
		);
	}

/**
	 * Execute the ability.
	 *
	 * @param array $args Input arguments.
	 * @return array Result array.
	 */
	public function execute( $args ) {
		if ( ! defined( 'ASTRA_THEME_SETTINGS' ) ) {
			return Astra_Abilities_Response::error(
				__( 'Astra theme is not active.', 'astra' ),
				__( 'Please activate the Astra theme to use this feature.', 'astra' )
			);
		}

$colors = array(
			'icon_color'       => astra_get_option( 'scroll-to-top-icon-color', '' ),
			'icon_bg_color'    => astra_get_option( 'scroll-to-top-icon-bg-color', '' ),
			'icon_h_color'     => astra_get_option( 'scroll-to-top-icon-h-color', '' ),
			'icon_h_bg_color'  => astra_get_option( 'scroll-to-top-icon-h-bg-color', '' ),
		);

$position_labels = array(
			'right' => 'Right',
			'left'  => 'Left',
		);

$device_labels = array(
			'both'    => 'Both (Desktop & Mobile)',
			'desktop' => 'Desktop Only',
			'mobile'  => 'Mobile Only',
		);

return Astra_Abilities_Response::success(
			__( 'Retrieved scroll-to-top settings successfully.', 'astra' ),
			array(
				'enabled'             => (bool) astra_get_option( 'scroll-to-top-enable', true ),
				'position'            => astra_get_option( 'scroll-to-top-icon-position', 'right' ),
				'on_devices'          => astra_get_option( 'scroll-to-top-on-devices', 'both' ),
				'icon_size'           => absint( astra_get_option( 'scroll-to-top-icon-size', 15 ) ),
				'colors'              => $colors,
				'border_radius'       => astra_get_option( 'scroll-to-top-icon-radius-fields', array() ),
				'available_positions' => $position_labels,
				'available_devices'   => $device_labels,
			)
		);
	}
}

Astra_Get_Scroll_To_Top::register();