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

Retrieve translations from WordPress Translation API.


Description Description


Parameters Parameters

$type

(string) (Required) Type of translations. Accepts 'plugins', 'themes', 'core'.

$args

(array|object) (Optional) Translation API arguments. Optional.

Default value: null


Top ↑

Return Return

(object|WP_Error) On success an object of translations, WP_Error on failure.


Top ↑

Source Source

File: wp-admin/includes/translation-install.php

19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
function translations_api( $type, $args = null ) {
    include( ABSPATH . WPINC . '/version.php' ); // include an unmodified $wp_version
 
    if ( ! in_array( $type, array( 'plugins', 'themes', 'core' ) ) ) {
        return  new WP_Error( 'invalid_type', __( 'Invalid translation type.' ) );
    }
 
    /**
     * Allows a plugin to override the WordPress.org Translation Installation API entirely.
     *
     * @since 4.0.0
     *
     * @param bool|array  $result The result object. Default false.
     * @param string      $type   The type of translations being requested.
     * @param object      $args   Translation API arguments.
     */
    $res = apply_filters( 'translations_api', false, $type, $args );
 
    if ( false === $res ) {
        $url = $http_url = 'http://api.wordpress.org/translations/' . $type . '/1.0/';
        if ( $ssl = wp_http_supports( array( 'ssl' ) ) ) {
            $url = set_url_scheme( $url, 'https' );
        }
 
        $options = array(
            'timeout' => 3,
            'body'    => array(
                'wp_version' => $wp_version,
                'locale'     => get_locale(),
                'version'    => $args['version'], // Version of plugin, theme or core
            ),
        );
 
        if ( 'core' !== $type ) {
            $options['body']['slug'] = $args['slug']; // Plugin or theme slug
        }
 
        $request = wp_remote_post( $url, $options );
 
        if ( $ssl && is_wp_error( $request ) ) {
            trigger_error(
                sprintf(
                    /* translators: %s: support forums URL */
                    __( '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>.' ),
                    __( 'https://wordpress.org/support/' )
                ) . ' ' . __( '(WordPress could not establish a secure connection to WordPress.org. Please contact your server administrator.)' ),
                headers_sent() || WP_DEBUG ? E_USER_WARNING : E_USER_NOTICE
            );
 
            $request = wp_remote_post( $http_url, $options );
        }
 
        if ( is_wp_error( $request ) ) {
            $res = new WP_Error(
                'translations_api_failed',
                sprintf(
                    /* translators: %s: support forums URL */
                    __( '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>.' ),
                    __( 'https://wordpress.org/support/' )
                ),
                $request->get_error_message()
            );
        } else {
            $res = json_decode( wp_remote_retrieve_body( $request ), true );
            if ( ! is_object( $res ) && ! is_array( $res ) ) {
                $res = new WP_Error(
                    'translations_api_failed',
                    sprintf(
                        /* translators: %s: support forums URL */
                        __( '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>.' ),
                        __( 'https://wordpress.org/support/' )
                    ),
                    wp_remote_retrieve_body( $request )
                );
            }
        }
    }
 
    /**
     * Filters the Translation Installation API response results.
     *
     * @since 4.0.0
     *
     * @param object|WP_Error $res  Response object or WP_Error.
     * @param string          $type The type of translations being requested.
     * @param object          $args Translation API arguments.
     */
    return apply_filters( 'translations_api_result', $res, $type, $args );
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note 1 content
    Contributed by Aurovrata Venet

    This function queries the WP translation database for a given project. For example, the Contact Form 7 plugin maintains its translations here. To find out which translation locales are available, you can use the translations_api function,

    1
    2
    3
    4
    $api = translations_api( 'plugins', array(
        'slug'    => 'contact-form-7',
        'version' => '4.4.1'
    ) );

    This will return an array of available translations for the plugin v4.4.1.

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