polylang / include / functions.php

functions.php in Polylang 2.8.4, at include/functions.php

155 lines 5.0 KB

Raw Download Zip

1	<?php
2	/**
3	* @package Polylang
4	*/
5
6	/**
7	* Define wordpress.com VIP equivalent of uncached functions
8	* WordPress backward compatibility functions
9	* and miscellaneous utility functions
10	*/
11
12	if ( ! function_exists( 'wpcom_vip_get_page_by_title' ) ) {
13	/**
14	* Retrieve a page given its title.
15	*
16	* @since 2.0
17	*
18	* @param string $page_title Page title
19	* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N. Default OBJECT
20	* @param string\|array $post_type Optional. Post type or array of post types. Default 'page'.
21	* @return WP_Post\|array\|null WP_Post (or array) on success, or null on failure.
22	*/
23	function wpcom_vip_get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
24	return get_page_by_title( $page_title, $output, $post_type ); // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.get_page_by_title_get_page_by_title
25	}
26	}
27
28	if ( ! function_exists( 'wpcom_vip_get_page_by_path' ) ) {
29	/**
30	* Retrieves a page given its path.
31	*
32	* @since 2.8.3
33	*
34	* @param string $page_path Page path.
35	* @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
36	* a WP_Post object, an associative array, or a numeric array, respectively. Default OBJECT.
37	* @param string\|array $post_type Optional. Post type or array of post types. Default 'page'.
38	* @return WP_Post\|array\|null WP_Post (or array) on success, or null on failure.
39	*/
40	function wpcom_vip_get_page_by_path( $page_path, $output = OBJECT, $post_type = 'page' ) {
41	return get_page_by_path( $page_path, $output, $post_type ); // phpcs:ignore WordPressVIPMinimum.Functions.RestrictedFunctions.get_page_by_path_get_page_by_path
42	}
43	}
44
45	if ( ! function_exists( 'wp_doing_ajax' ) ) {
46	/**
47	* Determines whether the current request is a WordPress Ajax request.
48	* Backward compatibility function for WP < 4.7
49	*
50	* @since 2.2
51	*
52	* @return bool True if it's a WordPress Ajax request, false otherwise.
53	*/
54	function wp_doing_ajax() {
55	/** This filter is documented in wp-includes/load.php */
56	return apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX );
57	}
58	}
59
60	if ( ! function_exists( 'wp_doing_cron' ) ) {
61	/**
62	* Determines whether the current request is a WordPress cron request.
63	* Backward compatibility function for WP < 4.8
64	*
65	* @since 2.6
66	*
67	* @return bool True if it's a WordPress cron request, false otherwise.
68	*/
69	function wp_doing_cron() {
70	/** This filter is documented in wp-includes/load.php */
71	return apply_filters( 'wp_doing_cron', defined( 'DOING_CRON' ) && DOING_CRON );
72	}
73	}
74
75	if ( ! function_exists( 'wp_using_themes' ) ) {
76	/**
77	* Determines whether the current request should use themes.
78	* Backward compatibility function for WP < 5.1
79	*
80	* @since 2.6
81	*
82	* @return bool True if themes should be used, false otherwise.
83	*/
84	function wp_using_themes() {
85	/** This filter is documented in wp-includes/load.php */
86	return apply_filters( 'wp_using_themes', defined( 'WP_USE_THEMES' ) && WP_USE_THEMES );
87	}
88	}
89
90	/**
91	* Determines whether we should load the cache compatibility
92	*
93	* @since 2.3.8
94	*
95	* return bool True if the cache compatibility must be loaded
96	*/
97	function pll_is_cache_active() {
98	/**
99	* Filters whether we should load the cache compatibility
100	*
101	* @since 2.3.8
102	*
103	* @bool $is_cache True if a known cache plugin is active
104	* incl. WP Fastest Cache which doesn't use WP_CACHE
105	*/
106	return apply_filters( 'pll_is_cache_active', ( defined( 'WP_CACHE' ) && WP_CACHE ) \|\| defined( 'WPFC_MAIN_PATH' ) );
107	}
108
109	/**
110	* Get the the current requested url
111	*
112	* @since 2.6
113	*
114	* @return string Requested url
115	*/
116	function pll_get_requested_url() {
117	if ( isset( $_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'] ) ) {
118	return set_url_scheme( esc_url_raw( wp_unslash( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ) ) );
119	}
120
121	/*
122	* In WP CLI context, few developers define superglobals in wp-config.php
123	* as proposed in https://make.wordpress.org/cli/handbook/common-issues/#php-notice-undefined-index-on-_server-superglobal
124	* So let's return the unfiltered home url to avoid a bunch of notices.
125	*/
126	if ( defined( 'WP_CLI' ) && WP_CLI ) {
127	return get_option( 'home' );
128	}
129
130	if ( WP_DEBUG ) {
131	// phpcs:ignore WordPress.PHP.DevelopmentFunctions
132	trigger_error( '$_SERVER[\'HTTP_HOST\'] or $_SERVER[\'REQUEST_URI\'] are required but not set.' );
133	}
134
135	return '';
136	}
137
138	/**
139	* Determines whether we should load the block editor plugin or the legacy languages metabox.
140	*
141	* @since 2.6.0
142	*
143	* return bool True to use the block editor plugin.
144	*/
145	function pll_use_block_editor_plugin() {
146	/**
147	* Filters whether we should load the block editor plugin or the legacy languages metabox.
148	*
149	* @since 2.6.0
150	*
151	* @param bool $use_plugin True when loading the block editor plugin.
152	*/
153	return class_exists( 'PLL_Block_Editor_Plugin' ) && apply_filters( 'pll_use_block_editor_plugin', ! defined( 'PLL_USE_BLOCK_EDITOR_PLUGIN' ) \|\| PLL_USE_BLOCK_EDITOR_PLUGIN );
154	}
155