translations_api( string $type, array|object $args = null ): array|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$typestring

Type of translations. Accepts 'plugins', 'themes', 'core'.

$argsarray|objectoptional

Translation API arguments. Optional.Default: null

Return value

array|WP_Error

On success an associative array of translations, WP_Error on failure.

• $translationsarray

  List of translations, each an array of data.

  • ...$0array

    @type string $language Language code.

    • $versionstring

      WordPress version.

    • $updatedstring

      Date the translation was last updated, in MySQL datetime format.

    • $english_namestring

      English name of the language.

    • $native_namestring

      Native name of the language.

    • $packagestring

      URL to download the translation package.

    • $isostring[]

      Array of ISO language codes.

    • $stringsarray

      Array of translated strings used in the installation process. }

Performance profile

How much work a call to translations_api() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_remote_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

12–127

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 155.

Plugin surface

2 hooks

Third-party callbacks on 'translations_api', 'translations_api_result' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• httpoutbound HTTP requestwp_remote_post()called directly
• serializeserialisationjson_decode()called directly
• optionnetwork optionget_site_option()one call below translations_api()

Further down the call graph this can also reach cache, query and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 20 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost translations_api() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 2

2 hooks fire while translations_api() runs, in this order:

1. 1
   apply_filters( translations_api )filterline 50 (+14 into the body)

   Allows a plugin to override the WordPress.org Translation Installation API entirely.

2. 2
   apply_filters( translations_api_result )filterline 141 (+105 into the body)

   Filters the Translation Installation API response results.

Uses · 11

• __()Retrieves the translation of $text.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_http_supports()Determines if there is an HTTP Transport that can process this request.
• set_url_scheme()Sets the scheme for a URL.
• wp_get_wp_version()Returns the current WordPress version.
• get_locale()Retrieves the current locale.
• wp_remote_post()Performs an HTTP request using the POST method and returns its response.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_trigger_error()Generates a user-level error/warning/notice/deprecation message.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• WP_Error::__construct()Initializes the error.

Used by · 1

• wp_get_available_translations()Get available translations from the WordPress.org API.

Source code

View on Trac ↗View on GitHub ↗

36function translations_api( $type, $args = null ) {37	if ( ! in_array( $type, array( 'plugins', 'themes', 'core' ), true ) ) {38		return new WP_Error( 'invalid_type', __( 'Invalid translation type.' ) );39	}40 41	/**42	 * Allows a plugin to override the WordPress.org Translation Installation API entirely.43	 *44	 * @since 4.0.045	 *46	 * @param false|array $result The result array. Default false.47	 * @param string      $type   The type of translations being requested.48	 * @param object      $args   Translation API arguments.49	 */50	$res = apply_filters( 'translations_api', false, $type, $args );51 52	if ( false === $res ) {53		$url      = 'http://api.wordpress.org/translations/' . $type . '/1.0/';54		$http_url = $url;55		$ssl      = wp_http_supports( array( 'ssl' ) );56		if ( $ssl ) {57			$url = set_url_scheme( $url, 'https' );58		}59 60		$options = array(61			'timeout' => 3,62			'body'    => array(63				'wp_version' => wp_get_wp_version(),64				'locale'     => get_locale(),65				'version'    => $args['version'], // Version of plugin, theme or core.66			),67		);68 69		if ( 'core' !== $type ) {70			$options['body']['slug'] = $args['slug']; // Plugin or theme slug.71		}72 73		$request = wp_remote_post( $url, $options );74 75		if ( $ssl && is_wp_error( $request ) ) {76			wp_trigger_error(77				__FUNCTION__,78				sprintf(79					/* translators: %s: Support forums URL. */80					__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),81					__( 'https://wordpress.org/support/forums/' )82				) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),83				headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE84			);85 86			$request = wp_remote_post( $http_url, $options );87		}88 89		if ( is_wp_error( $request ) ) {90			$res = new WP_Error(91				'translations_api_failed',92				sprintf(93					/* translators: %s: Support forums URL. */94					__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),95					__( 'https://wordpress.org/support/forums/' )96				),97				$request->get_error_message()98			);99		} else {100			$res = json_decode( wp_remote_retrieve_body( $request ), true );101			if ( ! is_object( $res ) && ! is_array( $res ) ) {102				$res = new WP_Error(103					'translations_api_failed',104					sprintf(105						/* translators: %s: Support forums URL. */106						__( 'An unexpected error occurred. Something may be wrong with WordPress.org or this server&#8217;s configuration. If you continue to have problems, please try the <a href="%s">support forums</a>.' ),107						__( 'https://wordpress.org/support/forums/' )108					),109					wp_remote_retrieve_body( $request )110				);111			}112		}113	}114 115	/**

Changelog

Introduced in 4.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-admin/includes/translation-install.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.