source: codepress-admin-columns/trunk/api.php @ 2293580

<?php

use AC\Admin;
use AC\EncodedListScreenDataFactory;
use AC\Helper;
use AC\ListScreen;
use AC\ListScreenCollection;
use AC\Type\ListScreenId;

/**
 * @return AC\AdminColumns
 * @since 3.0
 */
function AC() {
        return AC\AdminColumns::instance();
}

/**
 * We check the defined const because it is available before AC::__construct() runs.
 * @return bool
 */
function ac_is_pro_active() {
        return defined( 'ACP_FILE' );
}

/**
 * Get the url where the Admin Columns website is hosted
 *
 * @param string $path
 *
 * @return string
 */
function ac_get_site_url( $path = '' ) {
        $url = 'https://www.admincolumns.com';

        if ( ! empty( $path ) ) {
                $url .= '/' . trim( $path, '/' ) . '/';
        }

        return $url;
}

/**
 * Url with utm tags
 *
 * @param string $path
 * @param string $utm_medium
 * @param string $utm_content
 * @param bool   $utm_campaign
 *
 * @return string
 */
function ac_get_site_utm_url( $path, $utm_medium, $utm_content = null, $utm_campaign = false ) {
        $url = ac_get_site_url( $path );

        if ( ! $utm_campaign ) {
                $utm_campaign = 'plugin-installation';
        }

        $args = [
                // Referrer: plugin
                'utm_source'   => 'plugin-installation',

                // Specific promotions or sales
                'utm_campaign' => $utm_campaign,

                // Marketing medium: banner, documentation or email
                'utm_medium'   => $utm_medium,

                // Used for differentiation of medium
                'utm_content'  => $utm_content,
        ];

        $args = array_map( 'sanitize_key', array_filter( $args ) );

        return add_query_arg( $args, $url );
}

/**
 * @return string
 */
function ac_get_twitter_handle() {
        return 'admincolumns';
}

/**
 * Simple helper methods for AC/Column objects
 * @since 3.0
 */
function ac_helper() {
        return new AC\Helper();
}

/**
 * @param array|string $list_screen_keys
 * @param array        $column_data
 *
 * @deprecated 4.0.0
 * @since      2.2
 */
function ac_register_columns( $list_screen_keys, $column_data ) {
        foreach ( (array) $list_screen_keys as $key ) {
                ac_load_columns( [ $key => $column_data ] );
        }
}

/**
 * Manually set the columns for a list screen
 * This overrides the database settings and thus renders the settings screen for this list screen useless
 * If you like to register a column of your own please have a look at our documentation.
 * We also have a free start-kit available, which contains all the necessary files.
 * Documentation: https://www.admincolumns.com/documentation/guides/creating-new-column-type/
 * Starter-kit: https://.com/codepress/ac-column-template/
 *
 * @param array $data
 *
 * @deprecated 4.1
 * @since      4.0.0
 */
function ac_load_columns( array $data ) {
        $factory = new EncodedListScreenDataFactory();
        $factory->create()->add( $data );
}

/**
 * @param string|null $slug
 *
 * @return string
 */
function ac_get_admin_url( $slug ) {
        return add_query_arg(
                [
                        Admin::QUERY_ARG_PAGE => Admin::NAME,
                        Admin::QUERY_ARG_TAB  => $slug,
                ],
                admin_url( 'options-general.php' )
        );
}

/**
 * @param string|null $slug
 *
 * @return string
 */
function ac_get_admin_network_url( $slug = null ) {
        return add_query_arg(
                [
                        Admin::QUERY_ARG_PAGE => Admin::NAME,
                        Admin::QUERY_ARG_TAB  => $slug,
                ],
                network_admin_url( 'settings.php' )
        );
}

/**
 * Convert site_url() to [cpac_site_url] and back for easy migration
 *
 * @param string $label
 * @param string $action
 *
 * @return string
 */
function ac_convert_site_url( $label, $action = 'encode' ) {
        $input = [ site_url(), '[cpac_site_url]' ];

        if ( 'decode' === $action ) {
                $input = array_reverse( $input );
        }

        return stripslashes( str_replace( $input[0], $input[1], trim( $label ) ) );
}

/**
 * @param string $id Layout ID e.g. ac5de58e04a75b0
 *
 * @return ListScreen|null
 * @since 4.0.0
 */
function ac_get_list_screen( $id ) {
        return AC()->get_storage()->find( new ListScreenId( $id ) );
}

/**
 * @param string $key e.g. post, page, wp-users, wp-media, wp-comments
 *
 * @return ListScreenCollection
 * @since 4.0.0
 */
function ac_get_list_screens( $key ) {
        return AC()->get_storage()->find_all( [ 'key' => $key ] );
}

/**
 * @param                   $format
 * @param null              $timestamp
 * @param DateTimeZone|null $timezone
 *
 * @return false|string
 */
function ac_format_date( $format, $timestamp = null, DateTimeZone $timezone = null ) {
        return ( new Helper\Date() )->format_date( $format, $timestamp, $timezone );
}