WP_REST_Settings_Controller

17class WP_REST_Settings_Controller extends WP_REST_Controller {18 19	/**20	 * Constructor.21	 *22	 * @since 4.7.023	 */24	public function __construct() {25		$this->namespace = 'wp/v2';26		$this->rest_base = 'settings';27	}28 29	/**30	 * Registers the routes for the site's settings.31	 *32	 * @since 4.7.033	 *34	 * @see register_rest_route()35	 */36	public function register_routes() {37 38		register_rest_route(39			$this->namespace,40			'/' . $this->rest_base,41			array(42				array(43					'methods'             => WP_REST_Server::READABLE,44					'callback'            => array( $this, 'get_item' ),45					'args'                => array(),46					'permission_callback' => array( $this, 'get_item_permissions_check' ),47				),48				array(49					'methods'             => WP_REST_Server::EDITABLE,50					'callback'            => array( $this, 'update_item' ),51					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),52					'permission_callback' => array( $this, 'get_item_permissions_check' ),53				),54				'schema' => array( $this, 'get_public_item_schema' ),55			)56		);57	}58 59	/**60	 * Checks if a given request has access to read and manage settings.61	 *62	 * @since 4.7.063	 *64	 * @param WP_REST_Request $request Full details about the request.65	 * @return bool True if the request has read access for the item, otherwise false.66	 */67	public function get_item_permissions_check( $request ) {68		return current_user_can( 'manage_options' );69	}70 71	/**72	 * Retrieves the settings.73	 *74	 * @since 4.7.075	 *76	 * @param WP_REST_Request $request Full details about the request.77	 * @return array|WP_Error Array on success, or WP_Error object on failure.78	 */79	public function get_item( $request ) {80		$options  = $this->get_registered_options();81		$response = array();82 83		foreach ( $options as $name => $args ) {84			/**85			 * Filters the value of a setting recognized by the REST API.86			 *87			 * Allow hijacking the setting value and overriding the built-in behavior by returning a88			 * non-null value.  The returned value will be presented as the setting value instead.89			 *90			 * @since 4.7.091			 *92			 * @param mixed  $result Value to use for the requested setting. Can be a scalar93			 *                       matching the registered schema for the setting, or null to94			 *                       follow the default get_option() behavior.95			 * @param string $name   Setting name (as shown in REST API responses).96			 * @param array  $args   Arguments passed to register_setting() for this setting.