• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
WordPress a2z

WordPress a2z

WordPress Dynamic API Reference

  • Home
  • Plugins
  • Themes
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / APIs / Akismet_REST_API::set_key() – Set the API key, if possible.

You appear to be a bot. Output may be restricted

Description

Set the API key, if possible.

Usage

$WP_Error|WP_REST_Response = Akismet_REST_API::set_key( $request );

Parameters

$request
( WP_REST_Request ) required –

Returns

WP_Error|WP_REST_Response

Source

File name: akismet/class.akismet-rest-api.php
Lines:

1 to 15 of 15
  public static function set_key( $request ) {
    if ( defined( 'WPCOM_API_KEY' ) ) {
      return rest_ensure_response( new WP_Error( 'hardcoded_key', __( 'This site\'s API key is hardcoded and cannot be changed via the API.', 'akismet' ), array( 'status'=> 409 ) ) );
    }

    $new_api_key = $request->get_param( 'key' );

    if ( ! self::key_is_valid( $new_api_key ) ) {
      return rest_ensure_response( new WP_Error( 'invalid_key', __( 'The value provided is not a valid and registered API key.', 'akismet' ), array( 'status' => 400 ) ) );
    }

    update_option( 'wordpress_api_key', $new_api_key );

    return self::get_key();
  }
 

 View on GitHub View on Trac

Published: 19th December 2019 | Last updated: 19th December 2019

Primary Sidebar

Information

Function name: Akismet_REST_API::set_key
Class ref: Akismet_REST_API
Plugin ref: Akismet
Version: 5.0.1
Sourcefile: class.akismet-rest-api.php
File ref: class.akismet-rest-api.php
Deprecated?: No
API Letters: A,K,R,S

Footer

WordPress a2z
WordPress a2z
WordPress Dynamic API Reference
WordPress 6.1.1. PHP: 8.0.28
WordPress a2z
WordPress core a2z
Genesis Theme Framework a2z
Jetpack a2z
WordPress develop tests
Easy Digital Downloads a2z
WooCommerce a2z
Yoast SEO a2z
WordPress Blocks

Site:  wp-a2z.org
© Copyright WordPress a2z 2014-2023. All rights reserved.


Website designed and developed by Herb Miller
Proudly powered by WordPress and oik plugins

  • Home
  • Blog
  • Sitemap
  • Sites