| [ Index ] |
PHP Cross Reference of GlotPress |
[Source view] [Print] [Project Stats]
(no description)
| File Size: | 706 lines (19 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
| gp_post( $key, $default = '' ) X-Ref |
| Retrieves a value from $_POST. return: string|array Value of `$_POST[ $key ]` if exists or `$default`. param: string $key Name of post value. param: string|array $default Optional. Value to return if `$_POST[ $key ]` doesn't exist. Default empty. |
| gp_get( $key, $default = '' ) X-Ref |
| Retrieves a value from $_GET. return: string|array Value of `$_GET[ $key ]` if exists or `$default`. param: string $key Name of get value. param: string|array $default Optional. Value to return if `$_GET[ $key ]` doesn't exist. Default empty. |
| gp_route_nonce_field( $action, $echo = true ) X-Ref |
| Prints a nonce hidden field for route actions. return: string Nonce field HTML markup. param: int|string $action Action name. param: bool $echo Optional. Whether to display or return hidden form field. Default true. since: 2.0.0 |
| gp_route_nonce_url( $url, $action ) X-Ref |
| Retrieves a URL with a nonce added to URL query for route actions. return: string Escaped URL with nonce action added. param: string $url URL to add nonce action. param: int|string $action Action name. since: 2.0.0 |
| gp_array_get( $array, $key, $default = '' ) X-Ref |
| Retrieves a value from $array return: mixed $array[$key] if exists or $default param: array $array param: string $key name of array value param: mixed $default value to return if $array[$key] doesn't exist. Default is '' |
| gp_const_get( $name, $default = '' ) X-Ref |
| No description |
| gp_const_set( $name, $value ) X-Ref |
| No description |
| gp_member_get( $object, $key, $default = '' ) X-Ref |
| No description |
| gp_array_flatten( $array ) X-Ref |
| Makes from an array of arrays a flat array. return: array flattenned array param: array $array the arra to flatten |
| gp_notice_set( $message, $key = 'notice' ) X-Ref |
| Passes the message set through the next redirect. Works best for edit requests, which want to pass error message or notice back to the listing page. param: string $message The message to be passed. param: string $key Optional. Key for the message. You can pass several messages under different keys. |
| gp_notice( $key = 'notice' ) X-Ref |
| Retrieves a notice message, set by {@link gp_notice()} param: string $key Optional. Message key. The default is 'notice' |
| gp_populate_notices() X-Ref |
| No description |
| gp_array_zip( ...$args ) X-Ref |
| Returns an array of arrays, where the i-th array contains the i-th element from each of the argument arrays. The returned array is truncated in length to the length of the shortest argument array. Previously this function was documented as: The function works only with numerical arrays. However this was incorrect, this function would only return an array of arrays with numeric basic indexes, but would process any array whether it was numeric or reference based, using the order in which the array was created as the index value to return. For example: $first_array[] = "First" $first_array[] = "Second" $first_array[] = "Third" $second_array[0] = "Fourth" $second_array[test] = "Fifth" $second_array[1] = "Sixth" $result = gp_array_zip( $first_array, $second_array ); Would produce: $result[0][0] = "First" $result[0][1] = "Fourth" $result[1][0] = "Second" $result[1][1] = "Fifth" $result[2][0] = "Third" $result[2][1] = "Sixth" Instead of either failing (which is probably what should have happened) or something like: $result[0][0] = "First" $result[0][1] = "Fourth" $result[1][0] = "Second" $result[1][1] = "Sixth" Or some other random result. return: array|false Array on success, false on failure. param: array ...$args Array arguments. |
| gp_array_any( $callback, $array, $arg = null ) X-Ref |
| No description |
| gp_array_all( $callback, $array ) X-Ref |
| No description |
| gp_error_log_dump( $value ) X-Ref |
| No description |
| gp_object_has_var( $object, $var_name ) X-Ref |
| No description |
| gp_has_translation_been_updated( $translation_set, $timestamp = 0 ) X-Ref |
| Has this translation been updated since the passed timestamp? return: bool param: GP_Translation_Set $translation_set Translation to check param: int $timestamp Optional; unix timestamp to compare against. Defaults to HTTP_IF_MODIFIED_SINCE if set. |
| gp_clean_translation_set_cache( $id ) X-Ref |
| Delete translation set counts cache. param: int $id Translation set ID. |
| gp_clean_translation_sets_cache( $project_id ) X-Ref |
| Delete counts cache for all translation sets of a project param: int $project_id project ID |
| gp_is_empty( $value ) X-Ref |
| Checks if the passed value is empty. return: bool param: string $value The value you want to check. |
| gp_is_empty_string( $value ) X-Ref |
| Checks if the passed value is an empty string. return: bool param: string $value The value you want to check. |
| gp_is_not_empty_string( $value ) X-Ref |
| Checks if the passed value isn't an empty string. return: bool param: string $value The value you want to check. |
| gp_is_positive_int( $value ) X-Ref |
| Checks if the passed value is a positive integer. return: bool param: int $value The value you want to check. |
| gp_is_int( $value ) X-Ref |
| Checks if the passed value is an integer. return: bool param: int|string $value The value you want to check. |
| gp_is_null( $value ) X-Ref |
| Checks if the passed value is null. return: bool param: string $value The value you want to check. |
| gp_is_not_null( $value ) X-Ref |
| Checks if the passed value is not null. return: bool param: string $value The value you want to check. |
| gp_is_between( $value, $start, $end ) X-Ref |
| Checks if the passed value is between the start and end value or is the same. return: bool param: string $value The value you want to check. param: string $value The lower value you want to check against. param: string $value The upper value you want to check against. |
| gp_is_between_exclusive( $value, $start, $end ) X-Ref |
| Checks if the passed value is between the start and end value. return: bool param: string $value The value you want to check. |
| gp_is_one_of( $value, $list ) X-Ref |
| Checks if the passed value is one of the values in the list. return: bool param: string $value The value you want to check. param: array $list The list of values you want to check against. since: 3.0.0 |
| gp_is_ascii_string( $value ) X-Ref |
| Checks if the passed value has only ASCII characters. return: bool param: string $value The value you want to check. since: 3.0.0 |
| gp_is_starting_and_ending_with_a_word_character( $value ) X-Ref |
| Checks if the passed value starts and ends with a word character. return: bool param: string $value The value you want to check. since: 3.0.0 |
| gp_set_cookie( $name, ...$args ) X-Ref |
| Acts the same as core PHP setcookie() but its arguments are run through the gp_set_cookie filter. If the filter returns false, setcookie() isn't called. param: string $name The name of the cookie. param: mixed ...$args Additional arguments to be passed to setcookie(). |
| gp_gmt_strtotime( $string ) X-Ref |
| Converts a string represented time/date to a utime int, adding a GMT offset if not found. return: int param: string $string The string representation of the time to convert. since: 1.0.0 |
| gp_get_import_file_format( $selected_format, $filename ) X-Ref |
| Determines the format to use based on the selected format type or by auto detection based on the file name. Used during import of translations and originals. return: object|null A GP_Format child object or null if not found. param: string $selected_format The format that the user selected on the import page. param: string $filename The filname that was uploaded by the user. |
| gp_wp_profile_options( $user ) X-Ref |
| Displays the GlotPress administrator option in the user profile screen for WordPress administrators. param: WP_User $user The WP_User object to display the profile for. since: 2.0.0 |
| gp_wp_profile_options_update( $user_id ) X-Ref |
| Saves the settings for the GlotPress administrator option in the user profile screen for WordPress administrators. param: int $user_id The WordPress user id to save the setting for. since: 2.0.0 |
| gp_get_sort_by_fields() X-Ref |
| Returns a multi-dimensional array with the sort by types, descriptions and SQL query for each. return: array An array of sort by field types. since: 2.1.0 |
| gp_set_translations_import_max_memory_limit() X-Ref |
| Sets the maximum memory limit available for translations imports. return: string The maximum memory limit. since: 3.0.0 |
| Generated: Sun Apr 28 01:01:17 2024 | Cross-referenced by PHPXref 0.7.1 |